Skip to content

AWS.OpenSearchService.Domain

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html

Index

Fields

fn new

new(errorOnEmptyProp)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html

fn creationPolicy

creationPolicy(policy)

Associate the CreationPolicy attribute with a resource to prevent its status from reaching create complete until AWS CloudFormation receives a specified number of success signals or the timeout period is exceeded. To signal a resource, you can use the cfn-signal helper script or SignalResource API. CloudFormation publishes valid signals to the stack events so that you track the number of signals sent. https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-creationpolicy.html

fn creationPolicyMixin

creationPolicyMixin(policy)

cf creationPolicy(), but return a merged object

fn deletionPolicy

deletionPolicy(policy)

With the DeletionPolicy attribute you can preserve, and in some cases, backup a resource when its stack is deleted. You specify a DeletionPolicy attribute for each resource that you want to control. If a resource has no DeletionPolicy attribute, AWS CloudFormation deletes the resource by default. https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html

fn deletionPolicyMixin

deletionPolicyMixin(policy)

cf deletionPolicy(), but return a merged object

fn dependsOn

dependsOn(dependencies)

With the DependsOn attribute you can specify that the creation of a specific resource follows another. When you add a DependsOn attribute to a resource, that resource is created only after the creation of the resource specified in the DependsOn attribute. https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html

fn dependsOnMixin

dependsOnMixin(dependencies)

cf dependsOn(), but return a merged array

fn metadata

metadata(metadatas)

The metadata attribute enables you to associate structured data with a resource. By adding a metadata attribute to a resource, you can add data in JSON or YAML to the resource declaration. In addition, you can use intrinsic functions (such as GetAtt and Ref), parameters, and pseudo parameters within the metadata attribute to add those interpreted values. https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-metadata.html

fn metadataMixin

metadataMixin(metadatas)

cf metadata(), but return a merged object

fn updatePolicy

updatePolicy(policy)

Use the UpdatePolicy attribute to specify how AWS CloudFormation handles updates to the AWS::AppStream::Fleet, AWS::AutoScaling::AutoScalingGroup, AWS::ElastiCache::ReplicationGroup, AWS::OpenSearchService::Domain, AWS::Elasticsearch::Domain, or AWS::Lambda::Alias resources. https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html

fn updatePolicyMixin

updatePolicyMixin(policy)

cf `updatePolicy(), but return a merged object

fn updateReplacePolicy

updateReplacePolicy(policy)

Use the UpdateReplacePolicy attribute to retain or, in some cases, backup the existing physical instance of a resource when it's replaced during a stack update operation. https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html

fn updateReplacePolicyMixin

updateReplacePolicyMixin(policy)

cf updateReplacePolicy, but return a merged object

fn withAccessPolicies

withAccessPolicies(accessPolicies)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-accesspolicies

fn withAccessPoliciesMixin

withAccessPoliciesMixin(accessPolicies)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-accesspolicies

fn withAdvancedOptions

withAdvancedOptions(advancedOptions)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-advancedoptions

fn withAdvancedOptionsMixin

withAdvancedOptionsMixin(advancedOptions)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-advancedoptions

fn withAdvancedSecurityOptions

withAdvancedSecurityOptions(advancedSecurityOptions)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-advancedsecurityoptions

fn withAdvancedSecurityOptionsMixin

withAdvancedSecurityOptionsMixin(advancedSecurityOptions)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-advancedsecurityoptions

fn withClusterConfig

withClusterConfig(clusterConfig)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-clusterconfig

fn withClusterConfigMixin

withClusterConfigMixin(clusterConfig)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-clusterconfig

fn withCognitoOptions

withCognitoOptions(cognitoOptions)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-cognitooptions

fn withCognitoOptionsMixin

withCognitoOptionsMixin(cognitoOptions)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-cognitooptions

fn withDomainEndpointOptions

withDomainEndpointOptions(domainEndpointOptions)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-domainendpointoptions

fn withDomainEndpointOptionsMixin

withDomainEndpointOptionsMixin(domainEndpointOptions)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-domainendpointoptions

fn withDomainName

withDomainName(domainName)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-domainname

fn withEBSOptions

withEBSOptions(ebsoptions)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-ebsoptions

fn withEBSOptionsMixin

withEBSOptionsMixin(ebsoptions)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-ebsoptions

fn withEncryptionAtRestOptions

withEncryptionAtRestOptions(encryptionAtRestOptions)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-encryptionatrestoptions

fn withEncryptionAtRestOptionsMixin

withEncryptionAtRestOptionsMixin(encryptionAtRestOptions)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-encryptionatrestoptions

fn withEngineVersion

withEngineVersion(engineVersion)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-engineversion

fn withLogPublishingOptions

withLogPublishingOptions(logPublishingOptions)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-logpublishingoptions

fn withLogPublishingOptionsMixin

withLogPublishingOptionsMixin(logPublishingOptions)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-logpublishingoptions

fn withNodeToNodeEncryptionOptions

withNodeToNodeEncryptionOptions(nodeToNodeEncryptionOptions)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-nodetonodeencryptionoptions

fn withNodeToNodeEncryptionOptionsMixin

withNodeToNodeEncryptionOptionsMixin(nodeToNodeEncryptionOptions)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-nodetonodeencryptionoptions

fn withSnapshotOptions

withSnapshotOptions(snapshotOptions)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-snapshotoptions

fn withSnapshotOptionsMixin

withSnapshotOptionsMixin(snapshotOptions)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-snapshotoptions

fn withTags

withTags(tags)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-tags

fn withTagsMixin

withTagsMixin(tags)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-tags

fn withVPCOptions

withVPCOptions(vpcoptions)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-vpcoptions

fn withVPCOptionsMixin

withVPCOptionsMixin(vpcoptions)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-vpcoptions