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.OpenSearch.CreateDomain

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates an Amazon OpenSearch Service domain. For more information, see Creating and managing Amazon OpenSearch Service domains.

Synopsis

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

accessPolicies :: Maybe Text
Identity and Access Management (IAM) policy document specifying the access policies for the new domain.
advancedOptions :: Maybe (HashMap Text Text)
Key-value pairs to specify advanced configuration options. The following key-value pairs are supported:
- "rest.action.multi.allow_explicit_index": "true" | "false" - Note the use of a string rather than a boolean. Specifies whether explicit references to indexes are allowed inside the body of HTTP requests. If you want to configure access policies for domain sub-resources, such as specific indexes and domain APIs, you must disable this property. Default is true.
- "indices.fielddata.cache.size": "80" - Note the use of a string rather than a boolean. Specifies the percentage of heap space allocated to field data. Default is unbounded.
- "indices.query.bool.max_clause_count": "1024" - Note the use of a string rather than a boolean. Specifies the maximum number of clauses allowed in a Lucene boolean query. Default is 1,024. Queries with more than the permitted number of clauses result in a TooManyClauses error.
- "override_main_response_version": "true" | "false" - Note the use of a string rather than a boolean. Specifies whether the domain reports its version as 7.10 to allow Elasticsearch OSS clients and plugins to continue working with it. Default is false when creating a domain and true when upgrading a domain.
For more information, see Advanced cluster parameters.
advancedSecurityOptions :: Maybe AdvancedSecurityOptionsInput
Options for fine-grained access control.
autoTuneOptions :: Maybe AutoTuneOptionsInput
Options for Auto-Tune.
clusterConfig :: Maybe ClusterConfig
Container for the cluster configuration of a domain.
cognitoOptions :: Maybe CognitoOptions
Key-value pairs to configure Amazon Cognito authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.
domainEndpointOptions :: Maybe DomainEndpointOptions
Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
eBSOptions :: Maybe EBSOptions
Container for the parameters required to enable EBS-based storage for an OpenSearch Service domain.
encryptionAtRestOptions :: Maybe EncryptionAtRestOptions
Key-value pairs to enable encryption at rest.
engineVersion :: Maybe Text
String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the OpenSearch Service domain. For example, OpenSearch_1.0 or Elasticsearch_7.9. For more information, see Creating and managing Amazon OpenSearch Service domains.
logPublishingOptions :: Maybe (HashMap LogType LogPublishingOption)
Key-value pairs to configure slow log publishing.
nodeToNodeEncryptionOptions :: Maybe NodeToNodeEncryptionOptions
Enables node-to-node encryption.
snapshotOptions :: Maybe SnapshotOptions
DEPRECATED. Container for the parameters required to configure automated snapshots of domain indexes.
tagList :: Maybe [Tag]
List of tags to add to the domain upon creation.
vPCOptions :: Maybe VPCOptions
Container for the values required to configure VPC access domains. If you don't specify these values, OpenSearch Service creates the domain with a public endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.
domainName :: Text
Name of the OpenSearch Service domain to create. Domain names are unique across the domains owned by an account within an Amazon Web Services Region.

Instances

Instances details

ToJSON CreateDomain Source #
Instance details Defined in Amazonka.OpenSearch.CreateDomain Methods toJSON :: CreateDomain -> Value # toEncoding :: CreateDomain -> Encoding # toJSONList :: [CreateDomain] -> Value # toEncodingList :: [CreateDomain] -> Encoding #
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 #
AWSRequest CreateDomain Source #
Instance details Defined in Amazonka.OpenSearch.CreateDomain Associated Types type AWSResponse CreateDomain # Methods request :: (Service -> Service) -> CreateDomain -> Request CreateDomain # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateDomain -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateDomain))) #
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 #
Show CreateDomain Source #
Instance details Defined in Amazonka.OpenSearch.CreateDomain Methods showsPrec :: Int -> CreateDomain -> ShowS # show :: CreateDomain -> String # showList :: [CreateDomain] -> ShowS #
NFData CreateDomain Source #
Instance details Defined in Amazonka.OpenSearch.CreateDomain Methods rnf :: CreateDomain -> () #
Eq CreateDomain Source #
Instance details Defined in Amazonka.OpenSearch.CreateDomain Methods (==) :: CreateDomain -> CreateDomain -> Bool # (/=) :: CreateDomain -> CreateDomain -> Bool #
Hashable CreateDomain Source #
Instance details Defined in Amazonka.OpenSearch.CreateDomain Methods hashWithSalt :: Int -> CreateDomain -> Int # hash :: CreateDomain -> Int #
type AWSResponse CreateDomain Source #
Instance details Defined in Amazonka.OpenSearch.CreateDomain type AWSResponse CreateDomain = CreateDomainResponse
type Rep CreateDomain Source #
Instance details Defined in Amazonka.OpenSearch.CreateDomain type Rep CreateDomain = D1 ('MetaData "CreateDomain" "Amazonka.OpenSearch.CreateDomain" "amazonka-opensearch-2.0-GNoaWlqGXH04P8GBIHM78L" 'False) (C1 ('MetaCons "CreateDomain'" '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 "clusterConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ClusterConfig)) :: 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 "encryptionAtRestOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EncryptionAtRestOptions)) :: S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (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))))))

newCreateDomain Source #

Arguments

