Package software.amazon.awscdk.services.opensearchservice

Class CfnDomainProps.Builder

java.lang.Object

software.amazon.awscdk.services.opensearchservice.CfnDomainProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDomainProps>

Enclosing interface:

CfnDomainProps

@Stability(Stable)
public static final class CfnDomainProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnDomainProps>

A builder for CfnDomainProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnDomainProps.Builder	accessPolicies(Object accessPolicies)	Sets the value of CfnDomainProps.getAccessPolicies()
CfnDomainProps.Builder	advancedOptions(Map<String,String> advancedOptions)	Sets the value of CfnDomainProps.getAdvancedOptions()
CfnDomainProps.Builder	advancedOptions(IResolvable advancedOptions)	Sets the value of CfnDomainProps.getAdvancedOptions()
CfnDomainProps.Builder	advancedSecurityOptions(IResolvable advancedSecurityOptions)	Sets the value of CfnDomainProps.getAdvancedSecurityOptions()
CfnDomainProps.Builder	advancedSecurityOptions(CfnDomain.AdvancedSecurityOptionsInputProperty advancedSecurityOptions)	Sets the value of CfnDomainProps.getAdvancedSecurityOptions()
CfnDomainProps	build()	Builds the configured instance.
CfnDomainProps.Builder	clusterConfig(IResolvable clusterConfig)	Sets the value of CfnDomainProps.getClusterConfig()
CfnDomainProps.Builder	clusterConfig(CfnDomain.ClusterConfigProperty clusterConfig)	Sets the value of CfnDomainProps.getClusterConfig()
CfnDomainProps.Builder	cognitoOptions(IResolvable cognitoOptions)	Sets the value of CfnDomainProps.getCognitoOptions()
CfnDomainProps.Builder	cognitoOptions(CfnDomain.CognitoOptionsProperty cognitoOptions)	Sets the value of CfnDomainProps.getCognitoOptions()
CfnDomainProps.Builder	domainArn(String domainArn)	Sets the value of CfnDomainProps.getDomainArn()
CfnDomainProps.Builder	domainEndpointOptions(IResolvable domainEndpointOptions)	Sets the value of CfnDomainProps.getDomainEndpointOptions()
CfnDomainProps.Builder	domainEndpointOptions(CfnDomain.DomainEndpointOptionsProperty domainEndpointOptions)	Sets the value of CfnDomainProps.getDomainEndpointOptions()
CfnDomainProps.Builder	domainName(String domainName)	Sets the value of CfnDomainProps.getDomainName()
CfnDomainProps.Builder	ebsOptions(IResolvable ebsOptions)	Sets the value of CfnDomainProps.getEbsOptions()
CfnDomainProps.Builder	ebsOptions(CfnDomain.EBSOptionsProperty ebsOptions)	Sets the value of CfnDomainProps.getEbsOptions()
CfnDomainProps.Builder	encryptionAtRestOptions(IResolvable encryptionAtRestOptions)	Sets the value of CfnDomainProps.getEncryptionAtRestOptions()
CfnDomainProps.Builder	encryptionAtRestOptions(CfnDomain.EncryptionAtRestOptionsProperty encryptionAtRestOptions)	Sets the value of CfnDomainProps.getEncryptionAtRestOptions()
CfnDomainProps.Builder	engineVersion(String engineVersion)	Sets the value of CfnDomainProps.getEngineVersion()
CfnDomainProps.Builder	ipAddressType(String ipAddressType)	Sets the value of CfnDomainProps.getIpAddressType()
CfnDomainProps.Builder	logPublishingOptions(Map<String,? extends Object> logPublishingOptions)	Sets the value of CfnDomainProps.getLogPublishingOptions()
CfnDomainProps.Builder	logPublishingOptions(IResolvable logPublishingOptions)	Sets the value of CfnDomainProps.getLogPublishingOptions()
CfnDomainProps.Builder	nodeToNodeEncryptionOptions(IResolvable nodeToNodeEncryptionOptions)	Sets the value of CfnDomainProps.getNodeToNodeEncryptionOptions()
CfnDomainProps.Builder	nodeToNodeEncryptionOptions(CfnDomain.NodeToNodeEncryptionOptionsProperty nodeToNodeEncryptionOptions)	Sets the value of CfnDomainProps.getNodeToNodeEncryptionOptions()
CfnDomainProps.Builder	offPeakWindowOptions(IResolvable offPeakWindowOptions)	Sets the value of CfnDomainProps.getOffPeakWindowOptions()
CfnDomainProps.Builder	offPeakWindowOptions(CfnDomain.OffPeakWindowOptionsProperty offPeakWindowOptions)	Sets the value of CfnDomainProps.getOffPeakWindowOptions()
CfnDomainProps.Builder	snapshotOptions(IResolvable snapshotOptions)	Sets the value of CfnDomainProps.getSnapshotOptions()
CfnDomainProps.Builder	snapshotOptions(CfnDomain.SnapshotOptionsProperty snapshotOptions)	Sets the value of CfnDomainProps.getSnapshotOptions()
CfnDomainProps.Builder	softwareUpdateOptions(IResolvable softwareUpdateOptions)	Sets the value of CfnDomainProps.getSoftwareUpdateOptions()
CfnDomainProps.Builder	softwareUpdateOptions(CfnDomain.SoftwareUpdateOptionsProperty softwareUpdateOptions)	Sets the value of CfnDomainProps.getSoftwareUpdateOptions()
CfnDomainProps.Builder	tags(List<? extends CfnTag> tags)	Sets the value of CfnDomainProps.getTags()
CfnDomainProps.Builder	vpcOptions(IResolvable vpcOptions)	Sets the value of CfnDomainProps.getVpcOptions()
CfnDomainProps.Builder	vpcOptions(CfnDomain.VPCOptionsProperty vpcOptions)	Sets the value of CfnDomainProps.getVpcOptions()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

