class CfnDomain (construct)

Language	Type name
.NET	`Amazon.CDK.AWS.OpenSearchService.CfnDomain`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsopensearchservice#CfnDomain`
Java	`software.amazon.awscdk.services.opensearchservice.CfnDomain`
Python	`aws_cdk.aws_opensearchservice.CfnDomain`
TypeScript	`aws-cdk-lib` » `aws_opensearchservice` » `CfnDomain`

Implements IConstruct, IDependable, IInspectable, ITaggable

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

Example

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

declare const accessPolicies: any;
const cfnDomain = new opensearchservice.CfnDomain(this, 'MyCfnDomain', /* all optional props */ {
  accessPolicies: accessPolicies,
  advancedOptions: {
    advancedOptionsKey: 'advancedOptions',
  },
  advancedSecurityOptions: {
    anonymousAuthDisableDate: 'anonymousAuthDisableDate',
    anonymousAuthEnabled: false,
    enabled: false,
    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',
    },
  },
  clusterConfig: {
    coldStorageOptions: {
      enabled: false,
    },
    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',
  },
  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'],
  },
});

Initializer

new CfnDomain(scope: Construct, id: string, props?: CfnDomainProps)

Parameters

scope Construct — Scope in which this resource is defined.
id string — Construct identifier for this resource (unique in its scope).
props CfnDomainProps — Resource properties.

Construct Props

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.
domainArn?	`string`
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.
identityCenterOptions?	`IResolvable` `\|` `IdentityCenterOptionsProperty`	Container for IAM Identity Center Option control for the domain.
ipAddressType?	`string`	Choose either dual stack or IPv4 as your IP address type.
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.
skipShardMigrationWait?	`boolean \|` `IResolvable`
snapshotOptions?	`IResolvable` `\|` `SnapshotOptionsProperty`	DEPRECATED .
softwareUpdateOptions?	`IResolvable` `\|` `SoftwareUpdateOptionsProperty`	Service software update options for the 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.

domainArn?

Type: string (optional)

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 .

If no encryption at rest options were initially specified in the template, updating this property by adding it causes no interruption. However, if you change this property after it's already been set within a template, the domain is deleted and recreated in order to modify the property.

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 .

identityCenterOptions?

Type: IResolvable | IdentityCenterOptionsProperty (optional)

Container for IAM Identity Center Option control for the domain.

ipAddressType?

Type: string (optional)

Choose either dual stack or IPv4 as your IP address type.

Dual stack allows you to share domain resources across IPv4 and IPv6 address types, and is the recommended option. If you set your IP address type to dual stack, you can't change your address type later.

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.

skipShardMigrationWait?

Type: boolean | IResolvable (optional)

snapshotOptions?

Type: IResolvable | SnapshotOptionsProperty (optional)

DEPRECATED .

The automated snapshot configuration for the OpenSearch Service domain indexes.

softwareUpdateOptions?

Type: IResolvable | SoftwareUpdateOptionsProperty (optional)

Service software update options for the 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.

Properties

