Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.OpenSearch.CreateDomain

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a new Amazon OpenSearch Service domain. For more information, see Creating and managing Amazon OpenSearch Service domains in the Amazon OpenSearch Service Developer Guide.

Synopsis

data CreateDomain = CreateDomain' {
- eBSOptions :: Maybe EBSOptions
- engineVersion :: Maybe Text
- nodeToNodeEncryptionOptions :: Maybe NodeToNodeEncryptionOptions
- accessPolicies :: Maybe Text
- autoTuneOptions :: Maybe AutoTuneOptionsInput
- logPublishingOptions :: Maybe (HashMap LogType LogPublishingOption)
- clusterConfig :: Maybe ClusterConfig
- advancedSecurityOptions :: Maybe AdvancedSecurityOptionsInput
- tagList :: Maybe [Tag]
- snapshotOptions :: Maybe SnapshotOptions
- cognitoOptions :: Maybe CognitoOptions
- encryptionAtRestOptions :: Maybe EncryptionAtRestOptions
- vPCOptions :: Maybe VPCOptions
- domainEndpointOptions :: Maybe DomainEndpointOptions
- advancedOptions :: Maybe (HashMap Text Text)
- domainName :: Text
}
newCreateDomain :: Text -> CreateDomain
createDomain_eBSOptions :: Lens' CreateDomain (Maybe EBSOptions)
createDomain_engineVersion :: Lens' CreateDomain (Maybe Text)
createDomain_nodeToNodeEncryptionOptions :: Lens' CreateDomain (Maybe NodeToNodeEncryptionOptions)
createDomain_accessPolicies :: Lens' CreateDomain (Maybe Text)
createDomain_autoTuneOptions :: Lens' CreateDomain (Maybe AutoTuneOptionsInput)
createDomain_logPublishingOptions :: Lens' CreateDomain (Maybe (HashMap LogType LogPublishingOption))
createDomain_clusterConfig :: Lens' CreateDomain (Maybe ClusterConfig)
createDomain_advancedSecurityOptions :: Lens' CreateDomain (Maybe AdvancedSecurityOptionsInput)
createDomain_tagList :: Lens' CreateDomain (Maybe [Tag])
createDomain_snapshotOptions :: Lens' CreateDomain (Maybe SnapshotOptions)
createDomain_cognitoOptions :: Lens' CreateDomain (Maybe CognitoOptions)
createDomain_encryptionAtRestOptions :: Lens' CreateDomain (Maybe EncryptionAtRestOptions)
createDomain_vPCOptions :: Lens' CreateDomain (Maybe VPCOptions)
createDomain_domainEndpointOptions :: Lens' CreateDomain (Maybe DomainEndpointOptions)
createDomain_advancedOptions :: Lens' CreateDomain (Maybe (HashMap Text Text))
createDomain_domainName :: Lens' CreateDomain Text
data CreateDomainResponse = CreateDomainResponse' {
- domainStatus :: Maybe DomainStatus
- httpStatus :: Int
}
newCreateDomainResponse :: Int -> CreateDomainResponse
createDomainResponse_domainStatus :: Lens' CreateDomainResponse (Maybe DomainStatus)
createDomainResponse_httpStatus :: Lens' CreateDomainResponse Int

Creating a Request

data CreateDomain Source #

See: newCreateDomain smart constructor.

Constructors

CreateDomain'

Fields

