Package software.amazon.awscdk.cfnpropertymixins.services.elasticsearch

Class CfnDomainMixinProps.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.elasticsearch.CfnDomainMixinProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDomainMixinProps>

Enclosing interface:

CfnDomainMixinProps

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

A builder for CfnDomainMixinProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnDomainMixinProps.Builder	accessPolicies(Object accessPolicies)	Sets the value of CfnDomainMixinProps.getAccessPolicies()
CfnDomainMixinProps.Builder	advancedOptions(Map<String,String> advancedOptions)	Sets the value of CfnDomainMixinProps.getAdvancedOptions()
CfnDomainMixinProps.Builder	advancedOptions(IResolvable advancedOptions)	Sets the value of CfnDomainMixinProps.getAdvancedOptions()
CfnDomainMixinProps.Builder	advancedSecurityOptions(CfnDomainPropsMixin.AdvancedSecurityOptionsInputProperty advancedSecurityOptions)	Sets the value of CfnDomainMixinProps.getAdvancedSecurityOptions()
CfnDomainMixinProps.Builder	advancedSecurityOptions(IResolvable advancedSecurityOptions)	Sets the value of CfnDomainMixinProps.getAdvancedSecurityOptions()
CfnDomainMixinProps	build()	Builds the configured instance.
CfnDomainMixinProps.Builder	cognitoOptions(CfnDomainPropsMixin.CognitoOptionsProperty cognitoOptions)	Sets the value of CfnDomainMixinProps.getCognitoOptions()
CfnDomainMixinProps.Builder	cognitoOptions(IResolvable cognitoOptions)	Sets the value of CfnDomainMixinProps.getCognitoOptions()
CfnDomainMixinProps.Builder	domainArn(String domainArn)	Sets the value of CfnDomainMixinProps.getDomainArn()
CfnDomainMixinProps.Builder	domainEndpointOptions(CfnDomainPropsMixin.DomainEndpointOptionsProperty domainEndpointOptions)	Sets the value of CfnDomainMixinProps.getDomainEndpointOptions()
CfnDomainMixinProps.Builder	domainEndpointOptions(IResolvable domainEndpointOptions)	Sets the value of CfnDomainMixinProps.getDomainEndpointOptions()
CfnDomainMixinProps.Builder	domainName(String domainName)	Sets the value of CfnDomainMixinProps.getDomainName()
CfnDomainMixinProps.Builder	ebsOptions(CfnDomainPropsMixin.EBSOptionsProperty ebsOptions)	Sets the value of CfnDomainMixinProps.getEbsOptions()
CfnDomainMixinProps.Builder	ebsOptions(IResolvable ebsOptions)	Sets the value of CfnDomainMixinProps.getEbsOptions()
CfnDomainMixinProps.Builder	elasticsearchClusterConfig(CfnDomainPropsMixin.ElasticsearchClusterConfigProperty elasticsearchClusterConfig)	Sets the value of CfnDomainMixinProps.getElasticsearchClusterConfig()
CfnDomainMixinProps.Builder	elasticsearchClusterConfig(IResolvable elasticsearchClusterConfig)	Sets the value of CfnDomainMixinProps.getElasticsearchClusterConfig()
CfnDomainMixinProps.Builder	elasticsearchVersion(String elasticsearchVersion)	Sets the value of CfnDomainMixinProps.getElasticsearchVersion()
CfnDomainMixinProps.Builder	encryptionAtRestOptions(CfnDomainPropsMixin.EncryptionAtRestOptionsProperty encryptionAtRestOptions)	Sets the value of CfnDomainMixinProps.getEncryptionAtRestOptions()
CfnDomainMixinProps.Builder	encryptionAtRestOptions(IResolvable encryptionAtRestOptions)	Sets the value of CfnDomainMixinProps.getEncryptionAtRestOptions()
CfnDomainMixinProps.Builder	logPublishingOptions(Map<String,? extends Object> logPublishingOptions)	Sets the value of CfnDomainMixinProps.getLogPublishingOptions()
CfnDomainMixinProps.Builder	logPublishingOptions(IResolvable logPublishingOptions)	Sets the value of CfnDomainMixinProps.getLogPublishingOptions()
CfnDomainMixinProps.Builder	nodeToNodeEncryptionOptions(CfnDomainPropsMixin.NodeToNodeEncryptionOptionsProperty nodeToNodeEncryptionOptions)	Sets the value of CfnDomainMixinProps.getNodeToNodeEncryptionOptions()
CfnDomainMixinProps.Builder	nodeToNodeEncryptionOptions(IResolvable nodeToNodeEncryptionOptions)	Sets the value of CfnDomainMixinProps.getNodeToNodeEncryptionOptions()
CfnDomainMixinProps.Builder	snapshotOptions(CfnDomainPropsMixin.SnapshotOptionsProperty snapshotOptions)	Sets the value of CfnDomainMixinProps.getSnapshotOptions()
CfnDomainMixinProps.Builder	snapshotOptions(IResolvable snapshotOptions)	Sets the value of CfnDomainMixinProps.getSnapshotOptions()
CfnDomainMixinProps.Builder	tags(List<? extends CfnTag> tags)	Sets the value of CfnDomainMixinProps.getTags()
CfnDomainMixinProps.Builder	vpcOptions(CfnDomainPropsMixin.VPCOptionsProperty vpcOptions)	Sets the value of CfnDomainMixinProps.getVpcOptions()
CfnDomainMixinProps.Builder	vpcOptions(IResolvable vpcOptions)	Sets the value of CfnDomainMixinProps.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 CfnDomainMixinProps.Builder accessPolicies(Object accessPolicies)