Name	Type	Description
attrAdvancedSecurityOptionsAnonymousAuthDisableDate	`string`	Date and time when the migration period will be disabled.
attrArn	`string`	The Amazon Resource Name (ARN) of the CloudFormation stack.
attrDomainEndpoint	`string`	The domain-specific endpoint used for requests to the OpenSearch APIs, such as `search-mystack-1ab2cdefghij-ab1c2deckoyb3hofw7wpqa3cm.us-west-1.es.amazonaws.com` .
attrDomainEndpointV2	`string`	If `IPAddressType` to set to `dualstack` , a version 2 domain endpoint is provisioned.
attrDomainEndpoints	`IResolvable`
attrId	`string`	The resource ID.
attrIdentityCenterOptionsIdentityCenterApplicationArn	`string`	The ARN for IAM Identity Center Application which will integrate with Amazon OpenSearch Service.
attrIdentityCenterOptionsIdentityStoreId	`string`	The ID of IAM Identity Store.
attrServiceSoftwareOptions	`IResolvable`
attrServiceSoftwareOptionsAutomatedUpdateDate	`string`
attrServiceSoftwareOptionsCancellable	`IResolvable`
attrServiceSoftwareOptionsCurrentVersion	`string`
attrServiceSoftwareOptionsDescription	`string`
attrServiceSoftwareOptionsNewVersion	`string`
attrServiceSoftwareOptionsOptionalDeployment	`IResolvable`
attrServiceSoftwareOptionsUpdateAvailable	`IResolvable`
attrServiceSoftwareOptionsUpdateStatus	`string`
cfnOptions	`ICfnResourceOptions`	Options for this resource, such as condition, update policy etc.
cfnProperties	`{ [string]: any }`
cfnResourceType	`string`	AWS resource type.
creationStack	`string[]`
logicalId	`string`	The logical ID for this CloudFormation stack element.
node	`Node`	The tree node.
ref	`string`	Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
stack	`Stack`	The stack in which this element is defined.
tags	`TagManager`	Tag Manager which manages the tags for this resource.
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.
domainArn?	`string`
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.
identityCenterOptions?	`IResolvable` `\|` `IdentityCenterOptionsProperty`	Container for IAM Identity Center Option control for the domain.
ipAddressType?	`string`	Choose either dual stack or IPv4 as your IP address type.
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.
skipShardMigrationWait?	`boolean \|` `IResolvable`
snapshotOptions?	`IResolvable` `\|` `SnapshotOptionsProperty`	DEPRECATED .
softwareUpdateOptions?	`IResolvable` `\|` `SoftwareUpdateOptionsProperty`	Service software update options for the domain.
tagsRaw?	`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.
static CFN_RESOURCE_TYPE_NAME	`string`	The CloudFormation resource type name for this resource class.

attrAdvancedSecurityOptionsAnonymousAuthDisableDate

Type: string

Date and time when the migration period will be disabled.

Only necessary when enabling fine-grained access control on an existing domain .

attrArn

Type: string

The Amazon Resource Name (ARN) of the CloudFormation stack.

attrDomainEndpoint

Type: string

The domain-specific endpoint used for requests to the OpenSearch APIs, such as search-mystack-1ab2cdefghij-ab1c2deckoyb3hofw7wpqa3cm.us-west-1.es.amazonaws.com .

attrDomainEndpointV2

Type: IResolvable

attrServiceSoftwareOptionsUpdateStatus

Type: string

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

cfnProperties

Type: { [string]: any }

cfnResourceType

Type: string

AWS resource type.

creationStack

Type: string[]

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

node

Type: Node

The tree node.

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

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.

advancedOptions?

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

Additional options to specify for the OpenSearch Service domain.

advancedSecurityOptions?

Type: IResolvable | AdvancedSecurityOptionsInputProperty (optional)

Specifies options for fine-grained access control and SAML authentication.

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.

Type: IResolvable | NodeToNodeEncryptionOptionsProperty (optional)

Specifies whether node-to-node encryption is enabled.

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.

skipShardMigrationWait?

Type: boolean | IResolvable (optional)

snapshotOptions?

Type: IResolvable | SnapshotOptionsProperty (optional)

DEPRECATED .

softwareUpdateOptions?

Type: IResolvable | SoftwareUpdateOptionsProperty (optional)

Service software update options for the domain.

tagsRaw?

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.

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for `addOverride(path, undefined)`.
addDependency(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addDependsOn(target)⚠️	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName, typeHint?)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
obtainDependencies()	Retrieves an array of resources this resource depends on.
obtainResourceDependencies()	Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)	Indicates that this resource no longer depends on another resource.
replaceDependency(target, newTarget)	Replaces one dependency with another.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

addDependency(target)

public addDependency(target: CfnResource): void

Parameters

target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

addDependsOn(target)⚠️

public addDependsOn(target: CfnResource): void

⚠️ Deprecated: use addDependency

Parameters

target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

key string
value any

Add a value to the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

path string — - The path of the property, you can use dot notation to override values in complex types.
value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

propertyPath string — The path of the property.
value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

policy RemovalPolicy
options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

getAtt(attributeName, typeHint?)

public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference

Parameters

attributeName string — The name of the attribute.
typeHint ResolutionTypeHint

Returns

Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

getMetadata(key)

public getMetadata(key: string): any

Parameters

key string

Returns

any

Retrieve a value value from the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

inspector TreeInspector — tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

obtainDependencies()

public obtainDependencies(): Stack &#124; CfnResource[]

Returns

Stack | CfnResource[]

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

obtainResourceDependencies()

public obtainResourceDependencies(): CfnResource[]

Returns

CfnResource[]

Get a shallow copy of dependencies between this resource and other resources in the same stack.

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

removeDependency(target)

public removeDependency(target: CfnResource): void

Parameters

target CfnResource

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

replaceDependency(target, newTarget)

public replaceDependency(target: CfnResource, newTarget: CfnResource): void

Parameters

target CfnResource — The dependency to replace.
newTarget CfnResource — The new dependency to add.

Replaces one dependency with another.

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

props { [string]: any }

Returns

{ [string]: any }