:: Text	`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:

CreateDomain, createDomain_accessPolicies - Identity and Access Management (IAM) policy document specifying the access policies for the new domain.

CreateDomain, createDomain_advancedOptions - Key-value pairs to specify advanced configuration options. The following key-value pairs are supported:

"rest.action.multi.allow_explicit_index": "true" | "false" - Note the use of a string rather than a boolean. Specifies whether explicit references to indexes are allowed inside the body of HTTP requests. If you want to configure access policies for domain sub-resources, such as specific indexes and domain APIs, you must disable this property. Default is true.
"indices.fielddata.cache.size": "80" - Note the use of a string rather than a boolean. Specifies the percentage of heap space allocated to field data. Default is unbounded.
"indices.query.bool.max_clause_count": "1024" - Note the use of a string rather than a boolean. Specifies the maximum number of clauses allowed in a Lucene boolean query. Default is 1,024. Queries with more than the permitted number of clauses result in a TooManyClauses error.
"override_main_response_version": "true" | "false" - Note the use of a string rather than a boolean. Specifies whether the domain reports its version as 7.10 to allow Elasticsearch OSS clients and plugins to continue working with it. Default is false when creating a domain and true when upgrading a domain.

For more information, see Advanced cluster parameters.

CreateDomain, createDomain_advancedSecurityOptions - Options for fine-grained access control.

CreateDomain, createDomain_autoTuneOptions - Options for Auto-Tune.

CreateDomain, createDomain_clusterConfig - Container for the cluster configuration of a domain.

CreateDomain, createDomain_cognitoOptions - Key-value pairs to configure Amazon Cognito authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.

CreateDomain, createDomain_domainEndpointOptions - Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.

CreateDomain, createDomain_eBSOptions - Container for the parameters required to enable EBS-based storage for an OpenSearch Service domain.

CreateDomain, createDomain_encryptionAtRestOptions - Key-value pairs to enable encryption at rest.

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

CreateDomain, createDomain_logPublishingOptions - Key-value pairs to configure slow log publishing.

CreateDomain, createDomain_nodeToNodeEncryptionOptions - Enables node-to-node encryption.

CreateDomain, createDomain_snapshotOptions - DEPRECATED. Container for the parameters required to configure automated snapshots of domain indexes.

$sel:tagList:CreateDomain', createDomain_tagList - List of tags to add to the domain upon creation.

CreateDomain, createDomain_vPCOptions - Container for the values required to configure VPC access domains. If you don't specify these values, OpenSearch Service creates the domain with a public endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.

CreateDomain, createDomain_domainName - Name of the OpenSearch Service domain to create. Domain names are unique across the domains owned by an account within an Amazon Web Services Region.

Request Lenses

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

Identity and Access Management (IAM) policy document specifying the access policies for the new domain.

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

Key-value pairs to specify advanced configuration options. The following key-value pairs are supported:

"rest.action.multi.allow_explicit_index": "true" | "false" - Note the use of a string rather than a boolean. Specifies whether explicit references to indexes are allowed inside the body of HTTP requests. If you want to configure access policies for domain sub-resources, such as specific indexes and domain APIs, you must disable this property. Default is true.
"indices.fielddata.cache.size": "80" - Note the use of a string rather than a boolean. Specifies the percentage of heap space allocated to field data. Default is unbounded.
"indices.query.bool.max_clause_count": "1024" - Note the use of a string rather than a boolean. Specifies the maximum number of clauses allowed in a Lucene boolean query. Default is 1,024. Queries with more than the permitted number of clauses result in a TooManyClauses error.
"override_main_response_version": "true" | "false" - Note the use of a string rather than a boolean. Specifies whether the domain reports its version as 7.10 to allow Elasticsearch OSS clients and plugins to continue working with it. Default is false when creating a domain and true when upgrading a domain.

For more information, see Advanced cluster parameters.

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

Options for fine-grained access control.

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

Options for Auto-Tune.

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

Container for the cluster configuration of a domain.

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

Key-value pairs to configure Amazon Cognito authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.

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

Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.

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

Container for the parameters required to enable EBS-based storage for an OpenSearch Service domain.

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

Key-value pairs to enable encryption at rest.

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

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

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

Key-value pairs to configure slow log publishing.

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

Enables node-to-node encryption.

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

DEPRECATED. Container for the parameters required to configure automated snapshots of domain indexes.

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

List of tags to add to the domain upon creation.

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

Container for the values required to configure VPC access domains. If you don't specify these values, OpenSearch Service creates the domain with a public endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.

createDomain_domainName :: Lens' CreateDomain Text Source #

Name of the OpenSearch Service domain to create. Domain names are unique across the domains owned by an account within an Amazon Web Services Region.

Destructuring the Response

data CreateDomainResponse Source #

The result of a CreateDomain operation. Contains the status of the newly created 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

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 #
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 #
NFData CreateDomainResponse Source #
Instance details Defined in Amazonka.OpenSearch.CreateDomain Methods rnf :: CreateDomainResponse -> () #
Eq CreateDomainResponse Source #
Instance details Defined in Amazonka.OpenSearch.CreateDomain Methods (==) :: CreateDomainResponse -> CreateDomainResponse -> Bool # (/=) :: CreateDomainResponse -> CreateDomainResponse -> Bool #
type Rep CreateDomainResponse Source #
Instance details Defined in Amazonka.OpenSearch.CreateDomain type Rep CreateDomainResponse = D1 ('MetaData "CreateDomainResponse" "Amazonka.OpenSearch.CreateDomain" "amazonka-opensearch-2.0-GNoaWlqGXH04P8GBIHM78L" '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.