public static final class CfnDomainProps.Builder
extends java.lang.Object
CfnDomainProps
Constructor and Description |
---|
Builder() |
public CfnDomainProps.Builder accessPolicies(java.lang.Object accessPolicies)
CfnDomainProps.getAccessPolicies()
accessPolicies
- An AWS Identity and Access Management ( IAM ) policy document that specifies who can access the OpenSearch Service domain and their permissions.
For more information, see Configuring access policies in the Amazon OpenSearch Service Developer Guide .this
public CfnDomainProps.Builder advancedOptions(IResolvable advancedOptions)
CfnDomainProps.getAdvancedOptions()
advancedOptions
- Additional options to specify for the OpenSearch Service domain.
For more information, see AdvancedOptions in the OpenSearch Service API reference.this
public CfnDomainProps.Builder advancedOptions(java.util.Map<java.lang.String,java.lang.String> advancedOptions)
CfnDomainProps.getAdvancedOptions()
advancedOptions
- Additional options to specify for the OpenSearch Service domain.
For more information, see AdvancedOptions in the OpenSearch Service API reference.this
public CfnDomainProps.Builder advancedSecurityOptions(IResolvable advancedSecurityOptions)
CfnDomainProps.getAdvancedSecurityOptions()
advancedSecurityOptions
- Specifies options for fine-grained access control.
If you specify advanced security options, you must also enable node-to-node encryption ( NodeToNodeEncryptionOptions ) and encryption at rest ( EncryptionAtRestOptions ). You must also enable EnforceHTTPS
within DomainEndpointOptions , which requires HTTPS for all traffic to the domain.this
public CfnDomainProps.Builder advancedSecurityOptions(CfnDomain.AdvancedSecurityOptionsInputProperty advancedSecurityOptions)
CfnDomainProps.getAdvancedSecurityOptions()
advancedSecurityOptions
- Specifies options for fine-grained access control.
If you specify advanced security options, you must also enable node-to-node encryption ( NodeToNodeEncryptionOptions ) and encryption at rest ( EncryptionAtRestOptions ). You must also enable EnforceHTTPS
within DomainEndpointOptions , which requires HTTPS for all traffic to the domain.this
public CfnDomainProps.Builder clusterConfig(IResolvable clusterConfig)
CfnDomainProps.getClusterConfig()
clusterConfig
- Container for the cluster configuration of a domain.this
public CfnDomainProps.Builder clusterConfig(CfnDomain.ClusterConfigProperty clusterConfig)
CfnDomainProps.getClusterConfig()
clusterConfig
- Container for the cluster configuration of a domain.this
public CfnDomainProps.Builder cognitoOptions(IResolvable cognitoOptions)
CfnDomainProps.getCognitoOptions()
cognitoOptions
- Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.this
public CfnDomainProps.Builder cognitoOptions(CfnDomain.CognitoOptionsProperty cognitoOptions)
CfnDomainProps.getCognitoOptions()
cognitoOptions
- Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.this
public CfnDomainProps.Builder domainEndpointOptions(IResolvable domainEndpointOptions)
CfnDomainProps.getDomainEndpointOptions()
domainEndpointOptions
- Specifies additional options for the domain endpoint, such as whether to require HTTPS for all traffic or whether to use a custom endpoint rather than the default endpoint.this
public CfnDomainProps.Builder domainEndpointOptions(CfnDomain.DomainEndpointOptionsProperty domainEndpointOptions)
CfnDomainProps.getDomainEndpointOptions()
domainEndpointOptions
- Specifies additional options for the domain endpoint, such as whether to require HTTPS for all traffic or whether to use a custom endpoint rather than the default endpoint.this
public CfnDomainProps.Builder domainName(java.lang.String domainName)
CfnDomainProps.getDomainName()
domainName
- A name for the OpenSearch Service domain.
The name must have a minimum length of 3 and a maximum length of 28. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the domain name. For more information, see Name Type .
Required when creating a new domain.
If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
this
public CfnDomainProps.Builder ebsOptions(IResolvable ebsOptions)
CfnDomainProps.getEbsOptions()
ebsOptions
- The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the OpenSearch Service domain.
For more information, see EBS volume size limits in the Amazon OpenSearch Service Developer Guide .this
public CfnDomainProps.Builder ebsOptions(CfnDomain.EBSOptionsProperty ebsOptions)
CfnDomainProps.getEbsOptions()
ebsOptions
- The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the OpenSearch Service domain.
For more information, see EBS volume size limits in the Amazon OpenSearch Service Developer Guide .this
public CfnDomainProps.Builder encryptionAtRestOptions(IResolvable encryptionAtRestOptions)
CfnDomainProps.getEncryptionAtRestOptions()
encryptionAtRestOptions
- Whether the domain should encrypt data at rest, and if so, the AWS KMS key to use.
See Encryption of data at rest for Amazon OpenSearch Service .this
public CfnDomainProps.Builder encryptionAtRestOptions(CfnDomain.EncryptionAtRestOptionsProperty encryptionAtRestOptions)
CfnDomainProps.getEncryptionAtRestOptions()
encryptionAtRestOptions
- Whether the domain should encrypt data at rest, and if so, the AWS KMS key to use.
See Encryption of data at rest for Amazon OpenSearch Service .this
public CfnDomainProps.Builder engineVersion(java.lang.String engineVersion)
CfnDomainProps.getEngineVersion()
engineVersion
- The version of OpenSearch to use.
The value must be in the format OpenSearch_X.Y
or Elasticsearch_X.Y
. If not specified, the latest version of OpenSearch is used. For information about the versions that OpenSearch Service supports, see Supported versions of OpenSearch and Elasticsearch in the Amazon OpenSearch Service Developer Guide .
If you set the EnableVersionUpgrade update policy to true
, you can update EngineVersion
without interruption. When EnableVersionUpgrade
is set to false
, or is not specified, updating EngineVersion
results in replacement .
this
public CfnDomainProps.Builder logPublishingOptions(IResolvable logPublishingOptions)
CfnDomainProps.getLogPublishingOptions()
logPublishingOptions
- An object with one or more of the following keys: `SEARCH_SLOW_LOGS` , `ES_APPLICATION_LOGS` , `INDEX_SLOW_LOGS` , `AUDIT_LOGS` , depending on the types of logs you want to publish.
Each key needs a valid LogPublishingOption
value. For the full syntax, see the examples .this
public CfnDomainProps.Builder logPublishingOptions(java.util.Map<java.lang.String,? extends java.lang.Object> logPublishingOptions)
CfnDomainProps.getLogPublishingOptions()
logPublishingOptions
- An object with one or more of the following keys: `SEARCH_SLOW_LOGS` , `ES_APPLICATION_LOGS` , `INDEX_SLOW_LOGS` , `AUDIT_LOGS` , depending on the types of logs you want to publish.
Each key needs a valid LogPublishingOption
value. For the full syntax, see the examples .this
public CfnDomainProps.Builder nodeToNodeEncryptionOptions(IResolvable nodeToNodeEncryptionOptions)
CfnDomainProps.getNodeToNodeEncryptionOptions()
nodeToNodeEncryptionOptions
- Specifies whether node-to-node encryption is enabled.
See Node-to-node encryption for Amazon OpenSearch Service .this
public CfnDomainProps.Builder nodeToNodeEncryptionOptions(CfnDomain.NodeToNodeEncryptionOptionsProperty nodeToNodeEncryptionOptions)
CfnDomainProps.getNodeToNodeEncryptionOptions()
nodeToNodeEncryptionOptions
- Specifies whether node-to-node encryption is enabled.
See Node-to-node encryption for Amazon OpenSearch Service .this
public CfnDomainProps.Builder snapshotOptions(IResolvable snapshotOptions)
CfnDomainProps.getSnapshotOptions()
snapshotOptions
- *DEPRECATED* .
The automated snapshot configuration for the OpenSearch Service domain indexes.this
public CfnDomainProps.Builder snapshotOptions(CfnDomain.SnapshotOptionsProperty snapshotOptions)
CfnDomainProps.getSnapshotOptions()
snapshotOptions
- *DEPRECATED* .
The automated snapshot configuration for the OpenSearch Service domain indexes.this
public CfnDomainProps.Builder tags(java.util.List<? extends CfnTag> tags)
CfnDomainProps.getTags()
tags
- An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Service domain.this
public CfnDomainProps.Builder vpcOptions(IResolvable vpcOptions)
CfnDomainProps.getVpcOptions()
vpcOptions
- The virtual private cloud (VPC) configuration for the OpenSearch Service domain.
For more information, see Launching your Amazon OpenSearch Service domains within a VPC in the Amazon OpenSearch Service Developer Guide .
If you remove this entity altogether, along with its associated properties, it causes a replacement. You might encounter this scenario if you're updating your security configuration from a VPC to a public endpoint.
this
public CfnDomainProps.Builder vpcOptions(CfnDomain.VPCOptionsProperty vpcOptions)
CfnDomainProps.getVpcOptions()
vpcOptions
- The virtual private cloud (VPC) configuration for the OpenSearch Service domain.
For more information, see Launching your Amazon OpenSearch Service domains within a VPC in the Amazon OpenSearch Service Developer Guide .
If you remove this entity altogether, along with its associated properties, it causes a replacement. You might encounter this scenario if you're updating your security configuration from a VPC to a public endpoint.
this
public CfnDomainProps build()
CfnDomainProps
java.lang.NullPointerException
- if any required attribute was not provided