Package software.amazon.awscdk.services.opensearchservice

Class CfnDomain.Builder

java.lang.Object
software.amazon.awscdk.services.opensearchservice.CfnDomain.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnDomain>
Enclosing class:
CfnDomain
@Stability(Stable) public static final class CfnDomain.Builder extends Object implements software.amazon.jsii.Builder<CfnDomain>
A fluent builder for CfnDomain.

  • Method Details

    • create

      @Stability(Stable) public static CfnDomain.Builder create(Construct scope, String id)
      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      Returns:
      a new instance of CfnDomain.Builder.

    • accessPolicies

      @Stability(Stable) public CfnDomain.Builder accessPolicies(Object 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 .

      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

    • advancedOptions

      @Stability(Stable) public CfnDomain.Builder advancedOptions(IResolvable advancedOptions)
      Additional options to specify for the OpenSearch Service domain.

      For more information, see AdvancedOptions in the OpenSearch Service API reference.

      Parameters:
      advancedOptions - Additional options to specify for the OpenSearch Service domain. This parameter is required.
      Returns:
      this

    • advancedOptions

      @Stability(Stable) public CfnDomain.Builder advancedOptions(Map<String,String> advancedOptions)
      Additional options to specify for the OpenSearch Service domain.

      For more information, see AdvancedOptions in the OpenSearch Service API reference.

      Parameters:
      advancedOptions - Additional options to specify for the OpenSearch Service domain. This parameter is required.
      Returns:
      this

    • advancedSecurityOptions

      @Stability(Stable) public CfnDomain.Builder advancedSecurityOptions(IResolvable 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.

      Parameters:
      advancedSecurityOptions - Specifies options for fine-grained access control and SAML authentication. This parameter is required.
      Returns:
      this

    • advancedSecurityOptions

      @Stability(Stable) public CfnDomain.Builder advancedSecurityOptions(CfnDomain.AdvancedSecurityOptionsInputProperty 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.

      Parameters:
      advancedSecurityOptions - Specifies options for fine-grained access control and SAML authentication. This parameter is required.
      Returns:
      this

    • clusterConfig

      @Stability(Stable) public CfnDomain.Builder clusterConfig(IResolvable clusterConfig)
      Container for the cluster configuration of a domain.

      Parameters:
      clusterConfig - Container for the cluster configuration of a domain. This parameter is required.
      Returns:
      this

    • clusterConfig

      @Stability(Stable) public CfnDomain.Builder clusterConfig(CfnDomain.ClusterConfigProperty clusterConfig)
      Container for the cluster configuration of a domain.

      Parameters:
      clusterConfig - Container for the cluster configuration of a domain. This parameter is required.
      Returns:
      this

    • cognitoOptions

      @Stability(Stable) public CfnDomain.Builder cognitoOptions(IResolvable 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

    • cognitoOptions

      @Stability(Stable) public CfnDomain.Builder cognitoOptions(CfnDomain.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

    • domainEndpointOptions

      @Stability(Stable) public CfnDomain.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

    • domainEndpointOptions

      @Stability(Stable) public CfnDomain.Builder domainEndpointOptions(CfnDomain.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

    • domainName

      @Stability(Stable) public CfnDomain.Builder domainName(String 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.

      Parameters:
      domainName - A name for the OpenSearch Service domain. This parameter is required.
      Returns:
      this

    • ebsOptions

      @Stability(Stable) public CfnDomain.Builder ebsOptions(IResolvable 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

    • ebsOptions

      @Stability(Stable) public CfnDomain.Builder ebsOptions(CfnDomain.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

    • encryptionAtRestOptions

      @Stability(Stable) public CfnDomain.Builder encryptionAtRestOptions(IResolvable 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 .

      Parameters:
      encryptionAtRestOptions - Whether the domain should encrypt data at rest, and if so, the AWS KMS key to use. This parameter is required.
      Returns:
      this

    • encryptionAtRestOptions

      @Stability(Stable) public CfnDomain.Builder encryptionAtRestOptions(CfnDomain.EncryptionAtRestOptionsProperty 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 .

      Parameters:
      encryptionAtRestOptions - Whether the domain should encrypt data at rest, and if so, the AWS KMS key to use. This parameter is required.
      Returns:
      this

    • engineVersion

      @Stability(Stable) public CfnDomain.Builder engineVersion(String 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 .

      Parameters:
      engineVersion - The version of OpenSearch to use. This parameter is required.
      Returns:
      this

    • logPublishingOptions

      @Stability(Stable) public CfnDomain.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 LogPublishingOption value. For the full syntax, see the examples .

      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

    • logPublishingOptions

      @Stability(Stable) public CfnDomain.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 LogPublishingOption value. For the full syntax, see the examples .

      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

    • nodeToNodeEncryptionOptions

      @Stability(Stable) public CfnDomain.Builder nodeToNodeEncryptionOptions(IResolvable nodeToNodeEncryptionOptions)
      Specifies whether node-to-node encryption is enabled.

      See Node-to-node encryption for Amazon OpenSearch Service .

      Parameters:
      nodeToNodeEncryptionOptions - Specifies whether node-to-node encryption is enabled. This parameter is required.
      Returns:
      this

    • nodeToNodeEncryptionOptions

      @Stability(Stable) public CfnDomain.Builder nodeToNodeEncryptionOptions(CfnDomain.NodeToNodeEncryptionOptionsProperty nodeToNodeEncryptionOptions)
      Specifies whether node-to-node encryption is enabled.

      See Node-to-node encryption for Amazon OpenSearch Service .

      Parameters:
      nodeToNodeEncryptionOptions - Specifies whether node-to-node encryption is enabled. This parameter is required.
      Returns:
      this

    • offPeakWindowOptions

      @Stability(Stable) public CfnDomain.Builder offPeakWindowOptions(IResolvable offPeakWindowOptions)
      Options for a domain's off-peak window, during which OpenSearch Service can perform mandatory configuration changes on the domain.

      Parameters:
      offPeakWindowOptions - Options for a domain's off-peak window, during which OpenSearch Service can perform mandatory configuration changes on the domain. This parameter is required.
      Returns:
      this

    • offPeakWindowOptions

      @Stability(Stable) public CfnDomain.Builder offPeakWindowOptions(CfnDomain.OffPeakWindowOptionsProperty offPeakWindowOptions)
      Options for a domain's off-peak window, during which OpenSearch Service can perform mandatory configuration changes on the domain.

      Parameters:
      offPeakWindowOptions - Options for a domain's off-peak window, during which OpenSearch Service can perform mandatory configuration changes on the domain. This parameter is required.
      Returns:
      this

    • snapshotOptions

      @Stability(Stable) public CfnDomain.Builder snapshotOptions(IResolvable snapshotOptions)
      DEPRECATED .

      The automated snapshot configuration for the OpenSearch Service domain indexes.

      Parameters:
      snapshotOptions - DEPRECATED . This parameter is required.
      Returns:
      this

    • snapshotOptions

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

      The automated snapshot configuration for the OpenSearch Service domain indexes.

      Parameters:
      snapshotOptions - DEPRECATED . This parameter is required.
      Returns:
      this

    • softwareUpdateOptions

      @Stability(Stable) public CfnDomain.Builder softwareUpdateOptions(IResolvable softwareUpdateOptions)
      Options for configuring service software updates for a domain.

      Parameters:
      softwareUpdateOptions - Options for configuring service software updates for a domain. This parameter is required.
      Returns:
      this

    • softwareUpdateOptions

      @Stability(Stable) public CfnDomain.Builder softwareUpdateOptions(CfnDomain.SoftwareUpdateOptionsProperty softwareUpdateOptions)
      Options for configuring service software updates for a domain.

      Parameters:
      softwareUpdateOptions - Options for configuring service software updates for a domain. This parameter is required.
      Returns:
      this

    • tags

      @Stability(Stable) public CfnDomain.Builder tags(List<? extends CfnTag> 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

    • vpcOptions

      @Stability(Stable) public CfnDomain.Builder vpcOptions(IResolvable 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.

      Parameters:
      vpcOptions - The virtual private cloud (VPC) configuration for the OpenSearch Service domain. This parameter is required.
      Returns:
      this

    • vpcOptions

      @Stability(Stable) public CfnDomain.Builder vpcOptions(CfnDomain.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 .

      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.

      Parameters:
      vpcOptions - The virtual private cloud (VPC) configuration for the OpenSearch Service domain. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public CfnDomain build()
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnDomain>
      Returns:
      a newly built instance of CfnDomain.