Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.ElasticSearch.CreateElasticsearchDomain

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a new Elasticsearch domain. For more information, see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide.

Synopsis

Creating a Request

data CreateElasticsearchDomain Source #

See: newCreateElasticsearchDomain smart constructor.

Constructors

CreateElasticsearchDomain'

Fields

accessPolicies :: Maybe Text
IAM access policy as a JSON-formatted string.
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 Configuration Advanced Options for more information.
advancedSecurityOptions :: Maybe AdvancedSecurityOptionsInput
Specifies advanced security options.
autoTuneOptions :: Maybe AutoTuneOptionsInput
Specifies Auto-Tune options.
cognitoOptions :: Maybe CognitoOptions
Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see Amazon Cognito Authentication for Kibana.
domainEndpointOptions :: Maybe DomainEndpointOptions
Options to specify configuration that will be applied to the domain endpoint.
eBSOptions :: Maybe EBSOptions
Options to enable, disable and specify the type and size of EBS storage volumes.
elasticsearchClusterConfig :: Maybe ElasticsearchClusterConfig
Configuration options for an Elasticsearch domain. Specifies the instance type and number of instances in the domain cluster.
elasticsearchVersion :: Maybe Text
String of format X.Y to specify version for the Elasticsearch domain eg. "1.5" or "2.3". For more information, see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide.
encryptionAtRestOptions :: Maybe EncryptionAtRestOptions
Specifies the Encryption At Rest Options.
logPublishingOptions :: Maybe (HashMap LogType LogPublishingOption)
Map of LogType and LogPublishingOption, each containing options to publish a given type of Elasticsearch log.
nodeToNodeEncryptionOptions :: Maybe NodeToNodeEncryptionOptions
Specifies the NodeToNodeEncryptionOptions.
snapshotOptions :: Maybe SnapshotOptions
Option to set time, in UTC format, of the daily automated snapshot. Default value is 0 hours.
tagList :: Maybe [Tag]
A list of Tag added during domain creation.
vPCOptions :: Maybe VPCOptions
Options to specify the subnets and security groups for VPC endpoint. For more information, see Creating a VPC in VPC Endpoints for Amazon Elasticsearch Service Domains
domainName :: Text
The name of the Elasticsearch domain that you are 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

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

newCreateElasticsearchDomain Source #

Arguments

:: Text	`CreateElasticsearchDomain`
-> CreateElasticsearchDomain

Create a value of CreateElasticsearchDomain 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:

CreateElasticsearchDomain, createElasticsearchDomain_accessPolicies - IAM access policy as a JSON-formatted string.

CreateElasticsearchDomain, createElasticsearchDomain_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 Configuration Advanced Options for more information.

CreateElasticsearchDomain, createElasticsearchDomain_advancedSecurityOptions - Specifies advanced security options.

CreateElasticsearchDomain, createElasticsearchDomain_autoTuneOptions - Specifies Auto-Tune options.

CreateElasticsearchDomain, createElasticsearchDomain_cognitoOptions - Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see Amazon Cognito Authentication for Kibana.

CreateElasticsearchDomain, createElasticsearchDomain_domainEndpointOptions - Options to specify configuration that will be applied to the domain endpoint.

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

CreateElasticsearchDomain, createElasticsearchDomain_elasticsearchClusterConfig - Configuration options for an Elasticsearch domain. Specifies the instance type and number of instances in the domain cluster.

CreateElasticsearchDomain, createElasticsearchDomain_elasticsearchVersion - String of format X.Y to specify version for the Elasticsearch domain eg. "1.5" or "2.3". For more information, see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide.

CreateElasticsearchDomain, createElasticsearchDomain_encryptionAtRestOptions - Specifies the Encryption At Rest Options.

CreateElasticsearchDomain, createElasticsearchDomain_logPublishingOptions - Map of LogType and LogPublishingOption, each containing options to publish a given type of Elasticsearch log.

CreateElasticsearchDomain, createElasticsearchDomain_nodeToNodeEncryptionOptions - Specifies the NodeToNodeEncryptionOptions.

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

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

CreateElasticsearchDomain, createElasticsearchDomain_vPCOptions - Options to specify the subnets and security groups for VPC endpoint. For more information, see Creating a VPC in VPC Endpoints for Amazon Elasticsearch Service Domains

