class CfnDomainPropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.OpenSearchService.Mixins.CfnDomainPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsopensearchservice/mixins#CfnDomainPropsMixin
Java	software.amazon.awscdk.mixins.preview.services.opensearchservice.mixins.CfnDomainPropsMixin
Python	aws_cdk.mixins_preview.aws_opensearchservice.mixins.CfnDomainPropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_opensearchservice » mixins » CfnDomainPropsMixin

Implements IMixin

Extends Mixin

The AWS::OpenSearchService::Domain resource creates an Amazon OpenSearch Service domain.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as opensearchservice_mixins } from '@aws-cdk/mixins-preview/aws-opensearchservice';

declare const accessPolicies: any;
const cfnDomainPropsMixin = new opensearchservice_mixins.CfnDomainPropsMixin({
  accessPolicies: accessPolicies,
  advancedOptions: {
    advancedOptionsKey: 'advancedOptions',
  },
  advancedSecurityOptions: {
    anonymousAuthDisableDate: 'anonymousAuthDisableDate',
    anonymousAuthEnabled: false,
    enabled: false,
    iamFederationOptions: {
      enabled: false,
      rolesKey: 'rolesKey',
      subjectKey: 'subjectKey',
    },
    internalUserDatabaseEnabled: false,
    jwtOptions: {
      enabled: false,
      publicKey: 'publicKey',
      rolesKey: 'rolesKey',
      subjectKey: 'subjectKey',
    },
    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',
    },
  },
  aimlOptions: {
    s3VectorsEngine: {
      enabled: false,
    },
  },
  clusterConfig: {
    coldStorageOptions: {
      enabled: false,
    },
    dedicatedMasterCount: 123,
    dedicatedMasterEnabled: false,
    dedicatedMasterType: 'dedicatedMasterType',
    instanceCount: 123,
    instanceType: 'instanceType',
    multiAzWithStandbyEnabled: false,
    nodeOptions: [{
      nodeConfig: {
        count: 123,
        enabled: false,
        type: 'type',
      },
      nodeType: 'nodeType',
    }],
    warmCount: 123,
    warmEnabled: false,
    warmType: 'warmType',
    zoneAwarenessConfig: {
      availabilityZoneCount: 123,
    },
    zoneAwarenessEnabled: false,
  },
  cognitoOptions: {
    enabled: false,
    identityPoolId: 'identityPoolId',
    roleArn: 'roleArn',
    userPoolId: 'userPoolId',
  },
  domainArn: 'domainArn',
  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',
  identityCenterOptions: {
    enabledApiAccess: false,
    identityCenterApplicationArn: 'identityCenterApplicationArn',
    identityCenterInstanceArn: 'identityCenterInstanceArn',
    identityStoreId: 'identityStoreId',
    rolesKey: 'rolesKey',
    subjectKey: 'subjectKey',
  },
  ipAddressType: 'ipAddressType',
  logPublishingOptions: {
    logPublishingOptionsKey: {
      cloudWatchLogsLogGroupArn: 'cloudWatchLogsLogGroupArn',
      enabled: false,
    },
  },
  nodeToNodeEncryptionOptions: {
    enabled: false,
  },
  offPeakWindowOptions: {
    enabled: false,
    offPeakWindow: {
      windowStartTime: {
        hours: 123,
        minutes: 123,
      },
    },
  },
  skipShardMigrationWait: false,
  snapshotOptions: {
    automatedSnapshotStartHour: 123,
  },
  softwareUpdateOptions: {
    autoSoftwareUpdateEnabled: false,
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
  vpcOptions: {
    securityGroupIds: ['securityGroupIds'],
    subnetIds: ['subnetIds'],
  },
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnDomainPropsMixin(props: CfnDomainMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnDomainMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::OpenSearchService::Domain.

Properties

Name	Type	Description
props	CfnDomainMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnDomainMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.