eBSOptions :: Maybe EBSOptions
Options to enable, disable, and specify the type and size of EBS storage volumes.
engineVersion :: Maybe Text
String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the Amazon OpenSearch Service domain. For example, "OpenSearch_1.0" or "Elasticsearch_7.9". For more information, see Creating and managing Amazon OpenSearch Service domains .
nodeToNodeEncryptionOptions :: Maybe NodeToNodeEncryptionOptions
Node-to-node encryption options.
accessPolicies :: Maybe Text
IAM access policy as a JSON-formatted string.
autoTuneOptions :: Maybe AutoTuneOptionsInput
Specifies Auto-Tune options.
logPublishingOptions :: Maybe (HashMap LogType LogPublishingOption)
Map of LogType and LogPublishingOption, each containing options to publish a given type of OpenSearch log.
clusterConfig :: Maybe ClusterConfig
Configuration options for a domain. Specifies the instance type and number of instances in the domain.
advancedSecurityOptions :: Maybe AdvancedSecurityOptionsInput
Specifies advanced security options.
tagList :: Maybe [Tag]
A list of Tag added during domain creation.
snapshotOptions :: Maybe SnapshotOptions
Option to set time, in UTC format, of the daily automated snapshot. Default value is 0 hours.
cognitoOptions :: Maybe CognitoOptions
Options to specify the Cognito user and identity pools for OpenSearch Dashboards authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.
encryptionAtRestOptions :: Maybe EncryptionAtRestOptions
Options for encryption of data at rest.
vPCOptions :: Maybe VPCOptions
Options to specify the subnets and security groups for a VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC .
domainEndpointOptions :: Maybe DomainEndpointOptions
Options to specify configurations that will be applied to the domain endpoint.
advancedOptions :: Maybe (HashMap Text Text)
Option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true. See Advanced cluster parameters for more information.
domainName :: Text
The name of the Amazon OpenSearch Service domain you're creating. Domain names are unique across the domains owned by an account within an AWS region. Domain names must start with a lowercase letter and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

Instances

Instances details

