Package software.amazon.awscdk.services.elasticsearch

Interface CfnDomainProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnDomainProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:44.468Z") @Stability(Stable) public interface CfnDomainProps extends software.amazon.jsii.JsiiSerializable
Properties for defining a CfnDomain.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.elasticsearch.*;
 Object accessPolicies;
 CfnDomainProps cfnDomainProps = CfnDomainProps.builder()
         .accessPolicies(accessPolicies)
         .advancedOptions(Map.of(
                 "advancedOptionsKey", "advancedOptions"))
         .advancedSecurityOptions(AdvancedSecurityOptionsInputProperty.builder()
                 .anonymousAuthEnabled(false)
                 .enabled(false)
                 .internalUserDatabaseEnabled(false)
                 .masterUserOptions(MasterUserOptionsProperty.builder()
                         .masterUserArn("masterUserArn")
                         .masterUserName("masterUserName")
                         .masterUserPassword("masterUserPassword")
                         .build())
                 .build())
         .cognitoOptions(CognitoOptionsProperty.builder()
                 .enabled(false)
                 .identityPoolId("identityPoolId")
                 .roleArn("roleArn")
                 .userPoolId("userPoolId")
                 .build())
         .domainEndpointOptions(DomainEndpointOptionsProperty.builder()
                 .customEndpoint("customEndpoint")
                 .customEndpointCertificateArn("customEndpointCertificateArn")
                 .customEndpointEnabled(false)
                 .enforceHttps(false)
                 .tlsSecurityPolicy("tlsSecurityPolicy")
                 .build())
         .domainName("domainName")
         .ebsOptions(EBSOptionsProperty.builder()
                 .ebsEnabled(false)
                 .iops(123)
                 .volumeSize(123)
                 .volumeType("volumeType")
                 .build())
         .elasticsearchClusterConfig(ElasticsearchClusterConfigProperty.builder()
                 .coldStorageOptions(ColdStorageOptionsProperty.builder()
                         .enabled(false)
                         .build())
                 .dedicatedMasterCount(123)
                 .dedicatedMasterEnabled(false)
                 .dedicatedMasterType("dedicatedMasterType")
                 .instanceCount(123)
                 .instanceType("instanceType")
                 .warmCount(123)
                 .warmEnabled(false)
                 .warmType("warmType")
                 .zoneAwarenessConfig(ZoneAwarenessConfigProperty.builder()
                         .availabilityZoneCount(123)
                         .build())
                 .zoneAwarenessEnabled(false)
                 .build())
         .elasticsearchVersion("elasticsearchVersion")
         .encryptionAtRestOptions(EncryptionAtRestOptionsProperty.builder()
                 .enabled(false)
                 .kmsKeyId("kmsKeyId")
                 .build())
         .logPublishingOptions(Map.of(
                 "logPublishingOptionsKey", LogPublishingOptionProperty.builder()
                         .cloudWatchLogsLogGroupArn("cloudWatchLogsLogGroupArn")
                         .enabled(false)
                         .build()))
         .nodeToNodeEncryptionOptions(NodeToNodeEncryptionOptionsProperty.builder()
                 .enabled(false)
                 .build())
         .snapshotOptions(SnapshotOptionsProperty.builder()
                 .automatedSnapshotStartHour(123)
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .vpcOptions(VPCOptionsProperty.builder()
                 .securityGroupIds(List.of("securityGroupIds"))
                 .subnetIds(List.of("subnetIds"))
                 .build())
         .build();

  • Method Details

    • getAccessPolicies

      @Stability(Stable) @Nullable default Object getAccessPolicies()
      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.

    • getAdvancedOptions

      @Stability(Stable) @Nullable default Object getAdvancedOptions()
      Additional options to specify for the OpenSearch Service domain.

      For more information, see Advanced cluster parameters in the Amazon OpenSearch Service Developer Guide .

    • getAdvancedSecurityOptions

      @Stability(Stable) @Nullable default Object getAdvancedSecurityOptions()
      Specifies options for fine-grained access control.

    • getCognitoOptions

      @Stability(Stable) @Nullable default Object getCognitoOptions()
      Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.

    • getDomainEndpointOptions

      @Stability(Stable) @Nullable default Object getDomainEndpointOptions()
      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.

    • getDomainName

      @Stability(Stable) @Nullable default String getDomainName()
      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, AWS 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.

    • getEbsOptions

      @Stability(Stable) @Nullable default Object getEbsOptions()
      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 .

    • getElasticsearchClusterConfig

      @Stability(Stable) @Nullable default Object getElasticsearchClusterConfig()
      ElasticsearchClusterConfig is a property of the AWS::Elasticsearch::Domain resource that configures the cluster of an Amazon OpenSearch Service domain.

    • getElasticsearchVersion

      @Stability(Stable) @Nullable default String getElasticsearchVersion()
      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 .

    • getEncryptionAtRestOptions

      @Stability(Stable) @Nullable default Object getEncryptionAtRestOptions()
      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 .

    • getLogPublishingOptions

      @Stability(Stable) @Nullable default Object getLogPublishingOptions()
      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.

    • getNodeToNodeEncryptionOptions

      @Stability(Stable) @Nullable default Object getNodeToNodeEncryptionOptions()
      Specifies whether node-to-node encryption is enabled.

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

    • getSnapshotOptions

      @Stability(Stable) @Nullable default Object getSnapshotOptions()
      DEPRECATED .

      The automated snapshot configuration for the OpenSearch Service domain indices.

    • getTags

      @Stability(Stable) @Nullable default List<CfnTag> getTags()
      An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Service domain.

    • getVpcOptions

      @Stability(Stable) @Nullable default Object getVpcOptions()
      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 .

    • builder

      @Stability(Stable) static CfnDomainProps.Builder builder()
      Returns:
      a CfnDomainProps.Builder of CfnDomainProps