CreateElasticsearchDomain, createElasticsearchDomain_domainName - The name of the Elasticsearch domain that you are 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

createElasticsearchDomain_accessPolicies :: Lens' CreateElasticsearchDomain (Maybe Text) Source #

IAM access policy as a JSON-formatted string.

createElasticsearchDomain_advancedOptions :: Lens' CreateElasticsearchDomain (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 Configuration Advanced Options for more information.

createElasticsearchDomain_advancedSecurityOptions :: Lens' CreateElasticsearchDomain (Maybe AdvancedSecurityOptionsInput) Source #

Specifies advanced security options.

createElasticsearchDomain_autoTuneOptions :: Lens' CreateElasticsearchDomain (Maybe AutoTuneOptionsInput) Source #

Specifies Auto-Tune options.

createElasticsearchDomain_cognitoOptions :: Lens' CreateElasticsearchDomain (Maybe CognitoOptions) Source #

Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see Amazon Cognito Authentication for Kibana.

createElasticsearchDomain_domainEndpointOptions :: Lens' CreateElasticsearchDomain (Maybe DomainEndpointOptions) Source #

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

createElasticsearchDomain_eBSOptions :: Lens' CreateElasticsearchDomain (Maybe EBSOptions) Source #

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

createElasticsearchDomain_elasticsearchClusterConfig :: Lens' CreateElasticsearchDomain (Maybe ElasticsearchClusterConfig) Source #

Configuration options for an Elasticsearch domain. Specifies the instance type and number of instances in the domain cluster.

createElasticsearchDomain_elasticsearchVersion :: Lens' CreateElasticsearchDomain (Maybe Text) Source #

String of format X.Y to specify version for the Elasticsearch domain eg. "1.5" or "2.3". For more information, see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide.

createElasticsearchDomain_encryptionAtRestOptions :: Lens' CreateElasticsearchDomain (Maybe EncryptionAtRestOptions) Source #

Specifies the Encryption At Rest Options.

createElasticsearchDomain_logPublishingOptions :: Lens' CreateElasticsearchDomain (Maybe (HashMap LogType LogPublishingOption)) Source #

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

createElasticsearchDomain_nodeToNodeEncryptionOptions :: Lens' CreateElasticsearchDomain (Maybe NodeToNodeEncryptionOptions) Source #

Specifies the NodeToNodeEncryptionOptions.

createElasticsearchDomain_snapshotOptions :: Lens' CreateElasticsearchDomain (Maybe SnapshotOptions) Source #

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

createElasticsearchDomain_tagList :: Lens' CreateElasticsearchDomain (Maybe [Tag]) Source #

A list of Tag added during domain creation.

createElasticsearchDomain_vPCOptions :: Lens' CreateElasticsearchDomain (Maybe VPCOptions) Source #

Options to specify the subnets and security groups for VPC endpoint. For more information, see Creating a VPC in VPC Endpoints for Amazon Elasticsearch Service Domains

createElasticsearchDomain_domainName :: Lens' CreateElasticsearchDomain Text Source #

The name of the Elasticsearch domain that you are 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 CreateElasticsearchDomainResponse Source #

The result of a CreateElasticsearchDomain operation. Contains the status of the newly created Elasticsearch domain.

See: newCreateElasticsearchDomainResponse smart constructor.

Constructors

CreateElasticsearchDomainResponse'
Fields domainStatus :: Maybe ElasticsearchDomainStatus The status of the newly created Elasticsearch domain. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newCreateElasticsearchDomainResponse Source #

Arguments

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

Create a value of CreateElasticsearchDomainResponse 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:CreateElasticsearchDomainResponse', createElasticsearchDomainResponse_domainStatus - The status of the newly created Elasticsearch domain.

$sel:httpStatus:CreateElasticsearchDomainResponse', createElasticsearchDomainResponse_httpStatus - The response's http status code.

Response Lenses

createElasticsearchDomainResponse_domainStatus :: Lens' CreateElasticsearchDomainResponse (Maybe ElasticsearchDomainStatus) Source #

The status of the newly created Elasticsearch domain.

createElasticsearchDomainResponse_httpStatus :: Lens' CreateElasticsearchDomainResponse Int Source #

The response's http status code.