Eq CreateDomain Source #
Instance details Defined in Amazonka.OpenSearch.CreateDomain Methods (==) :: CreateDomain -> CreateDomain -> Bool # (/=) :: CreateDomain -> CreateDomain -> Bool #
Show CreateDomain Source #
Instance details Defined in Amazonka.OpenSearch.CreateDomain Methods showsPrec :: Int -> CreateDomain -> ShowS # show :: CreateDomain -> String # showList :: [CreateDomain] -> ShowS #
Generic CreateDomain Source #
Instance details Defined in Amazonka.OpenSearch.CreateDomain Associated Types type Rep CreateDomain :: Type -> Type # Methods from :: CreateDomain -> Rep CreateDomain x # to :: Rep CreateDomain x -> CreateDomain #
NFData CreateDomain Source #
Instance details Defined in Amazonka.OpenSearch.CreateDomain Methods rnf :: CreateDomain -> () #
Hashable CreateDomain Source #
Instance details Defined in Amazonka.OpenSearch.CreateDomain Methods hashWithSalt :: Int -> CreateDomain -> Int # hash :: CreateDomain -> Int #
ToJSON CreateDomain Source #
Instance details Defined in Amazonka.OpenSearch.CreateDomain Methods toJSON :: CreateDomain -> Value # toEncoding :: CreateDomain -> Encoding # toJSONList :: [CreateDomain] -> Value # toEncodingList :: [CreateDomain] -> Encoding #
AWSRequest CreateDomain Source #
Instance details Defined in Amazonka.OpenSearch.CreateDomain Associated Types type AWSResponse CreateDomain # Methods request :: CreateDomain -> Request CreateDomain # response :: MonadResource m => Logger -> Service -> Proxy CreateDomain -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateDomain))) #
ToHeaders CreateDomain Source #
Instance details Defined in Amazonka.OpenSearch.CreateDomain Methods toHeaders :: CreateDomain -> [Header] #
ToPath CreateDomain Source #
Instance details Defined in Amazonka.OpenSearch.CreateDomain Methods toPath :: CreateDomain -> ByteString #
ToQuery CreateDomain Source #
Instance details Defined in Amazonka.OpenSearch.CreateDomain Methods toQuery :: CreateDomain -> QueryString #
type Rep CreateDomain Source #
Instance details Defined in Amazonka.OpenSearch.CreateDomain type Rep CreateDomain = D1 ('MetaData "CreateDomain" "Amazonka.OpenSearch.CreateDomain" "libZSservicesZSamazonka-opensearchZSamazonka-opensearch" 'False) (C1 ('MetaCons "CreateDomain'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "eBSOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EBSOptions)) :: S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "nodeToNodeEncryptionOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NodeToNodeEncryptionOptions)) :: S1 ('MetaSel ('Just "accessPolicies") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "autoTuneOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AutoTuneOptionsInput)) :: S1 ('MetaSel ('Just "logPublishingOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap LogType LogPublishingOption)))) :: (S1 ('MetaSel ('Just "clusterConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ClusterConfig)) :: S1 ('MetaSel ('Just "advancedSecurityOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AdvancedSecurityOptionsInput))))) :: (((S1 ('MetaSel ('Just "tagList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :: S1 ('MetaSel ('Just "snapshotOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SnapshotOptions))) :: (S1 ('MetaSel ('Just "cognitoOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CognitoOptions)) :: S1 ('MetaSel ('Just "encryptionAtRestOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EncryptionAtRestOptions)))) :: ((S1 ('MetaSel ('Just "vPCOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VPCOptions)) :: S1 ('MetaSel ('Just "domainEndpointOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DomainEndpointOptions))) :: (S1 ('MetaSel ('Just "advancedOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))
type AWSResponse CreateDomain Source #
Instance details Defined in Amazonka.OpenSearch.CreateDomain type AWSResponse CreateDomain = CreateDomainResponse

newCreateDomain Source #

Arguments

:: Text	`$sel:domainName:CreateDomain'`
-> CreateDomain

Create a value of CreateDomain with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:eBSOptions:CreateDomain', createDomain_eBSOptions - Options to enable, disable, and specify the type and size of EBS storage volumes.

$sel:engineVersion:CreateDomain', createDomain_engineVersion - String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the Amazon OpenSearch Service domain. For example, "OpenSearch_1.0" or "Elasticsearch_7.9". For more information, see Creating and managing Amazon OpenSearch Service domains .

$sel:nodeToNodeEncryptionOptions:CreateDomain', createDomain_nodeToNodeEncryptionOptions - Node-to-node encryption options.

$sel:accessPolicies:CreateDomain', createDomain_accessPolicies - IAM access policy as a JSON-formatted string.

$sel:autoTuneOptions:CreateDomain', createDomain_autoTuneOptions - Specifies Auto-Tune options.

$sel:logPublishingOptions:CreateDomain', createDomain_logPublishingOptions - Map of LogType and LogPublishingOption, each containing options to publish a given type of OpenSearch log.

$sel:clusterConfig:CreateDomain', createDomain_clusterConfig - Configuration options for a domain. Specifies the instance type and number of instances in the domain.

$sel:advancedSecurityOptions:CreateDomain', createDomain_advancedSecurityOptions - Specifies advanced security options.

$sel:tagList:CreateDomain', createDomain_tagList - A list of Tag added during domain creation.

$sel:snapshotOptions:CreateDomain', createDomain_snapshotOptions - Option to set time, in UTC format, of the daily automated snapshot. Default value is 0 hours.

$sel:cognitoOptions:CreateDomain', createDomain_cognitoOptions - Options to specify the Cognito user and identity pools for OpenSearch Dashboards authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.

$sel:encryptionAtRestOptions:CreateDomain', createDomain_encryptionAtRestOptions - Options for encryption of data at rest.

$sel:vPCOptions:CreateDomain', createDomain_vPCOptions - Options to specify the subnets and security groups for a VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC .

$sel:domainEndpointOptions:CreateDomain', createDomain_domainEndpointOptions - Options to specify configurations that will be applied to the domain endpoint.

$sel:advancedOptions:CreateDomain', createDomain_advancedOptions - Option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true. See Advanced cluster parameters for more information.

$sel:domainName:CreateDomain', createDomain_domainName - The name of the Amazon OpenSearch Service domain you're creating. Domain names are unique across the domains owned by an account within an AWS region. Domain names must start with a lowercase letter and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

Request Lenses

createDomain_eBSOptions :: Lens' CreateDomain (Maybe EBSOptions) Source #

Options to enable, disable, and specify the type and size of EBS storage volumes.

createDomain_engineVersion :: Lens' CreateDomain (Maybe Text) Source #

String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the Amazon OpenSearch Service domain. For example, "OpenSearch_1.0" or "Elasticsearch_7.9". For more information, see Creating and managing Amazon OpenSearch Service domains .

createDomain_nodeToNodeEncryptionOptions :: Lens' CreateDomain (Maybe NodeToNodeEncryptionOptions) Source #

Node-to-node encryption options.

createDomain_accessPolicies :: Lens' CreateDomain (Maybe Text) Source #

IAM access policy as a JSON-formatted string.

createDomain_autoTuneOptions :: Lens' CreateDomain (Maybe AutoTuneOptionsInput) Source #

Specifies Auto-Tune options.

createDomain_logPublishingOptions :: Lens' CreateDomain (Maybe (HashMap LogType LogPublishingOption)) Source #

Map of LogType and LogPublishingOption, each containing options to publish a given type of OpenSearch log.

createDomain_clusterConfig :: Lens' CreateDomain (Maybe ClusterConfig) Source #

Configuration options for a domain. Specifies the instance type and number of instances in the domain.

createDomain_advancedSecurityOptions :: Lens' CreateDomain (Maybe AdvancedSecurityOptionsInput) Source #

Specifies advanced security options.

createDomain_tagList :: Lens' CreateDomain (Maybe [Tag]) Source #

A list of Tag added during domain creation.

createDomain_snapshotOptions :: Lens' CreateDomain (Maybe SnapshotOptions) Source #

Option to set time, in UTC format, of the daily automated snapshot. Default value is 0 hours.

createDomain_cognitoOptions :: Lens' CreateDomain (Maybe CognitoOptions) Source #

Options to specify the Cognito user and identity pools for OpenSearch Dashboards authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.

createDomain_encryptionAtRestOptions :: Lens' CreateDomain (Maybe EncryptionAtRestOptions) Source #

Options for encryption of data at rest.

createDomain_vPCOptions :: Lens' CreateDomain (Maybe VPCOptions) Source #

Options to specify the subnets and security groups for a VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC .

createDomain_domainEndpointOptions :: Lens' CreateDomain (Maybe DomainEndpointOptions) Source #

Options to specify configurations that will be applied to the domain endpoint.

createDomain_advancedOptions :: Lens' CreateDomain (Maybe (HashMap Text Text)) Source #

Option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true. See Advanced cluster parameters for more information.

createDomain_domainName :: Lens' CreateDomain Text Source #

The name of the Amazon OpenSearch Service domain you're creating. Domain names are unique across the domains owned by an account within an AWS region. Domain names must start with a lowercase letter and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

Destructuring the Response

data CreateDomainResponse Source #

The result of a CreateDomain operation. Contains the status of the newly created Amazon OpenSearch Service domain.

See: newCreateDomainResponse smart constructor.

Constructors

CreateDomainResponse'
Fields domainStatus :: Maybe DomainStatus The status of the newly created domain. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq CreateDomainResponse Source #
Instance details Defined in Amazonka.OpenSearch.CreateDomain Methods (==) :: CreateDomainResponse -> CreateDomainResponse -> Bool # (/=) :: CreateDomainResponse -> CreateDomainResponse -> Bool #
Read CreateDomainResponse Source #
Instance details Defined in Amazonka.OpenSearch.CreateDomain Methods readsPrec :: Int -> ReadS CreateDomainResponse # readList :: ReadS [CreateDomainResponse] # readPrec :: ReadPrec CreateDomainResponse # readListPrec :: ReadPrec [CreateDomainResponse] #
Show CreateDomainResponse Source #
Instance details Defined in Amazonka.OpenSearch.CreateDomain Methods showsPrec :: Int -> CreateDomainResponse -> ShowS # show :: CreateDomainResponse -> String # showList :: [CreateDomainResponse] -> ShowS #
Generic CreateDomainResponse Source #
Instance details Defined in Amazonka.OpenSearch.CreateDomain Associated Types type Rep CreateDomainResponse :: Type -> Type # Methods from :: CreateDomainResponse -> Rep CreateDomainResponse x # to :: Rep CreateDomainResponse x -> CreateDomainResponse #
NFData CreateDomainResponse Source #
Instance details Defined in Amazonka.OpenSearch.CreateDomain Methods rnf :: CreateDomainResponse -> () #
type Rep CreateDomainResponse Source #
Instance details Defined in Amazonka.OpenSearch.CreateDomain type Rep CreateDomainResponse = D1 ('MetaData "CreateDomainResponse" "Amazonka.OpenSearch.CreateDomain" "libZSservicesZSamazonka-opensearchZSamazonka-opensearch" 'False) (C1 ('MetaCons "CreateDomainResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "domainStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DomainStatus)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateDomainResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateDomainResponse'`
-> CreateDomainResponse

Create a value of CreateDomainResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:domainStatus:CreateDomainResponse', createDomainResponse_domainStatus - The status of the newly created domain.

$sel:httpStatus:CreateDomainResponse', createDomainResponse_httpStatus - The response's http status code.

Response Lenses

createDomainResponse_domainStatus :: Lens' CreateDomainResponse (Maybe DomainStatus) Source #

The status of the newly created domain.

createDomainResponse_httpStatus :: Lens' CreateDomainResponse Int Source #

The response's http status code.