Sets the value of CfnDomainMixinProps.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 Guid e.

Returns:

this

advancedOptions

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

Sets the value of CfnDomainMixinProps.getAdvancedOptions()

Parameters:

advancedOptions - Additional options to specify for the OpenSearch Service domain. For more information, see Advanced cluster parameters in the Amazon OpenSearch Service Developer Guide .

Returns:

this

advancedOptions

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

Sets the value of CfnDomainMixinProps.getAdvancedOptions()

Parameters:

advancedOptions - Additional options to specify for the OpenSearch Service domain. For more information, see Advanced cluster parameters in the Amazon OpenSearch Service Developer Guide .

Returns:

this

advancedSecurityOptions

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

Sets the value of CfnDomainMixinProps.getAdvancedSecurityOptions()

Parameters:

advancedSecurityOptions - Specifies options for fine-grained access control.

Returns:

this

advancedSecurityOptions

@Stability(Stable)
public CfnDomainMixinProps.Builder advancedSecurityOptions(CfnDomainPropsMixin.AdvancedSecurityOptionsInputProperty advancedSecurityOptions)

Sets the value of CfnDomainMixinProps.getAdvancedSecurityOptions()

Parameters:

advancedSecurityOptions - Specifies options for fine-grained access control.

Returns:

this

cognitoOptions

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

Sets the value of CfnDomainMixinProps.getCognitoOptions()

Parameters:

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

Returns:

this

cognitoOptions

@Stability(Stable)
public CfnDomainMixinProps.Builder cognitoOptions(CfnDomainPropsMixin.CognitoOptionsProperty cognitoOptions)

Sets the value of CfnDomainMixinProps.getCognitoOptions()

Parameters:

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

Returns:

this

domainArn

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

Sets the value of CfnDomainMixinProps.getDomainArn()

Parameters:

domainArn - the value to be set.

Returns:

this

domainEndpointOptions

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

Sets the value of CfnDomainMixinProps.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 CfnDomainMixinProps.Builder domainEndpointOptions(CfnDomainPropsMixin.DomainEndpointOptionsProperty domainEndpointOptions)

Sets the value of CfnDomainMixinProps.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 CfnDomainMixinProps.Builder domainName(String domainName)

Sets the value of CfnDomainMixinProps.getDomainName()

Parameters:

domainName - A name for the OpenSearch Service domain. For valid values, see the DomainName data type in the Amazon OpenSearch Service Developer Guide . If you don't specify a name, CloudFormation generates a unique physical ID and uses that ID for the domain name. For more information, see Name Type .

If you specify a name, you cannot 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 CfnDomainMixinProps.Builder ebsOptions(IResolvable ebsOptions)