accessPolicies

@Stability(Stable)
public CfnDomainProps.Builder accessPolicies(Object accessPolicies)

Sets the value of CfnDomainProps.getAccessPolicies()

Parameters:

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 .

Returns:

this

advancedOptions

@Stability(Stable)
public CfnDomainProps.Builder advancedOptions(IResolvable advancedOptions)

Sets the value of CfnDomainProps.getAdvancedOptions()

Parameters:

advancedOptions - Additional options to specify for the OpenSearch Service domain. For more information, see AdvancedOptions in the OpenSearch Service API reference.

Returns:

this

advancedOptions

@Stability(Stable)
public CfnDomainProps.Builder advancedOptions(Map<String,String> advancedOptions)

Sets the value of CfnDomainProps.getAdvancedOptions()

Parameters:

advancedOptions - Additional options to specify for the OpenSearch Service domain. For more information, see AdvancedOptions in the OpenSearch Service API reference.

Returns:

this

advancedSecurityOptions

@Stability(Stable)
public CfnDomainProps.Builder advancedSecurityOptions(IResolvable advancedSecurityOptions)

Sets the value of CfnDomainProps.getAdvancedSecurityOptions()

Parameters:

advancedSecurityOptions - Specifies options for fine-grained access control and SAML authentication. 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.

Returns:

this

advancedSecurityOptions

@Stability(Stable)
public CfnDomainProps.Builder advancedSecurityOptions(CfnDomain.AdvancedSecurityOptionsInputProperty advancedSecurityOptions)

Sets the value of CfnDomainProps.getAdvancedSecurityOptions()

Parameters:

advancedSecurityOptions - Specifies options for fine-grained access control and SAML authentication. 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.

Returns:

this

clusterConfig

@Stability(Stable)
public CfnDomainProps.Builder clusterConfig(IResolvable clusterConfig)

Sets the value of CfnDomainProps.getClusterConfig()

Parameters:

clusterConfig - Container for the cluster configuration of a domain.

Returns:

this

clusterConfig

@Stability(Stable)
public CfnDomainProps.Builder clusterConfig(CfnDomain.ClusterConfigProperty clusterConfig)

Sets the value of CfnDomainProps.getClusterConfig()

Parameters:

clusterConfig - Container for the cluster configuration of a domain.

Returns:

this

