Interface CfnDomainProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnDomainProps.Jsii$Proxy
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() .anonymousAuthDisableDate("anonymousAuthDisableDate") .anonymousAuthEnabled(false) .enabled(false) .internalUserDatabaseEnabled(false) .masterUserOptions(MasterUserOptionsProperty.builder() .masterUserArn("masterUserArn") .masterUserName("masterUserName") .masterUserPassword("masterUserPassword") .build()) .samlOptions(SAMLOptionsProperty.builder() .enabled(false) .idp(IdpProperty.builder() .entityId("entityId") .metadataContent("metadataContent") .build()) .masterBackendRole("masterBackendRole") .masterUserName("masterUserName") .rolesKey("rolesKey") .sessionTimeoutMinutes(123) .subjectKey("subjectKey") .build()) .build()) .clusterConfig(ClusterConfigProperty.builder() .dedicatedMasterCount(123) .dedicatedMasterEnabled(false) .dedicatedMasterType("dedicatedMasterType") .instanceCount(123) .instanceType("instanceType") .multiAzWithStandbyEnabled(false) .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()) .offPeakWindowOptions(OffPeakWindowOptionsProperty.builder() .enabled(false) .offPeakWindow(OffPeakWindowProperty.builder() .windowStartTime(WindowStartTimeProperty.builder() .hours(123) .minutes(123) .build()) .build()) .build()) .snapshotOptions(SnapshotOptionsProperty.builder() .automatedSnapshotStartHour(123) .build()) .softwareUpdateOptions(SoftwareUpdateOptionsProperty.builder() .autoSoftwareUpdateEnabled(false) .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 ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnDomainProps
static final class
An implementation forCfnDomainProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnDomainProps.Builder
builder()
default Object
An AWS Identity and Access Management ( IAM ) policy document that specifies who can access the OpenSearch Service domain and their permissions.default Object
Additional options to specify for the OpenSearch Service domain.default Object
Specifies options for fine-grained access control and SAML authentication.default Object
Container for the cluster configuration of a domain.default Object
Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.default Object
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
A name for the OpenSearch Service domain.default Object
The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the OpenSearch Service domain.default Object
Whether the domain should encrypt data at rest, and if so, the AWS KMS key to use.default String
The version of OpenSearch to use.default Object
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
Specifies whether node-to-node encryption is enabled.default Object
Options for a domain's off-peak window, during which OpenSearch Service can perform mandatory configuration changes on the domain.default Object
DEPRECATED .default Object
Options for configuring service software updates for a domain.getTags()
An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Service domain.default Object
The virtual private cloud (VPC) configuration for the OpenSearch Service domain.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
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
Additional options to specify for the OpenSearch Service domain.For more information, see AdvancedOptions in the OpenSearch Service API reference.
-
getAdvancedSecurityOptions
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. -
getClusterConfig
Container for the cluster configuration of a domain. -
getCognitoOptions
Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards. -
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
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.
-
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
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
The version of OpenSearch to use.The value must be in the format
OpenSearch_X.Y
orElasticsearch_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 updateEngineVersion
without interruption. WhenEnableVersionUpgrade
is set tofalse
, or is not specified, updatingEngineVersion
results in replacement . -
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
Specifies whether node-to-node encryption is enabled. -
getOffPeakWindowOptions
Options for a domain's off-peak window, during which OpenSearch Service can perform mandatory configuration changes on the domain. -
getSnapshotOptions
DEPRECATED .The automated snapshot configuration for the OpenSearch Service domain indexes.
-
getSoftwareUpdateOptions
Options for configuring service software updates for a domain. -
getTags
An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Service domain. -
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 .
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.
-
builder
- Returns:
- a
CfnDomainProps.Builder
ofCfnDomainProps
-