Sets the value of CfnDomainMixinProps.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 CfnDomainMixinProps.Builder ebsOptions(CfnDomainPropsMixin.EBSOptionsProperty ebsOptions)

Sets the value of CfnDomainMixinProps.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

elasticsearchClusterConfig

@Stability(Stable)
public CfnDomainMixinProps.Builder elasticsearchClusterConfig(IResolvable elasticsearchClusterConfig)

Sets the value of CfnDomainMixinProps.getElasticsearchClusterConfig()

Parameters:

elasticsearchClusterConfig - ElasticsearchClusterConfig is a property of the AWS::Elasticsearch::Domain resource that configures the cluster of an Amazon OpenSearch Service domain.

Returns:

this

elasticsearchClusterConfig

@Stability(Stable)
public CfnDomainMixinProps.Builder elasticsearchClusterConfig(CfnDomainPropsMixin.ElasticsearchClusterConfigProperty elasticsearchClusterConfig)

Sets the value of CfnDomainMixinProps.getElasticsearchClusterConfig()

Parameters:

elasticsearchClusterConfig - ElasticsearchClusterConfig is a property of the AWS::Elasticsearch::Domain resource that configures the cluster of an Amazon OpenSearch Service domain.

Returns:

this

elasticsearchVersion

@Stability(Stable)
public CfnDomainMixinProps.Builder elasticsearchVersion(String elasticsearchVersion)

Sets the value of CfnDomainMixinProps.getElasticsearchVersion()

Parameters:

elasticsearchVersion - The version of Elasticsearch to use, such as 2.3. If not specified, 1.5 is used as the default. 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 ElasticsearchVersion without interruption. When EnableVersionUpgrade is set to false , or is not specified, updating ElasticsearchVersion results in replacement .

Returns:

this

encryptionAtRestOptions

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

Sets the value of CfnDomainMixinProps.getEncryptionAtRestOptions()

Parameters:

encryptionAtRestOptions - Whether the domain should encrypt data at rest, and if so, the AWS Key Management Service key to use. See Encryption of data at rest for Amazon OpenSearch Service .

Returns:

this

encryptionAtRestOptions

@Stability(Stable)
public CfnDomainMixinProps.Builder encryptionAtRestOptions(CfnDomainPropsMixin.EncryptionAtRestOptionsProperty encryptionAtRestOptions)

Sets the value of CfnDomainMixinProps.getEncryptionAtRestOptions()

Parameters:

encryptionAtRestOptions - Whether the domain should encrypt data at rest, and if so, the AWS Key Management Service key to use. See Encryption of data at rest for Amazon OpenSearch Service .

Returns:

this

logPublishingOptions

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

Sets the value of CfnDomainMixinProps.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.

Returns:

this

logPublishingOptions

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

Sets the value of CfnDomainMixinProps.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.

Returns:

this

nodeToNodeEncryptionOptions

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

Sets the value of CfnDomainMixinProps.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 CfnDomainMixinProps.Builder nodeToNodeEncryptionOptions(CfnDomainPropsMixin.NodeToNodeEncryptionOptionsProperty nodeToNodeEncryptionOptions)

Sets the value of CfnDomainMixinProps.getNodeToNodeEncryptionOptions()

Parameters:

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

Returns:

this

snapshotOptions

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

Sets the value of CfnDomainMixinProps.getSnapshotOptions()

Parameters:

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

Returns:

this

snapshotOptions

@Stability(Stable)
public CfnDomainMixinProps.Builder snapshotOptions(CfnDomainPropsMixin.SnapshotOptionsProperty snapshotOptions)

Sets the value of CfnDomainMixinProps.getSnapshotOptions()

Parameters:

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

Returns:

this

tags

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

Sets the value of CfnDomainMixinProps.getTags()

Parameters:

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

Returns:

this

vpcOptions

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

Sets the value of CfnDomainMixinProps.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 .

Returns:

this

vpcOptions

@Stability(Stable)
public CfnDomainMixinProps.Builder vpcOptions(CfnDomainPropsMixin.VPCOptionsProperty vpcOptions)

Sets the value of CfnDomainMixinProps.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 .

Returns:

this

build

@Stability(Stable)
public CfnDomainMixinProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnDomainMixinProps

Throws:

NullPointerException - if any required attribute was not provided