interface CfnDomainProps

Language	Type name
.NET	`Amazon.CDK.AWS.OpenSearchService.CfnDomainProps`
Java	`software.amazon.awscdk.services.opensearchservice.CfnDomainProps`
Python	`aws_cdk.aws_opensearchservice.CfnDomainProps`
TypeScript	`@aws-cdk/aws-opensearchservice` » `CfnDomainProps`

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 * as opensearchservice from '@aws-cdk/aws-opensearchservice';

declare const accessPolicies: any;
const cfnDomainProps: opensearchservice.CfnDomainProps = {
  accessPolicies: accessPolicies,
  advancedOptions: {
    advancedOptionsKey: 'advancedOptions',
  },
  advancedSecurityOptions: {
    anonymousAuthDisableDate: 'anonymousAuthDisableDate',
    anonymousAuthEnabled: false,
    enabled: false,
    internalUserDatabaseEnabled: false,
    masterUserOptions: {
      masterUserArn: 'masterUserArn',
      masterUserName: 'masterUserName',
      masterUserPassword: 'masterUserPassword',
    },
    samlOptions: {
      enabled: false,
      idp: {
        entityId: 'entityId',
        metadataContent: 'metadataContent',
      },
      masterBackendRole: 'masterBackendRole',
      masterUserName: 'masterUserName',
      rolesKey: 'rolesKey',
      sessionTimeoutMinutes: 123,
      subjectKey: 'subjectKey',
    },
  },
  clusterConfig: {
    dedicatedMasterCount: 123,
    dedicatedMasterEnabled: false,
    dedicatedMasterType: 'dedicatedMasterType',
    instanceCount: 123,
    instanceType: 'instanceType',
    multiAzWithStandbyEnabled: false,
    warmCount: 123,
    warmEnabled: false,
    warmType: 'warmType',
    zoneAwarenessConfig: {
      availabilityZoneCount: 123,
    },
    zoneAwarenessEnabled: false,
  },
  cognitoOptions: {
    enabled: false,
    identityPoolId: 'identityPoolId',
    roleArn: 'roleArn',
    userPoolId: 'userPoolId',
  },
  domainEndpointOptions: {
    customEndpoint: 'customEndpoint',
    customEndpointCertificateArn: 'customEndpointCertificateArn',
    customEndpointEnabled: false,
    enforceHttps: false,
    tlsSecurityPolicy: 'tlsSecurityPolicy',
  },
  domainName: 'domainName',
  ebsOptions: {
    ebsEnabled: false,
    iops: 123,
    throughput: 123,
    volumeSize: 123,
    volumeType: 'volumeType',
  },
  encryptionAtRestOptions: {
    enabled: false,
    kmsKeyId: 'kmsKeyId',
  },
  engineVersion: 'engineVersion',
  logPublishingOptions: {
    logPublishingOptionsKey: {
      cloudWatchLogsLogGroupArn: 'cloudWatchLogsLogGroupArn',
      enabled: false,
    },
  },
  nodeToNodeEncryptionOptions: {
    enabled: false,
  },
  offPeakWindowOptions: {
    enabled: false,
    offPeakWindow: {
      windowStartTime: {
        hours: 123,
        minutes: 123,
      },
    },
  },
  snapshotOptions: {
    automatedSnapshotStartHour: 123,
  },
  softwareUpdateOptions: {
    autoSoftwareUpdateEnabled: false,
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
  vpcOptions: {
    securityGroupIds: ['securityGroupIds'],
    subnetIds: ['subnetIds'],
  },
};

Properties

Name	Type	Description
accessPolicies?	`any`	An AWS Identity and Access Management ( IAM ) policy document that specifies who can access the OpenSearch Service domain and their permissions.
advancedOptions?	`IResolvable` `\| { [string]: string }`	Additional options to specify for the OpenSearch Service domain.
advancedSecurityOptions?	`IResolvable` `\|` `AdvancedSecurityOptionsInputProperty`	Specifies options for fine-grained access control and SAML authentication.
clusterConfig?	`IResolvable` `\|` `ClusterConfigProperty`	Container for the cluster configuration of a domain.
cognitoOptions?	`IResolvable` `\|` `CognitoOptionsProperty`	Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.
domainEndpointOptions?	`IResolvable` `\|` `DomainEndpointOptionsProperty`	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`	A name for the OpenSearch Service domain.
ebsOptions?	`IResolvable` `\|` `EBSOptionsProperty`	The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the OpenSearch Service domain.
encryptionAtRestOptions?	`IResolvable` `\|` `EncryptionAtRestOptionsProperty`	Whether the domain should encrypt data at rest, and if so, the AWS KMS key to use.
engineVersion?	`string`	The version of OpenSearch to use.
logPublishingOptions?	`IResolvable` `\| { [string]:` `IResolvable` `\|` `LogPublishingOptionProperty` `}`	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?	`IResolvable` `\|` `NodeToNodeEncryptionOptionsProperty`	Specifies whether node-to-node encryption is enabled.
offPeakWindowOptions?	`IResolvable` `\|` `OffPeakWindowOptionsProperty`	Options for a domain's off-peak window, during which OpenSearch Service can perform mandatory configuration changes on the domain.
snapshotOptions?	`IResolvable` `\|` `SnapshotOptionsProperty`	DEPRECATED .
softwareUpdateOptions?	`IResolvable` `\|` `SoftwareUpdateOptionsProperty`	Options for configuring service software updates for a domain.
tags?	`CfnTag[]`	An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Service domain.
vpcOptions?	`IResolvable` `\|` `VPCOptionsProperty`	The virtual private cloud (VPC) configuration for the OpenSearch Service domain.

accessPolicies?

Type: any (optional)

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 .

advancedOptions?

Type: IResolvable | { [string]: string } (optional)

Additional options to specify for the OpenSearch Service domain.

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

advancedSecurityOptions?

Type: IResolvable | AdvancedSecurityOptionsInputProperty (optional)

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.

clusterConfig?

Type: IResolvable | ClusterConfigProperty (optional)

Container for the cluster configuration of a domain.

cognitoOptions?

Type: IResolvable | CognitoOptionsProperty (optional)

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

domainEndpointOptions?

Type: IResolvable | DomainEndpointOptionsProperty (optional)

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?

Type: string (optional)

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.

ebsOptions?

Type: IResolvable | EBSOptionsProperty (optional)

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 .

encryptionAtRestOptions?

Type: IResolvable | EncryptionAtRestOptionsProperty (optional)

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 .

engineVersion?

Type: string (optional)

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 .

logPublishingOptions?

Type: IResolvable | { [string]: IResolvable | LogPublishingOptionProperty } (optional)

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 .

nodeToNodeEncryptionOptions?

Type: IResolvable | NodeToNodeEncryptionOptionsProperty (optional)

Specifies whether node-to-node encryption is enabled.

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

offPeakWindowOptions?

Type: IResolvable | OffPeakWindowOptionsProperty (optional)

Options for a domain's off-peak window, during which OpenSearch Service can perform mandatory configuration changes on the domain.

snapshotOptions?

Type: IResolvable | SnapshotOptionsProperty (optional)

DEPRECATED .

The automated snapshot configuration for the OpenSearch Service domain indexes.

softwareUpdateOptions?

Type: IResolvable | SoftwareUpdateOptionsProperty (optional)

Options for configuring service software updates for a domain.

tags?

Type: CfnTag[] (optional)

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

vpcOptions?

Type: IResolvable | VPCOptionsProperty (optional)

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.