software.amazon.awscdk.services.opensearchservice

Interface CfnDomainProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDomainProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.102Z")
 @Stability(value=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.opensearchservice.*;
 Object accessPolicies;
 CfnDomainProps cfnDomainProps = CfnDomainProps.builder()
         .accessPolicies(accessPolicies)
         .advancedOptions(Map.of(
                 "advancedOptionsKey", "advancedOptions"))
         .advancedSecurityOptions(AdvancedSecurityOptionsInputProperty.builder()
                 .enabled(false)
                 .internalUserDatabaseEnabled(false)
                 .masterUserOptions(MasterUserOptionsProperty.builder()
                         .masterUserArn("masterUserArn")
                         .masterUserName("masterUserName")
                         .masterUserPassword("masterUserPassword")
                         .build())
                 .build())
         .clusterConfig(ClusterConfigProperty.builder()
                 .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())
         .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)
                 .throughput(123)
                 .volumeSize(123)
                 .volumeType("volumeType")
                 .build())
         .encryptionAtRestOptions(EncryptionAtRestOptionsProperty.builder()
                 .enabled(false)
                 .kmsKeyId("kmsKeyId")
                 .build())
         .engineVersion("engineVersion")
         .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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnDomainProps.Builder A builder for CfnDomainProps
static class	CfnDomainProps.Jsii$Proxy An implementation for CfnDomainProps

Method Summary

Modifier and Type	Method and Description
static CfnDomainProps.Builder	builder()
default Object	getAccessPolicies() An AWS Identity and Access Management ( IAM ) policy document that specifies who can access the OpenSearch Service domain and their permissions.
default Object	getAdvancedOptions() Additional options to specify for the OpenSearch Service domain.
default Object	getAdvancedSecurityOptions() Specifies options for fine-grained access control.
default Object	getClusterConfig() `ClusterConfig` is a property of the AWS::OpenSearchService::Domain resource that configures an Amazon OpenSearch Service cluster.
default Object	getCognitoOptions() Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.
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.
default String	getDomainName() A name for the OpenSearch Service domain.
default Object	getEbsOptions() The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the OpenSearch Service domain.
default Object	getEncryptionAtRestOptions() Whether the domain should encrypt data at rest, and if so, the AWS KMS key to use.
default String	getEngineVersion() The version of OpenSearch to use.
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.
default Object	getNodeToNodeEncryptionOptions() Specifies whether node-to-node encryption is enabled.
default Object	getSnapshotOptions() *DEPRECATED* .
default List<CfnTag>	getTags() An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Service domain.
default Object	getVpcOptions() The virtual private cloud (VPC) configuration for the OpenSearch Service domain.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAccessPolicies

@Stability(value=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 Guide .

getAdvancedOptions

@Stability(value=Stable)
 @Nullable
default Object getAdvancedOptions()

Additional options to specify for the OpenSearch Service domain.

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

getAdvancedSecurityOptions

@Stability(value=Stable)
 @Nullable
default Object getAdvancedSecurityOptions()

Specifies options for fine-grained access control.

getClusterConfig

@Stability(value=Stable)
 @Nullable
default Object getClusterConfig()

`ClusterConfig` is a property of the AWS::OpenSearchService::Domain resource that configures an Amazon OpenSearch Service cluster.

getCognitoOptions

@Stability(value=Stable)
 @Nullable
default Object getCognitoOptions()

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

getDomainEndpointOptions

@Stability(value=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(value=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 .

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.

getEbsOptions

@Stability(value=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 .

getEncryptionAtRestOptions

@Stability(value=Stable)
 @Nullable
default Object getEncryptionAtRestOptions()

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 .

getEngineVersion

@Stability(value=Stable)
 @Nullable
default String getEngineVersion()

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 .

getLogPublishingOptions

@Stability(value=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. For the full syntax, see the examples .

getNodeToNodeEncryptionOptions

@Stability(value=Stable)
 @Nullable
default Object getNodeToNodeEncryptionOptions()

Specifies whether node-to-node encryption is enabled.

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

getSnapshotOptions

@Stability(value=Stable)
 @Nullable
default Object getSnapshotOptions()

*DEPRECATED* .

The automated snapshot configuration for the OpenSearch Service domain indices.

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()

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

getVpcOptions

@Stability(value=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(value=Stable)
static CfnDomainProps.Builder builder()

Returns:

a CfnDomainProps.Builder of CfnDomainProps