cognitoOptions

@Stability(Stable)
public CfnDomainProps.Builder cognitoOptions(IResolvable cognitoOptions)

Sets the value of CfnDomainProps.getCognitoOptions()

Parameters:

cognitoOptions - Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.

Returns:

this

cognitoOptions

@Stability(Stable)
public CfnDomainProps.Builder cognitoOptions(CfnDomain.CognitoOptionsProperty cognitoOptions)

Sets the value of CfnDomainProps.getCognitoOptions()

Parameters:

cognitoOptions - Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.

Returns:

this

domainArn

@Stability(Stable)
public CfnDomainProps.Builder domainArn(String domainArn)

Sets the value of CfnDomainProps.getDomainArn()

Parameters:

domainArn - the value to be set.

Returns:

this

domainEndpointOptions

@Stability(Stable)
public CfnDomainProps.Builder domainEndpointOptions(IResolvable domainEndpointOptions)

Sets the value of CfnDomainProps.getDomainEndpointOptions()

Parameters:

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.

Returns:

this

domainEndpointOptions

@Stability(Stable)
public CfnDomainProps.Builder domainEndpointOptions(CfnDomain.DomainEndpointOptionsProperty domainEndpointOptions)

Sets the value of CfnDomainProps.getDomainEndpointOptions()

Parameters:

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.

Returns:

this

domainName

@Stability(Stable)
public CfnDomainProps.Builder domainName(String domainName)

Sets the value of CfnDomainProps.getDomainName()

Parameters:

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.

Returns:

this

ebsOptions

@Stability(Stable)
public CfnDomainProps.Builder ebsOptions(IResolvable ebsOptions)

Sets the value of CfnDomainProps.getEbsOptions()

Parameters:

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 .

Returns:

this

ebsOptions

@Stability(Stable)
public CfnDomainProps.Builder ebsOptions(CfnDomain.EBSOptionsProperty ebsOptions)

Sets the value of CfnDomainProps.getEbsOptions()

Parameters:

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 .

Returns:

this

encryptionAtRestOptions

@Stability(Stable)
public CfnDomainProps.Builder encryptionAtRestOptions(IResolvable encryptionAtRestOptions)

Sets the value of CfnDomainProps.getEncryptionAtRestOptions()

Parameters:

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 .

If no encryption at rest options were initially specified in the template, updating this property by adding it causes no interruption. However, if you change this property after it's already been set within a template, the domain is deleted and recreated in order to modify the property.

Returns:

this

encryptionAtRestOptions

@Stability(Stable)
public CfnDomainProps.Builder encryptionAtRestOptions(CfnDomain.EncryptionAtRestOptionsProperty encryptionAtRestOptions)

Sets the value of CfnDomainProps.getEncryptionAtRestOptions()

Parameters:

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 .

If no encryption at rest options were initially specified in the template, updating this property by adding it causes no interruption. However, if you change this property after it's already been set within a template, the domain is deleted and recreated in order to modify the property.

Returns:

this

engineVersion

@Stability(Stable)
public CfnDomainProps.Builder engineVersion(String engineVersion)

Sets the value of CfnDomainProps.getEngineVersion()

Parameters:

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 .

Returns:

this

ipAddressType

@Stability(Stable)
public CfnDomainProps.Builder ipAddressType(String ipAddressType)

Sets the value of CfnDomainProps.getIpAddressType()

Parameters:

ipAddressType - Choose either dual stack or IPv4 as your IP address type. Dual stack allows you to share domain resources across IPv4 and IPv6 address types, and is the recommended option. If you set your IP address type to dual stack, you can't change your address type later.

Returns:

this

logPublishingOptions

@Stability(Stable)
public CfnDomainProps.Builder logPublishingOptions(IResolvable logPublishingOptions)

Sets the value of CfnDomainProps.getLogPublishingOptions()

Parameters:

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 .

Returns:

this

logPublishingOptions

@Stability(Stable)
public CfnDomainProps.Builder logPublishingOptions(Map<String,? extends Object> logPublishingOptions)

Sets the value of CfnDomainProps.getLogPublishingOptions()

Parameters:

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 .

