Class CfnDomainPropsMixin.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnDomainPropsMixin>
- Enclosing class:
CfnDomainPropsMixin
CfnDomainPropsMixin.-
Method Summary
Modifier and TypeMethodDescriptionaccessPolicies(Object accessPolicies) An AWS Identity and Access Management ( IAM ) policy document that specifies who can access the OpenSearch Service domain and their permissions.advancedOptions(Map<String, String> advancedOptions) Additional options to specify for the OpenSearch Service domain.advancedOptions(IResolvable advancedOptions) Additional options to specify for the OpenSearch Service domain.advancedSecurityOptions(CfnDomainPropsMixin.AdvancedSecurityOptionsInputProperty advancedSecurityOptions) Specifies options for fine-grained access control.advancedSecurityOptions(IResolvable advancedSecurityOptions) Specifies options for fine-grained access control.build()cognitoOptions(CfnDomainPropsMixin.CognitoOptionsProperty cognitoOptions) Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.cognitoOptions(IResolvable cognitoOptions) Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.static CfnDomainPropsMixin.Buildercreate()static CfnDomainPropsMixin.Buildercreate(CfnPropertyMixinOptions options) domainEndpointOptions(CfnDomainPropsMixin.DomainEndpointOptionsProperty 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.domainEndpointOptions(IResolvable 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.domainName(String domainName) A name for the OpenSearch Service domain.ebsOptions(CfnDomainPropsMixin.EBSOptionsProperty ebsOptions) The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the OpenSearch Service domain.ebsOptions(IResolvable ebsOptions) The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the OpenSearch Service domain.elasticsearchClusterConfig(CfnDomainPropsMixin.ElasticsearchClusterConfigProperty elasticsearchClusterConfig) ElasticsearchClusterConfig is a property of the AWS::Elasticsearch::Domain resource that configures the cluster of an Amazon OpenSearch Service domain.elasticsearchClusterConfig(IResolvable elasticsearchClusterConfig) ElasticsearchClusterConfig is a property of the AWS::Elasticsearch::Domain resource that configures the cluster of an Amazon OpenSearch Service domain.elasticsearchVersion(String elasticsearchVersion) The version of Elasticsearch to use, such as 2.3.encryptionAtRestOptions(CfnDomainPropsMixin.EncryptionAtRestOptionsProperty encryptionAtRestOptions) Whether the domain should encrypt data at rest, and if so, the AWS Key Management Service key to use.encryptionAtRestOptions(IResolvable encryptionAtRestOptions) Whether the domain should encrypt data at rest, and if so, the AWS Key Management Service key to use.logPublishingOptions(Map<String, ? extends Object> 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.logPublishingOptions(IResolvable 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.nodeToNodeEncryptionOptions(CfnDomainPropsMixin.NodeToNodeEncryptionOptionsProperty nodeToNodeEncryptionOptions) Specifies whether node-to-node encryption is enabled.nodeToNodeEncryptionOptions(IResolvable nodeToNodeEncryptionOptions) Specifies whether node-to-node encryption is enabled.snapshotOptions(CfnDomainPropsMixin.SnapshotOptionsProperty snapshotOptions) DEPRECATED .snapshotOptions(IResolvable snapshotOptions) DEPRECATED .An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Service domain.vpcOptions(CfnDomainPropsMixin.VPCOptionsProperty vpcOptions) The virtual private cloud (VPC) configuration for the OpenSearch Service domain.vpcOptions(IResolvable vpcOptions) The virtual private cloud (VPC) configuration for the OpenSearch Service domain.
-
Method Details
-
create
@Stability(Stable) public static CfnDomainPropsMixin.Builder create(CfnPropertyMixinOptions options) - Parameters:
options- Mixin options.- Returns:
- a new instance of
CfnDomainPropsMixin.Builder.
-
create
- Returns:
- a new instance of
CfnDomainPropsMixin.Builder.
-
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.
- Parameters:
accessPolicies- An AWS Identity and Access Management ( IAM ) policy document that specifies who can access the OpenSearch Service domain and their permissions. This parameter is required.- Returns:
this- See Also:
-
advancedOptions
@Stability(Stable) public CfnDomainPropsMixin.Builder advancedOptions(Map<String, String> advancedOptions) Additional options to specify for the OpenSearch Service domain.For more information, see Advanced cluster parameters in the Amazon OpenSearch Service Developer Guide .
- Parameters:
advancedOptions- Additional options to specify for the OpenSearch Service domain. This parameter is required.- Returns:
this- See Also:
-
advancedOptions
Additional options to specify for the OpenSearch Service domain.For more information, see Advanced cluster parameters in the Amazon OpenSearch Service Developer Guide .
- Parameters:
advancedOptions- Additional options to specify for the OpenSearch Service domain. This parameter is required.- Returns:
this- See Also:
-
advancedSecurityOptions
@Stability(Stable) public CfnDomainPropsMixin.Builder advancedSecurityOptions(IResolvable advancedSecurityOptions) Specifies options for fine-grained access control.- Parameters:
advancedSecurityOptions- Specifies options for fine-grained access control. This parameter is required.- Returns:
this- See Also:
-
advancedSecurityOptions
@Stability(Stable) public CfnDomainPropsMixin.Builder advancedSecurityOptions(CfnDomainPropsMixin.AdvancedSecurityOptionsInputProperty advancedSecurityOptions) Specifies options for fine-grained access control.- Parameters:
advancedSecurityOptions- Specifies options for fine-grained access control. This parameter is required.- Returns:
this- See Also:
-
cognitoOptions
Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.- Parameters:
cognitoOptions- Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards. This parameter is required.- Returns:
this- See Also:
-
cognitoOptions
@Stability(Stable) public CfnDomainPropsMixin.Builder cognitoOptions(CfnDomainPropsMixin.CognitoOptionsProperty cognitoOptions) Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.- Parameters:
cognitoOptions- Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards. This parameter is required.- Returns:
this- See Also:
-
domainArn
- Parameters:
domainArn- This parameter is required.- Returns:
this- See Also:
-
domainEndpointOptions
@Stability(Stable) public CfnDomainPropsMixin.Builder domainEndpointOptions(IResolvable 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.- 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. This parameter is required.- Returns:
this- See Also:
-
domainEndpointOptions
@Stability(Stable) public CfnDomainPropsMixin.Builder domainEndpointOptions(CfnDomainPropsMixin.DomainEndpointOptionsProperty 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.- 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. This parameter is required.- Returns:
this- See Also:
-
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.
- Parameters:
domainName- A name for the OpenSearch Service domain. This parameter is required.- Returns:
this- See Also:
-
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 .
- Parameters:
ebsOptions- The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the OpenSearch Service domain. This parameter is required.- Returns:
this- See Also:
-
ebsOptions
@Stability(Stable) public CfnDomainPropsMixin.Builder ebsOptions(CfnDomainPropsMixin.EBSOptionsProperty 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 .
- Parameters:
ebsOptions- The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the OpenSearch Service domain. This parameter is required.- Returns:
this- See Also:
-
elasticsearchClusterConfig
@Stability(Stable) public CfnDomainPropsMixin.Builder elasticsearchClusterConfig(IResolvable elasticsearchClusterConfig) ElasticsearchClusterConfig is a property of the AWS::Elasticsearch::Domain resource that configures the cluster of an Amazon OpenSearch Service domain.- Parameters:
elasticsearchClusterConfig- ElasticsearchClusterConfig is a property of the AWS::Elasticsearch::Domain resource that configures the cluster of an Amazon OpenSearch Service domain. This parameter is required.- Returns:
this- See Also:
-
elasticsearchClusterConfig
@Stability(Stable) public CfnDomainPropsMixin.Builder elasticsearchClusterConfig(CfnDomainPropsMixin.ElasticsearchClusterConfigProperty elasticsearchClusterConfig) ElasticsearchClusterConfig is a property of the AWS::Elasticsearch::Domain resource that configures the cluster of an Amazon OpenSearch Service domain.- Parameters:
elasticsearchClusterConfig- ElasticsearchClusterConfig is a property of the AWS::Elasticsearch::Domain resource that configures the cluster of an Amazon OpenSearch Service domain. This parameter is required.- Returns:
this- See Also:
-
elasticsearchVersion
@Stability(Stable) public CfnDomainPropsMixin.Builder elasticsearchVersion(String 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 updateElasticsearchVersionwithout interruption. WhenEnableVersionUpgradeis set tofalse, or is not specified, updatingElasticsearchVersionresults in replacement .- 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 . This parameter is required.- Returns:
this- See Also:
-
encryptionAtRestOptions
@Stability(Stable) public CfnDomainPropsMixin.Builder encryptionAtRestOptions(IResolvable 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 .
- Parameters:
encryptionAtRestOptions- Whether the domain should encrypt data at rest, and if so, the AWS Key Management Service key to use. This parameter is required.- Returns:
this- See Also:
-
encryptionAtRestOptions
@Stability(Stable) public CfnDomainPropsMixin.Builder encryptionAtRestOptions(CfnDomainPropsMixin.EncryptionAtRestOptionsProperty 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 .
- Parameters:
encryptionAtRestOptions- Whether the domain should encrypt data at rest, and if so, the AWS Key Management Service key to use. This parameter is required.- Returns:
this- See Also:
-
logPublishingOptions
@Stability(Stable) public CfnDomainPropsMixin.Builder logPublishingOptions(IResolvable 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
LogPublishingOptionvalue.- 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. This parameter is required.- Returns:
this- See Also:
-
logPublishingOptions
@Stability(Stable) public CfnDomainPropsMixin.Builder logPublishingOptions(Map<String, ? extends Object> 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
LogPublishingOptionvalue.- 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. This parameter is required.- Returns:
this- See Also:
-
nodeToNodeEncryptionOptions
@Stability(Stable) public CfnDomainPropsMixin.Builder nodeToNodeEncryptionOptions(IResolvable nodeToNodeEncryptionOptions) Specifies whether node-to-node encryption is enabled.- Parameters:
nodeToNodeEncryptionOptions- Specifies whether node-to-node encryption is enabled. This parameter is required.- Returns:
this- See Also:
-
nodeToNodeEncryptionOptions
@Stability(Stable) public CfnDomainPropsMixin.Builder nodeToNodeEncryptionOptions(CfnDomainPropsMixin.NodeToNodeEncryptionOptionsProperty nodeToNodeEncryptionOptions) Specifies whether node-to-node encryption is enabled.- Parameters:
nodeToNodeEncryptionOptions- Specifies whether node-to-node encryption is enabled. This parameter is required.- Returns:
this- See Also:
-
snapshotOptions
DEPRECATED .The automated snapshot configuration for the OpenSearch Service domain indices.
- Parameters:
snapshotOptions- DEPRECATED . This parameter is required.- Returns:
this- See Also:
-
snapshotOptions
@Stability(Stable) public CfnDomainPropsMixin.Builder snapshotOptions(CfnDomainPropsMixin.SnapshotOptionsProperty snapshotOptions) DEPRECATED .The automated snapshot configuration for the OpenSearch Service domain indices.
- Parameters:
snapshotOptions- DEPRECATED . This parameter is required.- Returns:
this- See Also:
-
tags
An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Service domain.- Parameters:
tags- An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Service domain. This parameter is required.- Returns:
this- See Also:
-
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 .
- Parameters:
vpcOptions- The virtual private cloud (VPC) configuration for the OpenSearch Service domain. This parameter is required.- Returns:
this- See Also:
-
vpcOptions
@Stability(Stable) public CfnDomainPropsMixin.Builder vpcOptions(CfnDomainPropsMixin.VPCOptionsProperty 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 .
- Parameters:
vpcOptions- The virtual private cloud (VPC) configuration for the OpenSearch Service domain. This parameter is required.- Returns:
this- See Also:
-
build
- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<CfnDomainPropsMixin>- Returns:
- a newly built instance of
CfnDomainPropsMixin.
-