Returns:

this

nodeToNodeEncryptionOptions

@Stability(Stable)
public CfnDomainProps.Builder nodeToNodeEncryptionOptions(IResolvable nodeToNodeEncryptionOptions)

Sets the value of CfnDomainProps.getNodeToNodeEncryptionOptions()

Parameters:

nodeToNodeEncryptionOptions - Specifies whether node-to-node encryption is enabled. See Node-to-node encryption for Amazon OpenSearch Service .

Returns:

this

nodeToNodeEncryptionOptions

@Stability(Stable)
public CfnDomainProps.Builder nodeToNodeEncryptionOptions(CfnDomain.NodeToNodeEncryptionOptionsProperty nodeToNodeEncryptionOptions)

Sets the value of CfnDomainProps.getNodeToNodeEncryptionOptions()

Parameters:

nodeToNodeEncryptionOptions - Specifies whether node-to-node encryption is enabled. See Node-to-node encryption for Amazon OpenSearch Service .

Returns:

this

offPeakWindowOptions

@Stability(Stable)
public CfnDomainProps.Builder offPeakWindowOptions(IResolvable offPeakWindowOptions)

Sets the value of CfnDomainProps.getOffPeakWindowOptions()

Parameters:

offPeakWindowOptions - Options for a domain's off-peak window, during which OpenSearch Service can perform mandatory configuration changes on the domain.

Returns:

this

offPeakWindowOptions

@Stability(Stable)
public CfnDomainProps.Builder offPeakWindowOptions(CfnDomain.OffPeakWindowOptionsProperty offPeakWindowOptions)

Sets the value of CfnDomainProps.getOffPeakWindowOptions()

Parameters:

offPeakWindowOptions - Options for a domain's off-peak window, during which OpenSearch Service can perform mandatory configuration changes on the domain.

Returns:

this

snapshotOptions

@Stability(Stable)
public CfnDomainProps.Builder snapshotOptions(IResolvable snapshotOptions)

Sets the value of CfnDomainProps.getSnapshotOptions()

Parameters:

snapshotOptions - DEPRECATED . The automated snapshot configuration for the OpenSearch Service domain indexes.

Returns:

this

snapshotOptions

@Stability(Stable)
public CfnDomainProps.Builder snapshotOptions(CfnDomain.SnapshotOptionsProperty snapshotOptions)

Sets the value of CfnDomainProps.getSnapshotOptions()

Parameters:

snapshotOptions - DEPRECATED . The automated snapshot configuration for the OpenSearch Service domain indexes.

Returns:

this

softwareUpdateOptions

@Stability(Stable)
public CfnDomainProps.Builder softwareUpdateOptions(IResolvable softwareUpdateOptions)

Sets the value of CfnDomainProps.getSoftwareUpdateOptions()

Parameters:

softwareUpdateOptions - Service software update options for the domain.

Returns:

this

softwareUpdateOptions

@Stability(Stable)
public CfnDomainProps.Builder softwareUpdateOptions(CfnDomain.SoftwareUpdateOptionsProperty softwareUpdateOptions)

Sets the value of CfnDomainProps.getSoftwareUpdateOptions()

Parameters:

softwareUpdateOptions - Service software update options for the domain.

Returns:

this

tags

@Stability(Stable)
public CfnDomainProps.Builder tags(List<? extends CfnTag> tags)

Sets the value of CfnDomainProps.getTags()

Parameters:

tags - An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Service domain.

Returns:

this

vpcOptions

@Stability(Stable)
public CfnDomainProps.Builder vpcOptions(IResolvable vpcOptions)

Sets the value of CfnDomainProps.getVpcOptions()

Parameters:

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.

Returns:

this

vpcOptions

@Stability(Stable)
public CfnDomainProps.Builder vpcOptions(CfnDomain.VPCOptionsProperty vpcOptions)

Sets the value of CfnDomainProps.getVpcOptions()

Parameters:

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.

Returns:

this

build

@Stability(Stable)
public CfnDomainProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnDomainProps>

Returns:

a new instance of CfnDomainProps

Throws:

NullPointerException - if any required attribute was not provided