awscdk

package module
v1.145.0-devpreview Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 19, 2022 License: Apache-2.0 Imports: 8 Imported by: 192

README ¶

monocdk Experiment

experimental

An experiment to bundle all of the CDK into a single module.

âš  Please don't use this module unless you are interested in providing feedback about this experience.

Usage

Installation

To try out monocdk replace all references to CDK Construct Libraries (most @aws-cdk/* packages) in your package.json file with a single entrey referring to monocdk.

You also need to add a reference to the constructs library, according to the kind of project you are developing:

  • For libraries, model the dependency under devDependencies and peerDependencies
  • For apps, model the dependency under dependencies only
Use in your code
Classic import

You can use a classic import to get access to each service namespaces:

import { core, aws_s3 as s3 } from 'monocdk';

const app = new core.App();
const stack = new core.Stack(app, 'MonoCDK-Stack');

new s3.Bucket(stack, 'TestBucket');
Barrel import

Alternatively, you can use "barrel" imports:

import { App, Stack } from 'monocdk';
import { Bucket } from 'monocdk/aws-s3';

const app = new App();
const stack = new Stack(app, 'MonoCDK-Stack');

new Bucket(stack, 'TestBucket');

Documentation ¶

Overview ¶

An experiment to bundle the entire CDK into a single module

Index ¶

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func App_IsApp ¶ 

func App_IsApp(obj interface{}) *bool

Checks if an object is an instance of the `App` class.

Returns: `true` if `obj` is an `App`. Experimental.

func App_IsConstruct ¶ 

func App_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func App_IsStage ¶ 

func App_IsStage(x interface{}) *bool

Test whether the given construct is a stage. Experimental.

func Arn_ExtractResourceName ¶ 

func Arn_ExtractResourceName(arn *string, resourceType *string) *string

Extract the full resource name from an ARN.

Necessary for resource names (paths) that may contain the separator, like `arn:aws:iam::111111111111:role/path/to/role/name`.

Only works if we statically know the expected `resourceType` beforehand, since we're going to use that to split the string on ':<resourceType>/' (and take the right-hand side).

We can't extract the 'resourceType' from the ARN at hand, because CloudFormation Expressions only allow literals in the 'separator' argument to `{ Fn::Split }`, and so it can't be `{ Fn::Select: [5, { Fn::Split: [':', ARN] }}`.

Only necessary for ARN formats for which the type-name separator is `/`. Experimental.

func Arn_Format ¶ 

func Arn_Format(components *ArnComponents, stack Stack) *string

Creates an ARN from components.

If `partition`, `region` or `account` are not specified, the stack's partition, region and account will be used.

If any component is the empty string, an empty string will be inserted into the generated ARN at the location that component corresponds to.

The ARN will be formatted as follows: 

arn:{partition}:{service}:{region}:{account}:{resource}{sep}{resource-name}

The required ARN pieces that are omitted will be taken from the stack that the 'scope' is attached to. If all ARN pieces are supplied, the supplied scope can be 'undefined'. Experimental.

func AssetStaging_BUNDLING_INPUT_DIR ¶ 

func AssetStaging_BUNDLING_INPUT_DIR() *string

func AssetStaging_BUNDLING_OUTPUT_DIR ¶ 

func AssetStaging_BUNDLING_OUTPUT_DIR() *string

func AssetStaging_ClearAssetHashCache ¶ 

func AssetStaging_ClearAssetHashCache()

Clears the asset hash cache. Experimental.

func AssetStaging_IsConstruct ¶ 

func AssetStaging_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func Aws_ACCOUNT_ID ¶ 

func Aws_ACCOUNT_ID() *string

func Aws_NOTIFICATION_ARNS ¶ 

func Aws_NOTIFICATION_ARNS() *[]*string

func Aws_NO_VALUE ¶ 

func Aws_NO_VALUE() *string

func Aws_PARTITION ¶ 

func Aws_PARTITION() *string

func Aws_REGION ¶ 

func Aws_REGION() *string

func Aws_STACK_ID ¶ 

func Aws_STACK_ID() *string

func Aws_STACK_NAME ¶ 

func Aws_STACK_NAME() *string

func Aws_URL_SUFFIX ¶ 

func Aws_URL_SUFFIX() *string

func BootstraplessSynthesizer_DEFAULT_BOOTSTRAP_STACK_VERSION_SSM_PARAMETER ¶ 

func BootstraplessSynthesizer_DEFAULT_BOOTSTRAP_STACK_VERSION_SSM_PARAMETER() *string

func BootstraplessSynthesizer_DEFAULT_CLOUDFORMATION_ROLE_ARN ¶ 

func BootstraplessSynthesizer_DEFAULT_CLOUDFORMATION_ROLE_ARN() *string

func BootstraplessSynthesizer_DEFAULT_DEPLOY_ROLE_ARN ¶ 

func BootstraplessSynthesizer_DEFAULT_DEPLOY_ROLE_ARN() *string

func BootstraplessSynthesizer_DEFAULT_DOCKER_ASSET_PREFIX ¶ 

func BootstraplessSynthesizer_DEFAULT_DOCKER_ASSET_PREFIX() *string

func BootstraplessSynthesizer_DEFAULT_FILE_ASSETS_BUCKET_NAME ¶ 

func BootstraplessSynthesizer_DEFAULT_FILE_ASSETS_BUCKET_NAME() *string

func BootstraplessSynthesizer_DEFAULT_FILE_ASSET_KEY_ARN_EXPORT_NAME ¶ 

func BootstraplessSynthesizer_DEFAULT_FILE_ASSET_KEY_ARN_EXPORT_NAME() *string

func BootstraplessSynthesizer_DEFAULT_FILE_ASSET_PREFIX ¶ 

func BootstraplessSynthesizer_DEFAULT_FILE_ASSET_PREFIX() *string

func BootstraplessSynthesizer_DEFAULT_FILE_ASSET_PUBLISHING_ROLE_ARN ¶ 

func BootstraplessSynthesizer_DEFAULT_FILE_ASSET_PUBLISHING_ROLE_ARN() *string

func BootstraplessSynthesizer_DEFAULT_IMAGE_ASSETS_REPOSITORY_NAME ¶ 

func BootstraplessSynthesizer_DEFAULT_IMAGE_ASSETS_REPOSITORY_NAME() *string

func BootstraplessSynthesizer_DEFAULT_IMAGE_ASSET_PUBLISHING_ROLE_ARN ¶ 

func BootstraplessSynthesizer_DEFAULT_IMAGE_ASSET_PUBLISHING_ROLE_ARN() *string

func BootstraplessSynthesizer_DEFAULT_LOOKUP_ROLE_ARN ¶ 

func BootstraplessSynthesizer_DEFAULT_LOOKUP_ROLE_ARN() *string

func BootstraplessSynthesizer_DEFAULT_QUALIFIER ¶ 

func BootstraplessSynthesizer_DEFAULT_QUALIFIER() *string

func CfnCodeDeployBlueGreenHook_IsCfnElement ¶ 

func CfnCodeDeployBlueGreenHook_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnCodeDeployBlueGreenHook_IsConstruct ¶ 

func CfnCodeDeployBlueGreenHook_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnCondition_IsCfnElement ¶ 

func CfnCondition_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnCondition_IsConstruct ¶ 

func CfnCondition_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnCustomResource_CFN_RESOURCE_TYPE_NAME ¶ 

func CfnCustomResource_CFN_RESOURCE_TYPE_NAME() *string

func CfnCustomResource_IsCfnElement ¶ 

func CfnCustomResource_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnCustomResource_IsCfnResource ¶ 

func CfnCustomResource_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnCustomResource_IsConstruct ¶ 

func CfnCustomResource_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnElement_IsCfnElement ¶ 

func CfnElement_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnElement_IsConstruct ¶ 

func CfnElement_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnHookDefaultVersion_CFN_RESOURCE_TYPE_NAME ¶ 

func CfnHookDefaultVersion_CFN_RESOURCE_TYPE_NAME() *string

func CfnHookDefaultVersion_IsCfnElement ¶ 

func CfnHookDefaultVersion_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnHookDefaultVersion_IsCfnResource ¶ 

func CfnHookDefaultVersion_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnHookDefaultVersion_IsConstruct ¶ 

func CfnHookDefaultVersion_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnHookTypeConfig_CFN_RESOURCE_TYPE_NAME ¶ 

func CfnHookTypeConfig_CFN_RESOURCE_TYPE_NAME() *string

func CfnHookTypeConfig_IsCfnElement ¶ 

func CfnHookTypeConfig_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnHookTypeConfig_IsCfnResource ¶ 

func CfnHookTypeConfig_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnHookTypeConfig_IsConstruct ¶ 

func CfnHookTypeConfig_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnHookVersion_CFN_RESOURCE_TYPE_NAME ¶ 

func CfnHookVersion_CFN_RESOURCE_TYPE_NAME() *string

func CfnHookVersion_IsCfnElement ¶ 

func CfnHookVersion_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnHookVersion_IsCfnResource ¶ 

func CfnHookVersion_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnHookVersion_IsConstruct ¶ 

func CfnHookVersion_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnHook_IsCfnElement ¶ 

func CfnHook_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnHook_IsConstruct ¶ 

func CfnHook_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnInclude_IsCfnElement ¶ 

func CfnInclude_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Deprecated: use the CfnInclude class from the cloudformation-include module instead

func CfnInclude_IsConstruct ¶ 

func CfnInclude_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Deprecated: use the CfnInclude class from the cloudformation-include module instead

func CfnJson_IsConstruct ¶ 

func CfnJson_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnMacro_CFN_RESOURCE_TYPE_NAME ¶ 

func CfnMacro_CFN_RESOURCE_TYPE_NAME() *string

func CfnMacro_IsCfnElement ¶ 

func CfnMacro_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnMacro_IsCfnResource ¶ 

func CfnMacro_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnMacro_IsConstruct ¶ 

func CfnMacro_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnMapping_IsCfnElement ¶ 

func CfnMapping_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnMapping_IsConstruct ¶ 

func CfnMapping_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnModuleDefaultVersion_CFN_RESOURCE_TYPE_NAME ¶ 

func CfnModuleDefaultVersion_CFN_RESOURCE_TYPE_NAME() *string

func CfnModuleDefaultVersion_IsCfnElement ¶ 

func CfnModuleDefaultVersion_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnModuleDefaultVersion_IsCfnResource ¶ 

func CfnModuleDefaultVersion_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnModuleDefaultVersion_IsConstruct ¶ 

func CfnModuleDefaultVersion_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnModuleVersion_CFN_RESOURCE_TYPE_NAME ¶ 

func CfnModuleVersion_CFN_RESOURCE_TYPE_NAME() *string

func CfnModuleVersion_IsCfnElement ¶ 

func CfnModuleVersion_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnModuleVersion_IsCfnResource ¶ 

func CfnModuleVersion_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnModuleVersion_IsConstruct ¶ 

func CfnModuleVersion_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnOutput_IsCfnElement ¶ 

func CfnOutput_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnOutput_IsConstruct ¶ 

func CfnOutput_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnParameter_IsCfnElement ¶ 

func CfnParameter_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnParameter_IsConstruct ¶ 

func CfnParameter_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnPublicTypeVersion_CFN_RESOURCE_TYPE_NAME ¶ 

func CfnPublicTypeVersion_CFN_RESOURCE_TYPE_NAME() *string

func CfnPublicTypeVersion_IsCfnElement ¶ 

func CfnPublicTypeVersion_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnPublicTypeVersion_IsCfnResource ¶ 

func CfnPublicTypeVersion_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnPublicTypeVersion_IsConstruct ¶ 

func CfnPublicTypeVersion_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnPublisher_CFN_RESOURCE_TYPE_NAME ¶ 

func CfnPublisher_CFN_RESOURCE_TYPE_NAME() *string

func CfnPublisher_IsCfnElement ¶ 

func CfnPublisher_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnPublisher_IsCfnResource ¶ 

func CfnPublisher_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnPublisher_IsConstruct ¶ 

func CfnPublisher_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnRefElement_IsCfnElement ¶ 

func CfnRefElement_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnRefElement_IsConstruct ¶ 

func CfnRefElement_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnResourceDefaultVersion_CFN_RESOURCE_TYPE_NAME ¶ 

func CfnResourceDefaultVersion_CFN_RESOURCE_TYPE_NAME() *string

func CfnResourceDefaultVersion_IsCfnElement ¶ 

func CfnResourceDefaultVersion_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnResourceDefaultVersion_IsCfnResource ¶ 

func CfnResourceDefaultVersion_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnResourceDefaultVersion_IsConstruct ¶ 

func CfnResourceDefaultVersion_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnResourceVersion_CFN_RESOURCE_TYPE_NAME ¶ 

func CfnResourceVersion_CFN_RESOURCE_TYPE_NAME() *string

func CfnResourceVersion_IsCfnElement ¶ 

func CfnResourceVersion_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnResourceVersion_IsCfnResource ¶ 

func CfnResourceVersion_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnResourceVersion_IsConstruct ¶ 

func CfnResourceVersion_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnResource_IsCfnElement ¶ 

func CfnResource_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnResource_IsCfnResource ¶ 

func CfnResource_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnResource_IsConstruct ¶ 

func CfnResource_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnRule_IsCfnElement ¶ 

func CfnRule_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnRule_IsConstruct ¶ 

func CfnRule_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnStackSet_CFN_RESOURCE_TYPE_NAME ¶ 

func CfnStackSet_CFN_RESOURCE_TYPE_NAME() *string

func CfnStackSet_IsCfnElement ¶ 

func CfnStackSet_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnStackSet_IsCfnResource ¶ 

func CfnStackSet_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnStackSet_IsConstruct ¶ 

func CfnStackSet_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnStack_CFN_RESOURCE_TYPE_NAME ¶ 

func CfnStack_CFN_RESOURCE_TYPE_NAME() *string

func CfnStack_IsCfnElement ¶ 

func CfnStack_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnStack_IsCfnResource ¶ 

func CfnStack_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnStack_IsConstruct ¶ 

func CfnStack_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnTypeActivation_CFN_RESOURCE_TYPE_NAME ¶ 

func CfnTypeActivation_CFN_RESOURCE_TYPE_NAME() *string

func CfnTypeActivation_IsCfnElement ¶ 

func CfnTypeActivation_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnTypeActivation_IsCfnResource ¶ 

func CfnTypeActivation_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnTypeActivation_IsConstruct ¶ 

func CfnTypeActivation_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnWaitConditionHandle_CFN_RESOURCE_TYPE_NAME ¶ 

func CfnWaitConditionHandle_CFN_RESOURCE_TYPE_NAME() *string

func CfnWaitConditionHandle_IsCfnElement ¶ 

func CfnWaitConditionHandle_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnWaitConditionHandle_IsCfnResource ¶ 

func CfnWaitConditionHandle_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnWaitConditionHandle_IsConstruct ¶ 

func CfnWaitConditionHandle_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnWaitCondition_CFN_RESOURCE_TYPE_NAME ¶ 

func CfnWaitCondition_CFN_RESOURCE_TYPE_NAME() *string

func CfnWaitCondition_IsCfnElement ¶ 

func CfnWaitCondition_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnWaitCondition_IsCfnResource ¶ 

func CfnWaitCondition_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnWaitCondition_IsConstruct ¶ 

func CfnWaitCondition_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func ConstructNode_PATH_SEP ¶ 

func ConstructNode_PATH_SEP() *string

func ConstructNode_Prepare ¶ 

func ConstructNode_Prepare(node ConstructNode)

Invokes "prepare" on all constructs (depth-first, post-order) in the tree under `node`. Deprecated: Use `app.synth()` instead

func ConstructNode_Synth ¶ 

func ConstructNode_Synth(node ConstructNode, options *SynthesisOptions) cxapi.CloudAssembly

Synthesizes a CloudAssembly from a construct tree. Deprecated: Use `app.synth()` or `stage.synth()` instead

func ConstructNode_Validate ¶ 

func ConstructNode_Validate(node ConstructNode) *[]*ValidationError

Invokes "validate" on all constructs in the tree (depth-first, pre-order) and returns the list of all errors.

An empty list indicates that there are no errors. Experimental.

func Construct_IsConstruct ¶ 

func Construct_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CustomResourceProvider_GetOrCreate ¶ 

func CustomResourceProvider_GetOrCreate(scope constructs.Construct, uniqueid *string, props *CustomResourceProviderProps) *string

Returns a stack-level singleton ARN (service token) for the custom resource provider.

Returns: the service token of the custom resource provider, which should be used when defining a `CustomResource`. Experimental.

func CustomResourceProvider_IsConstruct ¶ 

func CustomResourceProvider_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CustomResource_IsConstruct ¶ 

func CustomResource_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CustomResource_IsResource ¶ 

func CustomResource_IsResource(construct IConstruct) *bool

Check whether the given construct is a Resource. Experimental.

func DefaultStackSynthesizer_DEFAULT_BOOTSTRAP_STACK_VERSION_SSM_PARAMETER ¶ 

func DefaultStackSynthesizer_DEFAULT_BOOTSTRAP_STACK_VERSION_SSM_PARAMETER() *string

func DefaultStackSynthesizer_DEFAULT_CLOUDFORMATION_ROLE_ARN ¶ 

func DefaultStackSynthesizer_DEFAULT_CLOUDFORMATION_ROLE_ARN() *string

func DefaultStackSynthesizer_DEFAULT_DEPLOY_ROLE_ARN ¶ 

func DefaultStackSynthesizer_DEFAULT_DEPLOY_ROLE_ARN() *string

func DefaultStackSynthesizer_DEFAULT_DOCKER_ASSET_PREFIX ¶ 

func DefaultStackSynthesizer_DEFAULT_DOCKER_ASSET_PREFIX() *string

func DefaultStackSynthesizer_DEFAULT_FILE_ASSETS_BUCKET_NAME ¶ 

func DefaultStackSynthesizer_DEFAULT_FILE_ASSETS_BUCKET_NAME() *string

func DefaultStackSynthesizer_DEFAULT_FILE_ASSET_KEY_ARN_EXPORT_NAME ¶ 

func DefaultStackSynthesizer_DEFAULT_FILE_ASSET_KEY_ARN_EXPORT_NAME() *string

func DefaultStackSynthesizer_DEFAULT_FILE_ASSET_PREFIX ¶ 

func DefaultStackSynthesizer_DEFAULT_FILE_ASSET_PREFIX() *string

func DefaultStackSynthesizer_DEFAULT_FILE_ASSET_PUBLISHING_ROLE_ARN ¶ 

func DefaultStackSynthesizer_DEFAULT_FILE_ASSET_PUBLISHING_ROLE_ARN() *string

func DefaultStackSynthesizer_DEFAULT_IMAGE_ASSETS_REPOSITORY_NAME ¶ 

func DefaultStackSynthesizer_DEFAULT_IMAGE_ASSETS_REPOSITORY_NAME() *string

func DefaultStackSynthesizer_DEFAULT_IMAGE_ASSET_PUBLISHING_ROLE_ARN ¶ 

func DefaultStackSynthesizer_DEFAULT_IMAGE_ASSET_PUBLISHING_ROLE_ARN() *string

func DefaultStackSynthesizer_DEFAULT_LOOKUP_ROLE_ARN ¶ 

func DefaultStackSynthesizer_DEFAULT_LOOKUP_ROLE_ARN() *string

func DefaultStackSynthesizer_DEFAULT_QUALIFIER ¶ 

func DefaultStackSynthesizer_DEFAULT_QUALIFIER() *string

func DependableTrait_Implement ¶ 

func DependableTrait_Implement(instance IDependable, trait DependableTrait)

Register `instance` to have the given DependableTrait.

Should be called in the class constructor. Experimental.

func FileSystem_CopyDirectory ¶ 

func FileSystem_CopyDirectory(srcDir *string, destDir *string, options *CopyOptions, rootDir *string)

Copies an entire directory structure. Experimental.

func FileSystem_Fingerprint ¶ 

func FileSystem_Fingerprint(fileOrDirectory *string, options *FingerprintOptions) *string

Produces fingerprint based on the contents of a single file or an entire directory tree.

The fingerprint will also include: 1. An extra string if defined in `options.extra`. 2. The set of exclude patterns, if defined in `options.exclude` 3. The symlink follow mode value. Experimental.

func FileSystem_IsEmpty ¶ 

func FileSystem_IsEmpty(dir *string) *bool

Checks whether a directory is empty. Experimental.

func FileSystem_Mkdtemp ¶ 

func FileSystem_Mkdtemp(prefix *string) *string

Creates a unique temporary directory in the **system temp directory**. Experimental.

func FileSystem_Tmpdir ¶ 

func FileSystem_Tmpdir() *string

func Fn_Base64 ¶ 

func Fn_Base64(data *string) *string

The intrinsic function “Fn::Base64“ returns the Base64 representation of the input string.

This function is typically used to pass encoded data to Amazon EC2 instances by way of the UserData property.

Returns: a token represented as a string Experimental.

func Fn_Cidr ¶ 

func Fn_Cidr(ipBlock *string, count *float64, sizeMask *string) *[]*string

The intrinsic function “Fn::Cidr“ returns the specified Cidr address block.

Returns: a token represented as a string Experimental.

func Fn_FindInMap ¶ 

func Fn_FindInMap(mapName *string, topLevelKey *string, secondLevelKey *string) *string

The intrinsic function “Fn::FindInMap“ returns the value corresponding to keys in a two-level map that is declared in the Mappings section.

Returns: a token represented as a string Experimental.

func Fn_GetAzs ¶ 

func Fn_GetAzs(region *string) *[]*string

The intrinsic function “Fn::GetAZs“ returns an array that lists Availability Zones for a specified region.

Because customers have access to different Availability Zones, the intrinsic function “Fn::GetAZs“ enables template authors to write templates that adapt to the calling user's access. That way you don't have to hard-code a full list of Availability Zones for a specified region.

Returns: a token represented as a string array Experimental.

func Fn_ImportListValue ¶ 

func Fn_ImportListValue(sharedValueToImport *string, assumedLength *float64, delimiter *string) *[]*string

Like `Fn.importValue`, but import a list with a known length.

If you explicitly want a list with an unknown length, call `Fn.split(',', Fn.importValue(exportName))`. See the documentation of `Fn.split` to read more about the limitations of using lists of unknown length.

`Fn.importListValue(exportName, assumedLength)` is the same as `Fn.split(',', Fn.importValue(exportName), assumedLength)`, but easier to read and impossible to forget to pass `assumedLength`. Experimental.

func Fn_ImportValue ¶ 

func Fn_ImportValue(sharedValueToImport *string) *string

The intrinsic function “Fn::ImportValue“ returns the value of an output exported by another stack.

You typically use this function to create cross-stack references. In the following example template snippets, Stack A exports VPC security group values and Stack B imports them.

Returns: a token represented as a string Experimental.

func Fn_Join ¶ 

func Fn_Join(delimiter *string, listOfValues *[]*string) *string

The intrinsic function “Fn::Join“ appends a set of values into a single value, separated by the specified delimiter.

If a delimiter is the empty string, the set of values are concatenated with no delimiter.

Returns: a token represented as a string Experimental.

func Fn_ParseDomainName ¶ 

func Fn_ParseDomainName(url *string) *string

Given an url, parse the domain name. Experimental.

func Fn_Ref ¶ 

func Fn_Ref(logicalName *string) *string

The “Ref“ intrinsic function returns the value of the specified parameter or resource.

Note that it doesn't validate the logicalName, it mainly serves paremeter/resource reference defined in a “CfnInclude“ template. Experimental.

func Fn_RefAll ¶ 

func Fn_RefAll(parameterType *string) *[]*string

Returns all values for a specified parameter type.

Returns: a token represented as a string array Experimental.

func Fn_Select ¶ 

func Fn_Select(index *float64, array *[]*string) *string

The intrinsic function “Fn::Select“ returns a single object from a list of objects by index.

Returns: a token represented as a string Experimental.

func Fn_Split ¶ 

func Fn_Split(delimiter *string, source *string, assumedLength *float64) *[]*string

Split a string token into a token list of string values.

Specify the location of splits with a delimiter such as ',' (a comma). Renders to the `Fn::Split` intrinsic function.

Lists with unknown lengths (default) -------------------------------------

Since this function is used to work with deploy-time values, if `assumedLength` is not given the CDK cannot know the length of the resulting list at synthesis time. This brings the following restrictions:

  • You must use `Fn.select(i, list)` to pick elements out of the list (you must not use `list[i]`).
  • You cannot add elements to the list, remove elements from the list, combine two such lists together, or take a slice of the list.
  • You cannot pass the list to constructs that do any of the above.

The only valid operation with such a tokenized list is to pass it unmodified to a CloudFormation Resource construct.

Lists with assumed lengths --------------------------

Pass `assumedLength` if you know the length of the list that will be produced by splitting. The actual list length at deploy time may be *longer* than the number you pass, but not *shorter*.

The returned list will look like:

``` [Fn.select(0, split), Fn.select(1, split), Fn.select(2, split), ...] ```

The restrictions from the section "Lists with unknown lengths" will now be lifted, at the expense of having to know and fix the length of the list.

Returns: a token represented as a string array Experimental.

func Fn_Sub ¶ 

func Fn_Sub(body *string, variables *map[string]*string) *string

The intrinsic function “Fn::Sub“ substitutes variables in an input string with values that you specify.

In your templates, you can use this function to construct commands or outputs that include values that aren't available until you create or update a stack.

Returns: a token represented as a string Experimental.

func Fn_ValueOf ¶ 

func Fn_ValueOf(parameterOrLogicalId *string, attribute *string) *string

Returns an attribute value or list of values for a specific parameter and attribute.

Returns: a token represented as a string Experimental.

func Fn_ValueOfAll ¶ 

func Fn_ValueOfAll(parameterType *string, attribute *string) *[]*string

Returns a list of all attribute values for a given parameter type and attribute.

Returns: a token represented as a string array Experimental.

func Lazy_List ¶ 

func Lazy_List(producer IStableListProducer, options *LazyListValueOptions) *[]*string

Defer the one-time calculation of a list value to synthesis time.

Use this if you want to render a list to a template whose actual value depends on some state mutation that may happen after the construct has been created.

If you are simply looking to force a value to a `string[]` type and don't need the calculation to be deferred, use `Token.asList()` instead.

The inner function will only be invoked once, and the resolved value cannot depend on the Stack the Token is used in. Experimental.

func Lazy_ListValue ¶ 

func Lazy_ListValue(producer IListProducer, options *LazyListValueOptions) *[]*string

Defer the one-time calculation of a list value to synthesis time.

Use this if you want to render a list to a template whose actual value depends on some state mutation that may happen after the construct has been created.

If you are simply looking to force a value to a `string[]` type and don't need the calculation to be deferred, use `Token.asList()` instead. Deprecated: Use `Lazy.list()` or `Lazy.uncachedList()` instead.

func Lazy_Number ¶ 

func Lazy_Number(producer IStableNumberProducer) *float64

Defer the one-time calculation of a number value to synthesis time.

Use this if you want to render a number to a template whose actual value depends on some state mutation that may happen after the construct has been created.

If you are simply looking to force a value to a `number` type and don't need the calculation to be deferred, use `Token.asNumber()` instead.

The inner function will only be invoked once, and the resolved value cannot depend on the Stack the Token is used in. Experimental.

func Lazy_NumberValue ¶ 

func Lazy_NumberValue(producer INumberProducer) *float64

Defer the one-time calculation of a number value to synthesis time.

Use this if you want to render a number to a template whose actual value depends on some state mutation that may happen after the construct has been created.

If you are simply looking to force a value to a `number` type and don't need the calculation to be deferred, use `Token.asNumber()` instead. Deprecated: Use `Lazy.number()` or `Lazy.uncachedNumber()` instead.

func Lazy_String ¶ 

func Lazy_String(producer IStableStringProducer, options *LazyStringValueOptions) *string

Defer the one-time calculation of a string value to synthesis time.

Use this if you want to render a string to a template whose actual value depends on some state mutation that may happen after the construct has been created.

If you are simply looking to force a value to a `string` type and don't need the calculation to be deferred, use `Token.asString()` instead.

The inner function will only be invoked once, and the resolved value cannot depend on the Stack the Token is used in. Experimental.

func Lazy_StringValue ¶ 

func Lazy_StringValue(producer IStringProducer, options *LazyStringValueOptions) *string

Defer the calculation of a string value to synthesis time.

Use this if you want to render a string to a template whose actual value depends on some state mutation that may happen after the construct has been created.

If you are simply looking to force a value to a `string` type and don't need the calculation to be deferred, use `Token.asString()` instead. Deprecated: Use `Lazy.string()` or `Lazy.uncachedString()` instead.

func Lazy_UncachedList ¶ 

func Lazy_UncachedList(producer IListProducer, options *LazyListValueOptions) *[]*string

Defer the calculation of a list value to synthesis time.

Use of this function is not recommended; unless you know you need it for sure, you probably don't. Use `Lazy.list()` instead.

The inner function may be invoked multiple times during synthesis. You should only use this method if the returned value depends on variables that may change during the Aspect application phase of synthesis, or if the value depends on the Stack the value is being used in. Both of these cases are rare, and only ever occur for AWS Construct Library authors. Experimental.

func Lazy_UncachedNumber ¶ 

func Lazy_UncachedNumber(producer INumberProducer) *float64

Defer the calculation of a number value to synthesis time.

Use of this function is not recommended; unless you know you need it for sure, you probably don't. Use `Lazy.number()` instead.

The inner function may be invoked multiple times during synthesis. You should only use this method if the returned value depends on variables that may change during the Aspect application phase of synthesis, or if the value depends on the Stack the value is being used in. Both of these cases are rare, and only ever occur for AWS Construct Library authors. Experimental.

func Lazy_UncachedString ¶ 

func Lazy_UncachedString(producer IStringProducer, options *LazyStringValueOptions) *string

Defer the calculation of a string value to synthesis time.

Use of this function is not recommended; unless you know you need it for sure, you probably don't. Use `Lazy.string()` instead.

The inner function may be invoked multiple times during synthesis. You should only use this method if the returned value depends on variables that may change during the Aspect application phase of synthesis, or if the value depends on the Stack the value is being used in. Both of these cases are rare, and only ever occur for AWS Construct Library authors. Experimental.

func Names_NodeUniqueId ¶ 

func Names_NodeUniqueId(node ConstructNode) *string

Returns a CloudFormation-compatible unique identifier for a construct based on its path.

The identifier includes a human readable portion rendered from the path components and a hash suffix.

TODO (v2): replace with API to use `constructs.Node`.

Returns: a unique id based on the construct path Experimental.

func Names_UniqueId ¶ 

func Names_UniqueId(construct constructs.Construct) *string

Returns a CloudFormation-compatible unique identifier for a construct based on its path.

The identifier includes a human readable portion rendered from the path components and a hash suffix.

Returns: a unique id based on the construct path Experimental.

func NestedStack_IsConstruct ¶ 

func NestedStack_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func NestedStack_IsNestedStack ¶ 

func NestedStack_IsNestedStack(x interface{}) *bool

Checks if `x` is an object of type `NestedStack`. Experimental.

func NestedStack_IsStack ¶ 

func NestedStack_IsStack(x interface{}) *bool

Return whether the given object is a Stack.

We do attribute detection since we can't reliably use 'instanceof'. Experimental.

func NewApp_Override ¶ 

func NewApp_Override(a App, props *AppProps)

Initializes a CDK application. Experimental.

func NewAssetStaging_Override ¶ 

func NewAssetStaging_Override(a AssetStaging, scope constructs.Construct, id *string, props *AssetStagingProps)

Experimental.

func NewBootstraplessSynthesizer_Override ¶ 

func NewBootstraplessSynthesizer_Override(b BootstraplessSynthesizer, props *BootstraplessSynthesizerProps)

Experimental.

func NewBundlingDockerImage_Override deprecated 

func NewBundlingDockerImage_Override(b BundlingDockerImage, image *string, _imageHash *string)

Deprecated: use DockerImage

func NewCfnCodeDeployBlueGreenHook_Override ¶ 

func NewCfnCodeDeployBlueGreenHook_Override(c CfnCodeDeployBlueGreenHook, scope constructs.Construct, id *string, props *CfnCodeDeployBlueGreenHookProps)

Creates a new CodeDeploy blue-green ECS Hook. Experimental.

func NewCfnCondition_Override ¶ 

func NewCfnCondition_Override(c CfnCondition, scope constructs.Construct, id *string, props *CfnConditionProps)

Build a new condition.

The condition must be constructed with a condition token, that the condition is based on. Experimental.

func NewCfnCustomResource_Override ¶ 

func NewCfnCustomResource_Override(c CfnCustomResource, scope Construct, id *string, props *CfnCustomResourceProps)

Create a new `AWS::CloudFormation::CustomResource`.

func NewCfnDynamicReference_Override ¶ 

func NewCfnDynamicReference_Override(c CfnDynamicReference, service CfnDynamicReferenceService, key *string)

Experimental.

func NewCfnElement_Override ¶ 

func NewCfnElement_Override(c CfnElement, scope constructs.Construct, id *string)

Creates an entity and binds it to a tree.

Note that the root of the tree must be a Stack object (not just any Root). Experimental.

func NewCfnHookDefaultVersion_Override ¶ 

func NewCfnHookDefaultVersion_Override(c CfnHookDefaultVersion, scope Construct, id *string, props *CfnHookDefaultVersionProps)

Create a new `AWS::CloudFormation::HookDefaultVersion`.

func NewCfnHookTypeConfig_Override ¶ 

func NewCfnHookTypeConfig_Override(c CfnHookTypeConfig, scope Construct, id *string, props *CfnHookTypeConfigProps)

Create a new `AWS::CloudFormation::HookTypeConfig`.

func NewCfnHookVersion_Override ¶ 

func NewCfnHookVersion_Override(c CfnHookVersion, scope Construct, id *string, props *CfnHookVersionProps)

Create a new `AWS::CloudFormation::HookVersion`.

func NewCfnHook_Override ¶ 

func NewCfnHook_Override(c CfnHook, scope constructs.Construct, id *string, props *CfnHookProps)

Creates a new Hook object. Experimental.

func NewCfnInclude_Override ¶ 

func NewCfnInclude_Override(c CfnInclude, scope constructs.Construct, id *string, props *CfnIncludeProps)

Creates an adopted template construct.

The template will be incorporated into the stack as-is with no changes at all. This means that logical IDs of entities within this template may conflict with logical IDs of entities that are part of the stack. Deprecated: use the CfnInclude class from the cloudformation-include module instead

func NewCfnJson_Override ¶ 

func NewCfnJson_Override(c CfnJson, scope constructs.Construct, id *string, props *CfnJsonProps)

Experimental.

func NewCfnMacro_Override ¶ 

func NewCfnMacro_Override(c CfnMacro, scope Construct, id *string, props *CfnMacroProps)

Create a new `AWS::CloudFormation::Macro`.

func NewCfnMapping_Override ¶ 

func NewCfnMapping_Override(c CfnMapping, scope constructs.Construct, id *string, props *CfnMappingProps)

Experimental.

func NewCfnModuleDefaultVersion_Override ¶ 

func NewCfnModuleDefaultVersion_Override(c CfnModuleDefaultVersion, scope Construct, id *string, props *CfnModuleDefaultVersionProps)

Create a new `AWS::CloudFormation::ModuleDefaultVersion`.

func NewCfnModuleVersion_Override ¶ 

func NewCfnModuleVersion_Override(c CfnModuleVersion, scope Construct, id *string, props *CfnModuleVersionProps)

Create a new `AWS::CloudFormation::ModuleVersion`.

func NewCfnOutput_Override ¶ 

func NewCfnOutput_Override(c CfnOutput, scope constructs.Construct, id *string, props *CfnOutputProps)

Creates an CfnOutput value for this stack. Experimental.

func NewCfnParameter_Override ¶ 

func NewCfnParameter_Override(c CfnParameter, scope constructs.Construct, id *string, props *CfnParameterProps)

Creates a parameter construct.

Note that the name (logical ID) of the parameter will derive from it's `coname` and location within the stack. Therefore, it is recommended that parameters are defined at the stack level. Experimental.

func NewCfnPublicTypeVersion_Override ¶ 

func NewCfnPublicTypeVersion_Override(c CfnPublicTypeVersion, scope Construct, id *string, props *CfnPublicTypeVersionProps)

Create a new `AWS::CloudFormation::PublicTypeVersion`.

func NewCfnPublisher_Override ¶ 

func NewCfnPublisher_Override(c CfnPublisher, scope Construct, id *string, props *CfnPublisherProps)

Create a new `AWS::CloudFormation::Publisher`.

func NewCfnRefElement_Override ¶ 

func NewCfnRefElement_Override(c CfnRefElement, scope constructs.Construct, id *string)

Creates an entity and binds it to a tree.

Note that the root of the tree must be a Stack object (not just any Root). Experimental.

func NewCfnResourceDefaultVersion_Override ¶ 

func NewCfnResourceDefaultVersion_Override(c CfnResourceDefaultVersion, scope Construct, id *string, props *CfnResourceDefaultVersionProps)

Create a new `AWS::CloudFormation::ResourceDefaultVersion`.

func NewCfnResourceVersion_Override ¶ 

func NewCfnResourceVersion_Override(c CfnResourceVersion, scope Construct, id *string, props *CfnResourceVersionProps)

Create a new `AWS::CloudFormation::ResourceVersion`.

func NewCfnResource_Override ¶ 

func NewCfnResource_Override(c CfnResource, scope constructs.Construct, id *string, props *CfnResourceProps)

Creates a resource construct. Experimental.

func NewCfnRule_Override ¶ 

func NewCfnRule_Override(c CfnRule, scope constructs.Construct, id *string, props *CfnRuleProps)

Creates and adds a rule. Experimental.

func NewCfnStackSet_Override ¶ 

func NewCfnStackSet_Override(c CfnStackSet, scope Construct, id *string, props *CfnStackSetProps)

Create a new `AWS::CloudFormation::StackSet`.

func NewCfnStack_Override ¶ 

func NewCfnStack_Override(c CfnStack, scope Construct, id *string, props *CfnStackProps)

Create a new `AWS::CloudFormation::Stack`.

func NewCfnTypeActivation_Override ¶ 

func NewCfnTypeActivation_Override(c CfnTypeActivation, scope Construct, id *string, props *CfnTypeActivationProps)

Create a new `AWS::CloudFormation::TypeActivation`.

func NewCfnWaitConditionHandle_Override ¶ 

func NewCfnWaitConditionHandle_Override(c CfnWaitConditionHandle, scope Construct, id *string)

Create a new `AWS::CloudFormation::WaitConditionHandle`.

func NewCfnWaitCondition_Override ¶ 

func NewCfnWaitCondition_Override(c CfnWaitCondition, scope Construct, id *string, props *CfnWaitConditionProps)

Create a new `AWS::CloudFormation::WaitCondition`.

func NewCliCredentialsStackSynthesizer_Override ¶ 

func NewCliCredentialsStackSynthesizer_Override(c CliCredentialsStackSynthesizer, props *CliCredentialsStackSynthesizerProps)

Experimental.

func NewConcreteDependable_Override ¶ 

func NewConcreteDependable_Override(c ConcreteDependable)

Experimental.

func NewConstructNode_Override ¶ 

func NewConstructNode_Override(c ConstructNode, host Construct, scope IConstruct, id *string)

Experimental.

func NewConstruct_Override ¶ 

func NewConstruct_Override(c Construct, scope constructs.Construct, id *string)

Experimental.

func NewCustomResourceProvider_Override ¶ 

func NewCustomResourceProvider_Override(c CustomResourceProvider, scope constructs.Construct, id *string, props *CustomResourceProviderProps)

Experimental.

func NewCustomResource_Override ¶ 

func NewCustomResource_Override(c CustomResource, scope constructs.Construct, id *string, props *CustomResourceProps)

Experimental.

func NewDefaultStackSynthesizer_Override ¶ 

func NewDefaultStackSynthesizer_Override(d DefaultStackSynthesizer, props *DefaultStackSynthesizerProps)

Experimental.

func NewDefaultTokenResolver_Override ¶ 

func NewDefaultTokenResolver_Override(d DefaultTokenResolver, concat IFragmentConcatenator)

Experimental.

func NewDependableTrait_Override ¶ 

func NewDependableTrait_Override(d DependableTrait)

Experimental.

func NewDockerIgnoreStrategy_Override ¶ 

func NewDockerIgnoreStrategy_Override(d DockerIgnoreStrategy, absoluteRootPath *string, patterns *[]*string)

Experimental.

func NewDockerImage_Override ¶ 

func NewDockerImage_Override(d DockerImage, image *string, _imageHash *string)

Experimental.

func NewFileSystem_Override ¶ 

func NewFileSystem_Override(f FileSystem)

Experimental.

func NewGitIgnoreStrategy_Override ¶ 

func NewGitIgnoreStrategy_Override(g GitIgnoreStrategy, absoluteRootPath *string, patterns *[]*string)

Experimental.

func NewGlobIgnoreStrategy_Override ¶ 

func NewGlobIgnoreStrategy_Override(g GlobIgnoreStrategy, absoluteRootPath *string, patterns *[]*string)

Experimental.

func NewIgnoreStrategy_Override ¶ 

func NewIgnoreStrategy_Override(i IgnoreStrategy)

Experimental.

func NewIntrinsic_Override ¶ 

func NewIntrinsic_Override(i Intrinsic, value interface{}, options *IntrinsicProps)

Experimental.

func NewLegacyStackSynthesizer_Override ¶ 

func NewLegacyStackSynthesizer_Override(l LegacyStackSynthesizer)

Experimental.

func NewNestedStackSynthesizer_Override ¶ 

func NewNestedStackSynthesizer_Override(n NestedStackSynthesizer, parentDeployment IStackSynthesizer)

Experimental.

func NewNestedStack_Override ¶ 

func NewNestedStack_Override(n NestedStack, scope constructs.Construct, id *string, props *NestedStackProps)

Experimental.

func NewReference_Override ¶ 

func NewReference_Override(r Reference, value interface{}, target IConstruct, displayName *string)

Experimental.

func NewRemoveTag_Override ¶ 

func NewRemoveTag_Override(r RemoveTag, key *string, props *TagProps)

Experimental.

func NewResource_Override ¶ 

func NewResource_Override(r Resource, scope constructs.Construct, id *string, props *ResourceProps)

Experimental.

func NewScopedAws_Override ¶ 

func NewScopedAws_Override(s ScopedAws, scope Construct)

Experimental.

func NewSecretValue_Override ¶ 

func NewSecretValue_Override(s SecretValue, value interface{}, options *IntrinsicProps)

Experimental.

func NewStackSynthesizer_Override ¶ 

func NewStackSynthesizer_Override(s StackSynthesizer)

Experimental.

func NewStack_Override ¶ 

func NewStack_Override(s Stack, scope constructs.Construct, id *string, props *StackProps)

Creates a new stack. Experimental.

func NewStage_Override ¶ 

func NewStage_Override(s Stage, scope constructs.Construct, id *string, props *StageProps)

Experimental.

func NewStringConcat_Override ¶ 

func NewStringConcat_Override(s StringConcat)

Experimental.

func NewTagManager_Override ¶ 

func NewTagManager_Override(t TagManager, tagType TagType, resourceTypeName *string, tagStructure interface{}, options *TagManagerOptions)

Experimental.

func NewTag_Override ¶ 

func NewTag_Override(t Tag, key *string, value *string, props *TagProps)

Experimental.

func NewTokenizedStringFragments_Override ¶ 

func NewTokenizedStringFragments_Override(t TokenizedStringFragments)

Experimental.

func NewTreeInspector_Override ¶ 

func NewTreeInspector_Override(t TreeInspector)

Experimental.

func NewValidationResult_Override ¶ 

func NewValidationResult_Override(v ValidationResult, errorMessage *string, results ValidationResults)

Experimental.

func NewValidationResults_Override ¶ 

func NewValidationResults_Override(v ValidationResults, results *[]ValidationResult)

Experimental.

func PhysicalName_GENERATE_IF_NEEDED ¶ 

func PhysicalName_GENERATE_IF_NEEDED() *string

func Reference_IsReference ¶ 

func Reference_IsReference(x interface{}) *bool

Check whether this is actually a Reference. Experimental.

func Resource_IsConstruct ¶ 

func Resource_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func Resource_IsResource ¶ 

func Resource_IsResource(construct IConstruct) *bool

Check whether the given construct is a Resource. Experimental.

func Stack_IsConstruct ¶ 

func Stack_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func Stack_IsStack ¶ 

func Stack_IsStack(x interface{}) *bool

Return whether the given object is a Stack.

We do attribute detection since we can't reliably use 'instanceof'. Experimental.

func Stage_IsConstruct ¶ 

func Stage_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func Stage_IsStage ¶ 

func Stage_IsStage(x interface{}) *bool

Test whether the given construct is a stage. Experimental.

func TagManager_IsTaggable ¶ 

func TagManager_IsTaggable(construct interface{}) *bool

Check whether the given construct is Taggable. Experimental.

func Tag_Add ¶ 

func Tag_Add(scope Construct, key *string, value *string, props *TagProps)

DEPRECATED: add tags to the node of a construct and all its the taggable children. Deprecated: use `Tags.of(scope).add()`

func Tag_Remove ¶ 

func Tag_Remove(scope Construct, key *string, props *TagProps)

DEPRECATED: remove tags to the node of a construct and all its the taggable children. Deprecated: use `Tags.of(scope).remove()`

func Token_AsList ¶ 

func Token_AsList(value interface{}, options *EncodingOptions) *[]*string

Return a reversible list representation of this token. Experimental.

func Token_AsNumber ¶ 

func Token_AsNumber(value interface{}) *float64

Return a reversible number representation of this token. Experimental.

func Token_AsString ¶ 

func Token_AsString(value interface{}, options *EncodingOptions) *string

Return a reversible string representation of this token.

If the Token is initialized with a literal, the stringified value of the literal is returned. Otherwise, a special quoted string representation of the Token is returned that can be embedded into other strings.

Strings with quoted Tokens in them can be restored back into complex values with the Tokens restored by calling `resolve()` on the string. Experimental.

func Token_IsUnresolved ¶ 

func Token_IsUnresolved(obj interface{}) *bool

Returns true if obj represents an unresolved value.

One of these must be true:

- `obj` is an IResolvable - `obj` is a string containing at least one encoded `IResolvable` - `obj` is either an encoded number or list

This does NOT recurse into lists or objects to see if they containing resolvables. Experimental.

func Tokenization_IsResolvable ¶ 

func Tokenization_IsResolvable(obj interface{}) *bool

Return whether the given object is an IResolvable object.

This is different from Token.isUnresolved() which will also check for encoded Tokens, whereas this method will only do a type check on the given object. Experimental.

func Tokenization_Resolve ¶ 

func Tokenization_Resolve(obj interface{}, options *ResolveOptions) interface{}

Resolves an object by evaluating all tokens and removing any undefined or empty objects or arrays.

Values can only be primitives, arrays or tokens. Other objects (i.e. with methods) will be rejected. Experimental.

func Tokenization_StringifyNumber ¶ 

func Tokenization_StringifyNumber(x *float64) *string

Stringify a number directly or lazily if it's a Token.

If it is an object (i.e., { Ref: 'SomeLogicalId' }), return it as-is. Experimental.

Types ¶

type Annotations ¶ 

type Annotations interface {
	AddDeprecation(api *string, message *string)
	AddError(message *string)
	AddInfo(message *string)
	AddWarning(message *string)
}

Includes API for attaching annotations such as warning messages to constructs.

TODO: EXAMPLE

Experimental.

func Annotations_Of ¶ 

func Annotations_Of(scope constructs.IConstruct) Annotations

Returns the annotations API for a construct scope. Experimental.

type App ¶ 

type App interface {
	Stage
	Account() *string
	ArtifactId() *string
	AssetOutdir() *string
	Node() ConstructNode
	Outdir() *string
	ParentStage() Stage
	Region() *string
	StageName() *string
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	Prepare()
	Synth(options *StageSynthesisOptions) cxapi.CloudAssembly
	Synthesize(session ISynthesisSession)
	ToString() *string
	Validate() *[]*string
}

A construct which represents an entire CDK app. This construct is normally the root of the construct tree.

You would normally define an `App` instance in your program's entrypoint, then define constructs where the app is used as the parent scope.

After all the child constructs are defined within the app, you should call `app.synth()` which will emit a "cloud assembly" from this app into the directory specified by `outdir`. Cloud assemblies includes artifacts such as CloudFormation templates and assets that are needed to deploy this app into the AWS cloud.

TODO: EXAMPLE

See: https://docs.aws.amazon.com/cdk/latest/guide/apps.html

Experimental.

func NewApp ¶ 

func NewApp(props *AppProps) App

Initializes a CDK application. Experimental.

type AppProps ¶ 

type AppProps struct {
	// Include runtime versioning information in the Stacks of this app.
	// Experimental.
	AnalyticsReporting *bool `json:"analyticsReporting" yaml:"analyticsReporting"`
	// Automatically call `synth()` before the program exits.
	//
	// If you set this, you don't have to call `synth()` explicitly. Note that
	// this feature is only available for certain programming languages, and
	// calling `synth()` is still recommended.
	// Experimental.
	AutoSynth *bool `json:"autoSynth" yaml:"autoSynth"`
	// Additional context values for the application.
	//
	// Context set by the CLI or the `context` key in `cdk.json` has precedence.
	//
	// Context can be read from any construct using `node.getContext(key)`.
	// Experimental.
	Context *map[string]interface{} `json:"context" yaml:"context"`
	// The output directory into which to emit synthesized artifacts.
	//
	// You should never need to set this value. By default, the value you pass to
	// the CLI's `--output` flag will be used, and if you change it to a different
	// directory the CLI will fail to pick up the generated Cloud Assembly.
	//
	// This property is intended for internal and testing use.
	// Experimental.
	Outdir *string `json:"outdir" yaml:"outdir"`
	// Include runtime versioning information in the Stacks of this app.
	// Deprecated: use `versionReporting` instead
	RuntimeInfo *bool `json:"runtimeInfo" yaml:"runtimeInfo"`
	// Include construct creation stack trace in the `aws:cdk:trace` metadata key of all constructs.
	// Experimental.
	StackTraces *bool `json:"stackTraces" yaml:"stackTraces"`
	// Include construct tree metadata as part of the Cloud Assembly.
	// Experimental.
	TreeMetadata *bool `json:"treeMetadata" yaml:"treeMetadata"`
}

Initialization props for apps.

TODO: EXAMPLE

Experimental.

type Arn ¶ 

type Arn interface {
}

Experimental.

type ArnComponents ¶ 

type ArnComponents struct {
	// Resource type (e.g. "table", "autoScalingGroup", "certificate"). For some resource types, e.g. S3 buckets, this field defines the bucket name.
	// Experimental.
	Resource *string `json:"resource" yaml:"resource"`
	// The service namespace that identifies the AWS product (for example, 's3', 'iam', 'codepipline').
	// Experimental.
	Service *string `json:"service" yaml:"service"`
	// The ID of the AWS account that owns the resource, without the hyphens.
	//
	// For example, 123456789012. Note that the ARNs for some resources don't
	// require an account number, so this component might be omitted.
	// Experimental.
	Account *string `json:"account" yaml:"account"`
	// The specific ARN format to use for this ARN value.
	// Experimental.
	ArnFormat ArnFormat `json:"arnFormat" yaml:"arnFormat"`
	// The partition that the resource is in.
	//
	// For standard AWS regions, the
	// partition is aws. If you have resources in other partitions, the
	// partition is aws-partitionname. For example, the partition for resources
	// in the China (Beijing) region is aws-cn.
	// Experimental.
	Partition *string `json:"partition" yaml:"partition"`
	// The region the resource resides in.
	//
	// Note that the ARNs for some resources
	// do not require a region, so this component might be omitted.
	// Experimental.
	Region *string `json:"region" yaml:"region"`
	// Resource name or path within the resource (i.e. S3 bucket object key) or a wildcard such as “"*"“. This is service-dependent.
	// Experimental.
	ResourceName *string `json:"resourceName" yaml:"resourceName"`
	// Separator between resource type and the resource.
	//
	// Can be either '/', ':' or an empty string. Will only be used if resourceName is defined.
	// Deprecated: use arnFormat instead
	Sep *string `json:"sep" yaml:"sep"`
}

TODO: EXAMPLE

Experimental.

func Arn_Parse ¶ 

func Arn_Parse(arn *string, sepIfToken *string, hasName *bool) *ArnComponents

Given an ARN, parses it and returns components.

IF THE ARN IS A CONCRETE STRING...

...it will be parsed and validated. The separator (`sep`) will be set to '/' if the 6th component includes a '/', in which case, `resource` will be set to the value before the '/' and `resourceName` will be the rest. In case there is no '/', `resource` will be set to the 6th components and `resourceName` will be set to the rest of the string.

IF THE ARN IS A TOKEN...

...it cannot be validated, since we don't have the actual value yet at the time of this function call. You will have to supply `sepIfToken` and whether or not ARNs of the expected format usually have resource names in order to parse it properly. The resulting `ArnComponents` object will contain tokens for the subexpressions of the ARN, not string literals.

If the resource name could possibly contain the separator char, the actual resource name cannot be properly parsed. This only occurs if the separator char is '/', and happens for example for S3 object ARNs, IAM Role ARNs, IAM OIDC Provider ARNs, etc. To properly extract the resource name from a Tokenized ARN, you must know the resource type and call `Arn.extractResourceName`.

Returns: an ArnComponents object which allows access to the various components of the ARN. Deprecated: use split instead

func Arn_Split ¶ 

func Arn_Split(arn *string, arnFormat ArnFormat) *ArnComponents

Splits the provided ARN into its components.

Works both if 'arn' is a string like 'arn:aws:s3:::bucket', and a Token representing a dynamic CloudFormation expression (in which case the returned components will also be dynamic CloudFormation expressions, encoded as Tokens). Experimental.

type ArnFormat ¶ 

type ArnFormat string

An enum representing the various ARN formats that different services use. Experimental. 

const (
	ArnFormat_NO_RESOURCE_NAME                   ArnFormat = "NO_RESOURCE_NAME"
	ArnFormat_COLON_RESOURCE_NAME                ArnFormat = "COLON_RESOURCE_NAME"
	ArnFormat_SLASH_RESOURCE_NAME                ArnFormat = "SLASH_RESOURCE_NAME"
	ArnFormat_SLASH_RESOURCE_SLASH_RESOURCE_NAME ArnFormat = "SLASH_RESOURCE_SLASH_RESOURCE_NAME"
)

type Aspects ¶ 

type Aspects interface {
	Aspects() *[]IAspect
	Add(aspect IAspect)
}

Aspects can be applied to CDK tree scopes and can operate on the tree before synthesis.

TODO: EXAMPLE

Experimental.

func Aspects_Of ¶ 

func Aspects_Of(scope IConstruct) Aspects

Returns the `Aspects` object associated with a construct scope. Experimental.

type AssetHashType ¶ 

type AssetHashType string

The type of asset hash.

NOTE: the hash is used in order to identify a specific revision of the asset, and used for optimizing and caching deployment activities related to this asset such as packaging, uploading to Amazon S3, etc. Experimental. 

const (
	AssetHashType_SOURCE AssetHashType = "SOURCE"
	AssetHashType_BUNDLE AssetHashType = "BUNDLE"
	AssetHashType_OUTPUT AssetHashType = "OUTPUT"
	AssetHashType_CUSTOM AssetHashType = "CUSTOM"
)

type AssetOptions ¶ 

type AssetOptions struct {
	// Specify a custom hash for this asset.
	//
	// If `assetHashType` is set it must
	// be set to `AssetHashType.CUSTOM`. For consistency, this custom hash will
	// be SHA256 hashed and encoded as hex. The resulting hash will be the asset
	// hash.
	//
	// NOTE: the hash is used in order to identify a specific revision of the asset, and
	// used for optimizing and caching deployment activities related to this asset such as
	// packaging, uploading to Amazon S3, etc. If you chose to customize the hash, you will
	// need to make sure it is updated every time the asset changes, or otherwise it is
	// possible that some deployments will not be invalidated.
	// Experimental.
	AssetHash *string `json:"assetHash" yaml:"assetHash"`
	// Specifies the type of hash to calculate for this asset.
	//
	// If `assetHash` is configured, this option must be `undefined` or
	// `AssetHashType.CUSTOM`.
	// Experimental.
	AssetHashType AssetHashType `json:"assetHashType" yaml:"assetHashType"`
	// Bundle the asset by executing a command in a Docker container or a custom bundling provider.
	//
	// The asset path will be mounted at `/asset-input`. The Docker
	// container is responsible for putting content at `/asset-output`.
	// The content at `/asset-output` will be zipped and used as the
	// final asset.
	// Experimental.
	Bundling *BundlingOptions `json:"bundling" yaml:"bundling"`
}

Asset hash options.

TODO: EXAMPLE

Experimental.

type AssetStaging ¶ 

type AssetStaging interface {
	Construct
	AbsoluteStagedPath() *string
	AssetHash() *string
	IsArchive() *bool
	Node() ConstructNode
	Packaging() FileAssetPackaging
	SourceHash() *string
	SourcePath() *string
	StagedPath() *string
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	Prepare()
	RelativeStagedPath(stack Stack) *string
	Synthesize(session ISynthesisSession)
	ToString() *string
	Validate() *[]*string
}

Stages a file or directory from a location on the file system into a staging directory.

This is controlled by the context key 'aws:cdk:asset-staging' and enabled by the CLI by default in order to ensure that when the CDK app exists, all assets are available for deployment. Otherwise, if an app references assets in temporary locations, those will not be available when it exists (see https://github.com/aws/aws-cdk/issues/1716).

The `stagedPath` property is a stringified token that represents the location of the file or directory after staging. It will be resolved only during the "prepare" stage and may be either the original path or the staged path depending on the context setting.

The file/directory are staged based on their content hash (fingerprint). This means that only if content was changed, copy will happen.

TODO: EXAMPLE

Experimental.

func NewAssetStaging ¶ 

func NewAssetStaging(scope constructs.Construct, id *string, props *AssetStagingProps) AssetStaging

Experimental.

type AssetStagingProps ¶ 

type AssetStagingProps struct {
	// Glob patterns to exclude from the copy.
	// Experimental.
	Exclude *[]*string `json:"exclude" yaml:"exclude"`
	// A strategy for how to handle symlinks.
	// Experimental.
	Follow SymlinkFollowMode `json:"follow" yaml:"follow"`
	// The ignore behavior to use for exclude patterns.
	// Experimental.
	IgnoreMode IgnoreMode `json:"ignoreMode" yaml:"ignoreMode"`
	// Extra information to encode into the fingerprint (e.g. build instructions and other inputs).
	// Experimental.
	ExtraHash *string `json:"extraHash" yaml:"extraHash"`
	// Specify a custom hash for this asset.
	//
	// If `assetHashType` is set it must
	// be set to `AssetHashType.CUSTOM`. For consistency, this custom hash will
	// be SHA256 hashed and encoded as hex. The resulting hash will be the asset
	// hash.
	//
	// NOTE: the hash is used in order to identify a specific revision of the asset, and
	// used for optimizing and caching deployment activities related to this asset such as
	// packaging, uploading to Amazon S3, etc. If you chose to customize the hash, you will
	// need to make sure it is updated every time the asset changes, or otherwise it is
	// possible that some deployments will not be invalidated.
	// Experimental.
	AssetHash *string `json:"assetHash" yaml:"assetHash"`
	// Specifies the type of hash to calculate for this asset.
	//
	// If `assetHash` is configured, this option must be `undefined` or
	// `AssetHashType.CUSTOM`.
	// Experimental.
	AssetHashType AssetHashType `json:"assetHashType" yaml:"assetHashType"`
	// Bundle the asset by executing a command in a Docker container or a custom bundling provider.
	//
	// The asset path will be mounted at `/asset-input`. The Docker
	// container is responsible for putting content at `/asset-output`.
	// The content at `/asset-output` will be zipped and used as the
	// final asset.
	// Experimental.
	Bundling *BundlingOptions `json:"bundling" yaml:"bundling"`
	// The source file or directory to copy from.
	// Experimental.
	SourcePath *string `json:"sourcePath" yaml:"sourcePath"`
}

Initialization properties for `AssetStaging`.

TODO: EXAMPLE

Experimental.

type Aws ¶ 

type Aws interface {
}

Accessor for pseudo parameters.

Since pseudo parameters need to be anchored to a stack somewhere in the construct tree, this class takes an scope parameter; the pseudo parameter values can be obtained as properties from an scoped object. Experimental.

type BootstraplessSynthesizer ¶ 

type BootstraplessSynthesizer interface {
	DefaultStackSynthesizer
	CloudFormationExecutionRoleArn() *string
	DeployRoleArn() *string
	Stack() Stack
	AddDockerImageAsset(_asset *DockerImageAssetSource) *DockerImageAssetLocation
	AddFileAsset(_asset *FileAssetSource) *FileAssetLocation
	Bind(stack Stack)
	EmitStackArtifact(stack Stack, session ISynthesisSession, options *SynthesizeStackArtifactOptions)
	Synthesize(session ISynthesisSession)
	SynthesizeStackTemplate(stack Stack, session ISynthesisSession)
}

Synthesizer that reuses bootstrap roles from a different region.

A special synthesizer that behaves similarly to `DefaultStackSynthesizer`, but doesn't require bootstrapping the environment it operates in. Instead, it will re-use the Roles that were created for a different region (which is possible because IAM is a global service).

However, it will not assume asset buckets or repositories have been created, and therefore does not support assets.

Used by the CodePipeline construct for the support stacks needed for cross-region replication S3 buckets. App builders do not need to use this synthesizer directly.

TODO: EXAMPLE

Experimental.

func NewBootstraplessSynthesizer ¶ 

func NewBootstraplessSynthesizer(props *BootstraplessSynthesizerProps) BootstraplessSynthesizer

Experimental.

type BootstraplessSynthesizerProps ¶ 

type BootstraplessSynthesizerProps struct {
	// The CFN execution Role ARN to use.
	// Experimental.
	CloudFormationExecutionRoleArn *string `json:"cloudFormationExecutionRoleArn" yaml:"cloudFormationExecutionRoleArn"`
	// The deploy Role ARN to use.
	// Experimental.
	DeployRoleArn *string `json:"deployRoleArn" yaml:"deployRoleArn"`
}

Construction properties of {@link BootstraplessSynthesizer}.

TODO: EXAMPLE

Experimental.

type BundlingDockerImage deprecated 

type BundlingDockerImage interface {
	Image() *string
	Cp(imagePath *string, outputPath *string) *string
	Run(options *DockerRunOptions)
	ToJSON() *string
}

A Docker image used for asset bundling.

TODO: EXAMPLE

Deprecated: use DockerImage

func BundlingDockerImage_FromAsset ¶ 

func BundlingDockerImage_FromAsset(path *string, options *DockerBuildOptions) BundlingDockerImage

Reference an image that's built directly from sources on disk. Deprecated: use DockerImage.fromBuild()

func DockerImage_FromAsset ¶ 

func DockerImage_FromAsset(path *string, options *DockerBuildOptions) BundlingDockerImage

Reference an image that's built directly from sources on disk. Deprecated: use DockerImage.fromBuild()

func NewBundlingDockerImage deprecated 

func NewBundlingDockerImage(image *string, _imageHash *string) BundlingDockerImage

Deprecated: use DockerImage

type BundlingOptions ¶ 

type BundlingOptions struct {
	// The Docker image where the command will run.
	// Experimental.
	Image DockerImage `json:"image" yaml:"image"`
	// The command to run in the Docker container.
	//
	// Example value: `['npm', 'install']`
	// See: https://docs.docker.com/engine/reference/run/
	//
	// Experimental.
	Command *[]*string `json:"command" yaml:"command"`
	// The entrypoint to run in the Docker container.
	//
	// Example value: `['/bin/sh', '-c']`
	// See: https://docs.docker.com/engine/reference/builder/#entrypoint
	//
	// Experimental.
	Entrypoint *[]*string `json:"entrypoint" yaml:"entrypoint"`
	// The environment variables to pass to the Docker container.
	// Experimental.
	Environment *map[string]*string `json:"environment" yaml:"environment"`
	// Local bundling provider.
	//
	// The provider implements a method `tryBundle()` which should return `true`
	// if local bundling was performed. If `false` is returned, docker bundling
	// will be done.
	// Experimental.
	Local ILocalBundling `json:"local" yaml:"local"`
	// The type of output that this bundling operation is producing.
	// Experimental.
	OutputType BundlingOutput `json:"outputType" yaml:"outputType"`
	// [Security configuration](https://docs.docker.com/engine/reference/run/#security-configuration) when running the docker container.
	// Experimental.
	SecurityOpt *string `json:"securityOpt" yaml:"securityOpt"`
	// The user to use when running the Docker container.
	//
	// user | user:group | uid | uid:gid | user:gid | uid:group
	// See: https://docs.docker.com/engine/reference/run/#user
	//
	// Experimental.
	User *string `json:"user" yaml:"user"`
	// Additional Docker volumes to mount.
	// Experimental.
	Volumes *[]*DockerVolume `json:"volumes" yaml:"volumes"`
	// Working directory inside the Docker container.
	// Experimental.
	WorkingDirectory *string `json:"workingDirectory" yaml:"workingDirectory"`
}

Bundling options.

TODO: EXAMPLE

Experimental.

type BundlingOutput ¶ 

type BundlingOutput string

The type of output that a bundling operation is producing.

TODO: EXAMPLE

Experimental. 

const (
	BundlingOutput_ARCHIVED      BundlingOutput = "ARCHIVED"
	BundlingOutput_NOT_ARCHIVED  BundlingOutput = "NOT_ARCHIVED"
	BundlingOutput_AUTO_DISCOVER BundlingOutput = "AUTO_DISCOVER"
)

type CfnAutoScalingReplacingUpdate ¶ 

type CfnAutoScalingReplacingUpdate struct {
	// Experimental.
	WillReplace *bool `json:"willReplace" yaml:"willReplace"`
}

Specifies whether an Auto Scaling group and the instances it contains are replaced during an update.

During replacement, AWS CloudFormation retains the old group until it finishes creating the new one. If the update fails, AWS CloudFormation can roll back to the old Auto Scaling group and delete the new Auto Scaling group.

While AWS CloudFormation creates the new group, it doesn't detach or attach any instances. After successfully creating the new Auto Scaling group, AWS CloudFormation deletes the old Auto Scaling group during the cleanup process.

When you set the WillReplace parameter, remember to specify a matching CreationPolicy. If the minimum number of instances (specified by the MinSuccessfulInstancesPercent property) don't signal success within the Timeout period (specified in the CreationPolicy policy), the replacement update fails and AWS CloudFormation rolls back to the old Auto Scaling group.

TODO: EXAMPLE

Experimental.

type CfnAutoScalingRollingUpdate ¶ 

type CfnAutoScalingRollingUpdate struct {
	// Specifies the maximum number of instances that AWS CloudFormation updates.
	// Experimental.
	MaxBatchSize *float64 `json:"maxBatchSize" yaml:"maxBatchSize"`
	// Specifies the minimum number of instances that must be in service within the Auto Scaling group while AWS CloudFormation updates old instances.
	// Experimental.
	MinInstancesInService *float64 `json:"minInstancesInService" yaml:"minInstancesInService"`
	// Specifies the percentage of instances in an Auto Scaling rolling update that must signal success for an update to succeed.
	//
	// You can specify a value from 0 to 100. AWS CloudFormation rounds to the nearest tenth of a percent. For example, if you
	// update five instances with a minimum successful percentage of 50, three instances must signal success.
	//
	// If an instance doesn't send a signal within the time specified in the PauseTime property, AWS CloudFormation assumes
	// that the instance wasn't updated.
	//
	// If you specify this property, you must also enable the WaitOnResourceSignals and PauseTime properties.
	// Experimental.
	MinSuccessfulInstancesPercent *float64 `json:"minSuccessfulInstancesPercent" yaml:"minSuccessfulInstancesPercent"`
	// The amount of time that AWS CloudFormation pauses after making a change to a batch of instances to give those instances time to start software applications.
	//
	// For example, you might need to specify PauseTime when scaling up the number of
	// instances in an Auto Scaling group.
	//
	// If you enable the WaitOnResourceSignals property, PauseTime is the amount of time that AWS CloudFormation should wait
	// for the Auto Scaling group to receive the required number of valid signals from added or replaced instances. If the
	// PauseTime is exceeded before the Auto Scaling group receives the required number of signals, the update fails. For best
	// results, specify a time period that gives your applications sufficient time to get started. If the update needs to be
	// rolled back, a short PauseTime can cause the rollback to fail.
	//
	// Specify PauseTime in the ISO8601 duration format (in the format PT#H#M#S, where each # is the number of hours, minutes,
	// and seconds, respectively). The maximum PauseTime is one hour (PT1H).
	// Experimental.
	PauseTime *string `json:"pauseTime" yaml:"pauseTime"`
	// Specifies the Auto Scaling processes to suspend during a stack update.
	//
	// Suspending processes prevents Auto Scaling from
	// interfering with a stack update. For example, you can suspend alarming so that Auto Scaling doesn't execute scaling
	// policies associated with an alarm. For valid values, see the ScalingProcesses.member.N parameter for the SuspendProcesses
	// action in the Auto Scaling API Reference.
	// Experimental.
	SuspendProcesses *[]*string `json:"suspendProcesses" yaml:"suspendProcesses"`
	// Specifies whether the Auto Scaling group waits on signals from new instances during an update.
	//
	// Use this property to
	// ensure that instances have completed installing and configuring applications before the Auto Scaling group update proceeds.
	// AWS CloudFormation suspends the update of an Auto Scaling group after new EC2 instances are launched into the group.
	// AWS CloudFormation must receive a signal from each new instance within the specified PauseTime before continuing the update.
	// To signal the Auto Scaling group, use the cfn-signal helper script or SignalResource API.
	//
	// To have instances wait for an Elastic Load Balancing health check before they signal success, add a health-check
	// verification by using the cfn-init helper script. For an example, see the verify_instance_health command in the Auto Scaling
	// rolling updates sample template.
	// Experimental.
	WaitOnResourceSignals *bool `json:"waitOnResourceSignals" yaml:"waitOnResourceSignals"`
}

To specify how AWS CloudFormation handles rolling updates for an Auto Scaling group, use the AutoScalingRollingUpdate policy.

Rolling updates enable you to specify whether AWS CloudFormation updates instances that are in an Auto Scaling group in batches or all at once.

TODO: EXAMPLE

Experimental.

type CfnAutoScalingScheduledAction ¶ 

type CfnAutoScalingScheduledAction struct {
	// Experimental.
	IgnoreUnmodifiedGroupSizeProperties *bool `json:"ignoreUnmodifiedGroupSizeProperties" yaml:"ignoreUnmodifiedGroupSizeProperties"`
}

With scheduled actions, the group size properties of an Auto Scaling group can change at any time.

When you update a stack with an Auto Scaling group and scheduled action, AWS CloudFormation always sets the group size property values of your Auto Scaling group to the values that are defined in the AWS::AutoScaling::AutoScalingGroup resource of your template, even if a scheduled action is in effect.

If you do not want AWS CloudFormation to change any of the group size property values when you have a scheduled action in effect, use the AutoScalingScheduledAction update policy to prevent AWS CloudFormation from changing the MinSize, MaxSize, or DesiredCapacity properties unless you have modified these values in your template.\

TODO: EXAMPLE

Experimental.

type CfnCapabilities ¶ 

type CfnCapabilities string

Capabilities that affect whether CloudFormation is allowed to change IAM resources. Experimental. 

const (
	CfnCapabilities_NONE          CfnCapabilities = "NONE"
	CfnCapabilities_ANONYMOUS_IAM CfnCapabilities = "ANONYMOUS_IAM"
	CfnCapabilities_NAMED_IAM     CfnCapabilities = "NAMED_IAM"
	CfnCapabilities_AUTO_EXPAND   CfnCapabilities = "AUTO_EXPAND"
)

type CfnCodeDeployBlueGreenAdditionalOptions ¶ 

type CfnCodeDeployBlueGreenAdditionalOptions struct {
	// Specifies time to wait, in minutes, before terminating the blue resources.
	// Experimental.
	TerminationWaitTimeInMinutes *float64 `json:"terminationWaitTimeInMinutes" yaml:"terminationWaitTimeInMinutes"`
}

Additional options for the blue/green deployment.

The type of the {@link CfnCodeDeployBlueGreenHookProps.additionalOptions} property.

TODO: EXAMPLE

Experimental.

type CfnCodeDeployBlueGreenApplication ¶ 

type CfnCodeDeployBlueGreenApplication struct {
	// The detailed attributes of the deployed target.
	// Experimental.
	EcsAttributes *CfnCodeDeployBlueGreenEcsAttributes `json:"ecsAttributes" yaml:"ecsAttributes"`
	// The target that is being deployed.
	// Experimental.
	Target *CfnCodeDeployBlueGreenApplicationTarget `json:"target" yaml:"target"`
}

The application actually being deployed.

Type of the {@link CfnCodeDeployBlueGreenHookProps.applications} property.

TODO: EXAMPLE

Experimental.

type CfnCodeDeployBlueGreenApplicationTarget ¶ 

type CfnCodeDeployBlueGreenApplicationTarget struct {
	// The logical id of the target resource.
	// Experimental.
	LogicalId *string `json:"logicalId" yaml:"logicalId"`
	// The resource type of the target being deployed.
	//
	// Right now, the only allowed value is 'AWS::ECS::Service'.
	// Experimental.
	Type *string `json:"type" yaml:"type"`
}

Type of the {@link CfnCodeDeployBlueGreenApplication.target} property.

TODO: EXAMPLE

Experimental.

type CfnCodeDeployBlueGreenEcsAttributes ¶ 

type CfnCodeDeployBlueGreenEcsAttributes struct {
	// The logical IDs of the blue and green, respectively, AWS::ECS::TaskDefinition task definitions.
	// Experimental.
	TaskDefinitions *[]*string `json:"taskDefinitions" yaml:"taskDefinitions"`
	// The logical IDs of the blue and green, respectively, AWS::ECS::TaskSet task sets.
	// Experimental.
	TaskSets *[]*string `json:"taskSets" yaml:"taskSets"`
	// The traffic routing configuration.
	// Experimental.
	TrafficRouting *CfnTrafficRouting `json:"trafficRouting" yaml:"trafficRouting"`
}

The attributes of the ECS Service being deployed.

Type of the {@link CfnCodeDeployBlueGreenApplication.ecsAttributes} property.

TODO: EXAMPLE

Experimental.

type CfnCodeDeployBlueGreenHook ¶ 

type CfnCodeDeployBlueGreenHook interface {
	CfnHook
	AdditionalOptions() *CfnCodeDeployBlueGreenAdditionalOptions
	SetAdditionalOptions(val *CfnCodeDeployBlueGreenAdditionalOptions)
	Applications() *[]*CfnCodeDeployBlueGreenApplication
	SetApplications(val *[]*CfnCodeDeployBlueGreenApplication)
	CreationStack() *[]*string
	LifecycleEventHooks() *CfnCodeDeployBlueGreenLifecycleEventHooks
	SetLifecycleEventHooks(val *CfnCodeDeployBlueGreenLifecycleEventHooks)
	LogicalId() *string
	Node() ConstructNode
	ServiceRole() *string
	SetServiceRole(val *string)
	Stack() Stack
	TrafficRoutingConfig() *CfnTrafficRoutingConfig
	SetTrafficRoutingConfig(val *CfnTrafficRoutingConfig)
	Type() *string
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(_props *map[string]interface{}) *map[string]interface{}
	Synthesize(session ISynthesisSession)
	ToString() *string
	Validate() *[]*string
}

A CloudFormation Hook for CodeDeploy blue-green ECS deployments.

TODO: EXAMPLE

See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/blue-green.html#blue-green-template-reference

Experimental.

func NewCfnCodeDeployBlueGreenHook ¶ 

func NewCfnCodeDeployBlueGreenHook(scope constructs.Construct, id *string, props *CfnCodeDeployBlueGreenHookProps) CfnCodeDeployBlueGreenHook

Creates a new CodeDeploy blue-green ECS Hook. Experimental.

type CfnCodeDeployBlueGreenHookProps ¶ 

type CfnCodeDeployBlueGreenHookProps struct {
	// Properties of the Amazon ECS applications being deployed.
	// Experimental.
	Applications *[]*CfnCodeDeployBlueGreenApplication `json:"applications" yaml:"applications"`
	// The IAM Role for CloudFormation to use to perform blue-green deployments.
	// Experimental.
	ServiceRole *string `json:"serviceRole" yaml:"serviceRole"`
	// Additional options for the blue/green deployment.
	// Experimental.
	AdditionalOptions *CfnCodeDeployBlueGreenAdditionalOptions `json:"additionalOptions" yaml:"additionalOptions"`
	// Use lifecycle event hooks to specify a Lambda function that CodeDeploy can call to validate a deployment.
	//
	// You can use the same function or a different one for deployment lifecycle events.
	// Following completion of the validation tests,
	// the Lambda {@link CfnCodeDeployBlueGreenLifecycleEventHooks.afterAllowTraffic}
	// function calls back CodeDeploy and delivers a result of 'Succeeded' or 'Failed'.
	// Experimental.
	LifecycleEventHooks *CfnCodeDeployBlueGreenLifecycleEventHooks `json:"lifecycleEventHooks" yaml:"lifecycleEventHooks"`
	// Traffic routing configuration settings.
	// Experimental.
	TrafficRoutingConfig *CfnTrafficRoutingConfig `json:"trafficRoutingConfig" yaml:"trafficRoutingConfig"`
}

Construction properties of {@link CfnCodeDeployBlueGreenHook}.

TODO: EXAMPLE

Experimental.

type CfnCodeDeployBlueGreenLifecycleEventHooks ¶ 

type CfnCodeDeployBlueGreenLifecycleEventHooks struct {
	// Function to use to run tasks after the test listener serves traffic to the replacement task set.
	// Experimental.
	AfterAllowTestTraffic *string `json:"afterAllowTestTraffic" yaml:"afterAllowTestTraffic"`
	// Function to use to run tasks after the second target group serves traffic to the replacement task set.
	// Experimental.
	AfterAllowTraffic *string `json:"afterAllowTraffic" yaml:"afterAllowTraffic"`
	// Function to use to run tasks after the replacement task set is created and one of the target groups is associated with it.
	// Experimental.
	AfterInstall *string `json:"afterInstall" yaml:"afterInstall"`
	// Function to use to run tasks after the second target group is associated with the replacement task set, but before traffic is shifted to the replacement task set.
	// Experimental.
	BeforeAllowTraffic *string `json:"beforeAllowTraffic" yaml:"beforeAllowTraffic"`
	// Function to use to run tasks before the replacement task set is created.
	// Experimental.
	BeforeInstall *string `json:"beforeInstall" yaml:"beforeInstall"`
}

Lifecycle events for blue-green deployments.

The type of the {@link CfnCodeDeployBlueGreenHookProps.lifecycleEventHooks} property.

TODO: EXAMPLE

Experimental.

type CfnCodeDeployLambdaAliasUpdate ¶ 

type CfnCodeDeployLambdaAliasUpdate struct {
	// The name of the AWS CodeDeploy application.
	// Experimental.
	ApplicationName *string `json:"applicationName" yaml:"applicationName"`
	// The name of the AWS CodeDeploy deployment group.
	//
	// This is where the traffic-shifting policy is set.
	// Experimental.
	DeploymentGroupName *string `json:"deploymentGroupName" yaml:"deploymentGroupName"`
	// The name of the Lambda function to run after traffic routing completes.
	// Experimental.
	AfterAllowTrafficHook *string `json:"afterAllowTrafficHook" yaml:"afterAllowTrafficHook"`
	// The name of the Lambda function to run before traffic routing starts.
	// Experimental.
	BeforeAllowTrafficHook *string `json:"beforeAllowTrafficHook" yaml:"beforeAllowTrafficHook"`
}

To perform an AWS CodeDeploy deployment when the version changes on an AWS::Lambda::Alias resource, use the CodeDeployLambdaAliasUpdate update policy.

TODO: EXAMPLE

Experimental.

type CfnCondition ¶ 

type CfnCondition interface {
	CfnElement
	ICfnConditionExpression
	IResolvable
	CreationStack() *[]*string
	Expression() ICfnConditionExpression
	SetExpression(val ICfnConditionExpression)
	LogicalId() *string
	Node() ConstructNode
	Stack() Stack
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	Resolve(_context IResolveContext) interface{}
	Synthesize(session ISynthesisSession)
	ToString() *string
	Validate() *[]*string
}

Represents a CloudFormation condition, for resources which must be conditionally created and the determination must be made at deploy time.

TODO: EXAMPLE

Experimental.

func NewCfnCondition ¶ 

func NewCfnCondition(scope constructs.Construct, id *string, props *CfnConditionProps) CfnCondition

Build a new condition.

The condition must be constructed with a condition token, that the condition is based on. Experimental.

type CfnConditionProps ¶ 

type CfnConditionProps struct {
	// The expression that the condition will evaluate.
	// Experimental.
	Expression ICfnConditionExpression `json:"expression" yaml:"expression"`
}

TODO: EXAMPLE

Experimental.

type CfnCreationPolicy ¶ 

type CfnCreationPolicy struct {
	// For an Auto Scaling group replacement update, specifies how many instances must signal success for the update to succeed.
	// Experimental.
	AutoScalingCreationPolicy *CfnResourceAutoScalingCreationPolicy `json:"autoScalingCreationPolicy" yaml:"autoScalingCreationPolicy"`
	// When AWS CloudFormation creates the associated resource, configures the number of required success signals and the length of time that AWS CloudFormation waits for those signals.
	// Experimental.
	ResourceSignal *CfnResourceSignal `json:"resourceSignal" yaml:"resourceSignal"`
}

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. AWS CloudFormation publishes valid signals to the stack events so that you track the number of signals sent.

The creation policy is invoked only when AWS CloudFormation creates the associated resource. Currently, the only AWS CloudFormation resources that support creation policies are AWS::AutoScaling::AutoScalingGroup, AWS::EC2::Instance, and AWS::CloudFormation::WaitCondition.

Use the CreationPolicy attribute when you want to wait on resource configuration actions before stack creation proceeds. For example, if you install and configure software applications on an EC2 instance, you might want those applications to be running before proceeding. In such cases, you can add a CreationPolicy attribute to the instance, and then send a success signal to the instance after the applications are installed and configured. For a detailed example, see Deploying Applications on Amazon EC2 with AWS CloudFormation.

TODO: EXAMPLE

Experimental.

type CfnCustomResource ¶ 

type CfnCustomResource interface {
	CfnResource
	IInspectable
	CfnOptions() ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	LogicalId() *string
	Node() ConstructNode
	Ref() *string
	ServiceToken() *string
	SetServiceToken(val *string)
	Stack() Stack
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy RemovalPolicy, options *RemovalPolicyOptions)
	GetAtt(attributeName *string) Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::CloudFormation::CustomResource`.

In a CloudFormation template, you use the `AWS::CloudFormation::CustomResource` or `Custom:: *String*` resource type to specify custom resources.

Custom resources provide a way for you to write custom provisioning logic in CloudFormation template and have CloudFormation run it during a stack operation, such as when you create, update or delete a stack. For more information, see [Custom resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-custom-resources.html) .

> If you use the [VPC endpoints](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-endpoints.html) feature, custom resources in the VPC must have access to CloudFormation -specific Amazon Simple Storage Service ( Amazon S3 ) buckets. Custom resources must send responses to a presigned Amazon S3 URL. If they can't send responses to Amazon S3 , CloudFormation won't receive a response and the stack operation fails. For more information, see [Setting up VPC endpoints for AWS CloudFormation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-vpce-bucketnames.html) .

TODO: EXAMPLE

func NewCfnCustomResource ¶ 

func NewCfnCustomResource(scope Construct, id *string, props *CfnCustomResourceProps) CfnCustomResource

Create a new `AWS::CloudFormation::CustomResource`.

type CfnCustomResourceProps ¶ 

type CfnCustomResourceProps struct {
	// > Only one property is defined by AWS for a custom resource: `ServiceToken` .
	//
	// All other properties are defined by the service provider.
	//
	// The service token that was given to the template developer by the service provider to access the service, such as an Amazon SNS topic ARN or Lambda function ARN. The service token must be from the same Region in which you are creating the stack.
	//
	// Updates aren't supported.
	ServiceToken *string `json:"serviceToken" yaml:"serviceToken"`
}

Properties for defining a `CfnCustomResource`.

TODO: EXAMPLE

type CfnDeletionPolicy ¶ 

type CfnDeletionPolicy string

With the DeletionPolicy attribute you can preserve or (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. Note that this capability also applies to update operations that lead to resources being removed. Experimental. 

const (
	CfnDeletionPolicy_DELETE   CfnDeletionPolicy = "DELETE"
	CfnDeletionPolicy_RETAIN   CfnDeletionPolicy = "RETAIN"
	CfnDeletionPolicy_SNAPSHOT CfnDeletionPolicy = "SNAPSHOT"
)

type CfnDynamicReference ¶ 

type CfnDynamicReference interface {
	Intrinsic
	CreationStack() *[]*string
	NewError(message *string) interface{}
	Resolve(_context IResolveContext) interface{}
	ToJSON() interface{}
	ToString() *string
}

References a dynamically retrieved value.

This is a Construct so that subclasses will (eventually) be able to attach metadata to themselves without having to change call signatures.

TODO: EXAMPLE

See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html

Experimental.

func NewCfnDynamicReference ¶ 

func NewCfnDynamicReference(service CfnDynamicReferenceService, key *string) CfnDynamicReference

Experimental.

type CfnDynamicReferenceProps ¶ 

type CfnDynamicReferenceProps struct {
	// The reference key of the dynamic reference.
	// Experimental.
	ReferenceKey *string `json:"referenceKey" yaml:"referenceKey"`
	// The service to retrieve the dynamic reference from.
	// Experimental.
	Service CfnDynamicReferenceService `json:"service" yaml:"service"`
}

Properties for a Dynamic Reference.

TODO: EXAMPLE

Experimental.

type CfnDynamicReferenceService ¶ 

type CfnDynamicReferenceService string

The service to retrieve the dynamic reference from. Experimental. 

const (
	CfnDynamicReferenceService_SSM             CfnDynamicReferenceService = "SSM"
	CfnDynamicReferenceService_SSM_SECURE      CfnDynamicReferenceService = "SSM_SECURE"
	CfnDynamicReferenceService_SECRETS_MANAGER CfnDynamicReferenceService = "SECRETS_MANAGER"
)

type CfnElement ¶ 

type CfnElement interface {
	Construct
	CreationStack() *[]*string
	LogicalId() *string
	Node() ConstructNode
	Stack() Stack
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	Synthesize(session ISynthesisSession)
	ToString() *string
	Validate() *[]*string
}

An element of a CloudFormation stack. Experimental.

type CfnHook ¶ 

type CfnHook interface {
	CfnElement
	CreationStack() *[]*string
	LogicalId() *string
	Node() ConstructNode
	Stack() Stack
	Type() *string
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	Synthesize(session ISynthesisSession)
	ToString() *string
	Validate() *[]*string
}

Represents a CloudFormation resource.

TODO: EXAMPLE

Experimental.

func NewCfnHook ¶ 

func NewCfnHook(scope constructs.Construct, id *string, props *CfnHookProps) CfnHook

Creates a new Hook object. Experimental.

type CfnHookDefaultVersion ¶ 

type CfnHookDefaultVersion interface {
	CfnResource
	IInspectable
	AttrArn() *string
	CfnOptions() ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	LogicalId() *string
	Node() ConstructNode
	Ref() *string
	Stack() Stack
	TypeName() *string
	SetTypeName(val *string)
	TypeVersionArn() *string
	SetTypeVersionArn(val *string)
	UpdatedProperites() *map[string]interface{}
	VersionId() *string
	SetVersionId(val *string)
	AddDeletionOverride(path *string)
	AddDependsOn(target CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy RemovalPolicy, options *RemovalPolicyOptions)
	GetAtt(attributeName *string) Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::CloudFormation::HookDefaultVersion`.

The `HookDefaultVersion` resource specifies the default version of the hook. The default version of the hook is used in CloudFormation operations for this AWS account and AWS Region .

TODO: EXAMPLE

func NewCfnHookDefaultVersion ¶ 

func NewCfnHookDefaultVersion(scope Construct, id *string, props *CfnHookDefaultVersionProps) CfnHookDefaultVersion

Create a new `AWS::CloudFormation::HookDefaultVersion`.

type CfnHookDefaultVersionProps ¶ 

type CfnHookDefaultVersionProps struct {
	// The name of the hook.
	//
	// You must specify either `TypeVersionArn` , or `TypeName` and `VersionId` .
	TypeName *string `json:"typeName" yaml:"typeName"`
	// The version ID of the type configuration.
	//
	// You must specify either `TypeVersionArn` , or `TypeName` and `VersionId` .
	TypeVersionArn *string `json:"typeVersionArn" yaml:"typeVersionArn"`
	// The version ID of the type specified.
	//
	// You must specify either `TypeVersionArn` , or `TypeName` and `VersionId` .
	VersionId *string `json:"versionId" yaml:"versionId"`
}

Properties for defining a `CfnHookDefaultVersion`.

TODO: EXAMPLE

type CfnHookProps ¶ 

type CfnHookProps struct {
	// The type of the hook (for example, "AWS::CodeDeploy::BlueGreen").
	// Experimental.
	Type *string `json:"type" yaml:"type"`
	// The properties of the hook.
	// Experimental.
	Properties *map[string]interface{} `json:"properties" yaml:"properties"`
}

Construction properties of {@link CfnHook}.

TODO: EXAMPLE

Experimental.

type CfnHookTypeConfig ¶ 

type CfnHookTypeConfig interface {
	CfnResource
	IInspectable
	AttrConfigurationArn() *string
	CfnOptions() ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	Configuration() *string
	SetConfiguration(val *string)
	ConfigurationAlias() *string
	SetConfigurationAlias(val *string)
	CreationStack() *[]*string
	LogicalId() *string
	Node() ConstructNode
	Ref() *string
	Stack() Stack
	TypeArn() *string
	SetTypeArn(val *string)
	TypeName() *string
	SetTypeName(val *string)
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy RemovalPolicy, options *RemovalPolicyOptions)
	GetAtt(attributeName *string) Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::CloudFormation::HookTypeConfig`.

The `HookTypeConfig` resource specifies the configuration of a hook.

TODO: EXAMPLE

func NewCfnHookTypeConfig ¶ 

func NewCfnHookTypeConfig(scope Construct, id *string, props *CfnHookTypeConfigProps) CfnHookTypeConfig

Create a new `AWS::CloudFormation::HookTypeConfig`.

type CfnHookTypeConfigProps ¶ 

type CfnHookTypeConfigProps struct {
	// Specifies the activated hook type configuration, in this AWS account and AWS Region .
	//
	// You must specify either `TypeName` and `Configuration` or `TypeARN` and `Configuration` .
	Configuration *string `json:"configuration" yaml:"configuration"`
	// Specifies the activated hook type configuration, in this AWS account and AWS Region .
	//
	// Defaults to `default` alias. Hook types currently support default configuration alias.
	ConfigurationAlias *string `json:"configurationAlias" yaml:"configurationAlias"`
	// The Amazon Resource Number (ARN) for the hook to set `Configuration` for.
	//
	// You must specify either `TypeName` and `Configuration` or `TypeARN` and `Configuration` .
	TypeArn *string `json:"typeArn" yaml:"typeArn"`
	// The unique name for your hook.
	//
	// Specifies a three-part namespace for your hook, with a recommended pattern of `Organization::Service::Hook` .
	//
	// You must specify either `TypeName` and `Configuration` or `TypeARN` and `Configuration` .
	TypeName *string `json:"typeName" yaml:"typeName"`
}

Properties for defining a `CfnHookTypeConfig`.

TODO: EXAMPLE

type CfnHookVersion ¶ 

type CfnHookVersion interface {
	CfnResource
	IInspectable
	AttrArn() *string
	AttrIsDefaultVersion() IResolvable
	AttrTypeArn() *string
	AttrVersionId() *string
	AttrVisibility() *string
	CfnOptions() ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	ExecutionRoleArn() *string
	SetExecutionRoleArn(val *string)
	LoggingConfig() interface{}
	SetLoggingConfig(val interface{})
	LogicalId() *string
	Node() ConstructNode
	Ref() *string
	SchemaHandlerPackage() *string
	SetSchemaHandlerPackage(val *string)
	Stack() Stack
	TypeName() *string
	SetTypeName(val *string)
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy RemovalPolicy, options *RemovalPolicyOptions)
	GetAtt(attributeName *string) Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::CloudFormation::HookVersion`.

The `HookVersion` resource publishes new or first hook version to the AWS CloudFormation registry.

TODO: EXAMPLE

func NewCfnHookVersion ¶ 

func NewCfnHookVersion(scope Construct, id *string, props *CfnHookVersionProps) CfnHookVersion

Create a new `AWS::CloudFormation::HookVersion`.

type CfnHookVersionProps ¶ 

type CfnHookVersionProps struct {
	// A URL to the Amazon S3 bucket containing the hook project package that contains the necessary files for the hook you want to register.
	//
	// For information on generating a schema handler package for the resource you want to register, see [submit](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-cli-submit.html) in the *CloudFormation CLI User Guide for Extension Development* .
	//
	// > The user registering the resource must be able to access the package in the S3 bucket. That's, the user must have [GetObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) permissions for the schema handler package. For more information, see [Actions, Resources, and Condition Keys for Amazon S3](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazons3.html) in the *AWS Identity and Access Management User Guide* .
	SchemaHandlerPackage *string `json:"schemaHandlerPackage" yaml:"schemaHandlerPackage"`
	// The unique name for your hook.
	//
	// Specifies a three-part namespace for your hook, with a recommended pattern of `Organization::Service::Hook` .
	//
	// > The following organization namespaces are reserved and can't be used in your hook type names:
	// >
	// > - `Alexa`
	// > - `AMZN`
	// > - `Amazon`
	// > - `ASK`
	// > - `AWS`
	// > - `Custom`
	// > - `Dev`
	TypeName *string `json:"typeName" yaml:"typeName"`
	// The Amazon Resource Name (ARN) of the task execution role that grants the hook permission.
	ExecutionRoleArn *string `json:"executionRoleArn" yaml:"executionRoleArn"`
	// Contains logging configuration information for an extension.
	LoggingConfig interface{} `json:"loggingConfig" yaml:"loggingConfig"`
}

Properties for defining a `CfnHookVersion`.

TODO: EXAMPLE

type CfnHookVersion_LoggingConfigProperty ¶ 

type CfnHookVersion_LoggingConfigProperty struct {
	// The Amazon CloudWatch Logs group to which CloudFormation sends error logging information when invoking the extension's handlers.
	LogGroupName *string `json:"logGroupName" yaml:"logGroupName"`
	// The Amazon Resource Name (ARN) of the role that CloudFormation should assume when sending log entries to CloudWatch Logs.
	LogRoleArn *string `json:"logRoleArn" yaml:"logRoleArn"`
}

The `LoggingConfig` property type specifies logging configuration information for an extension.

TODO: EXAMPLE

type CfnInclude deprecated 

type CfnInclude interface {
	CfnElement
	CreationStack() *[]*string
	LogicalId() *string
	Node() ConstructNode
	Stack() Stack
	Template() *map[string]interface{}
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	Synthesize(session ISynthesisSession)
	ToString() *string
	Validate() *[]*string
}

Includes a CloudFormation template into a stack.

All elements of the template will be merged into the current stack, together with any elements created programmatically.

TODO: EXAMPLE

Deprecated: use the CfnInclude class from the cloudformation-include module instead

func NewCfnInclude ¶ 

func NewCfnInclude(scope constructs.Construct, id *string, props *CfnIncludeProps) CfnInclude

Creates an adopted template construct.

The template will be incorporated into the stack as-is with no changes at all. This means that logical IDs of entities within this template may conflict with logical IDs of entities that are part of the stack. Deprecated: use the CfnInclude class from the cloudformation-include module instead

type CfnIncludeProps deprecated 

type CfnIncludeProps struct {
	// The CloudFormation template to include in the stack (as is).
	// Deprecated: use the CfnInclude class from the cloudformation-include module instead
	Template *map[string]interface{} `json:"template" yaml:"template"`
}

Construction properties for {@link CfnInclude}.

TODO: EXAMPLE

Deprecated: use the CfnInclude class from the cloudformation-include module instead

type CfnJson ¶ 

type CfnJson interface {
	Construct
	IResolvable
	CreationStack() *[]*string
	Node() ConstructNode
	Value() Reference
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	Prepare()
	Resolve(_arg IResolveContext) interface{}
	Synthesize(session ISynthesisSession)
	ToJSON() *string
	ToString() *string
	Validate() *[]*string
}

Captures a synthesis-time JSON object a CloudFormation reference which resolves during deployment to the resolved values of the JSON object.

The main use case for this is to overcome a limitation in CloudFormation that does not allow using intrinsic functions as dictionary keys (because dictionary keys in JSON must be strings). Specifically this is common in IAM conditions such as `StringEquals: { lhs: "rhs" }` where you want "lhs" to be a reference.

This object is resolvable, so it can be used as a value.

This construct is backed by a custom resource.

TODO: EXAMPLE

Experimental.

func NewCfnJson ¶ 

func NewCfnJson(scope constructs.Construct, id *string, props *CfnJsonProps) CfnJson

Experimental.

type CfnJsonProps ¶ 

type CfnJsonProps struct {
	// The value to resolve.
	//
	// Can be any JavaScript object, including tokens and
	// references in keys or values.
	// Experimental.
	Value interface{} `json:"value" yaml:"value"`
}

TODO: EXAMPLE

Experimental.

type CfnMacro ¶ 

type CfnMacro interface {
	CfnResource
	IInspectable
	CfnOptions() ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Description() *string
	SetDescription(val *string)
	FunctionName() *string
	SetFunctionName(val *string)
	LogGroupName() *string
	SetLogGroupName(val *string)
	LogicalId() *string
	LogRoleArn() *string
	SetLogRoleArn(val *string)
	Name() *string
	SetName(val *string)
	Node() ConstructNode
	Ref() *string
	Stack() Stack
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy RemovalPolicy, options *RemovalPolicyOptions)
	GetAtt(attributeName *string) Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::CloudFormation::Macro`.

The `AWS::CloudFormation::Macro` resource is a CloudFormation resource type that creates a CloudFormation macro to perform custom processing on CloudFormation templates. For more information, see [Using AWS CloudFormation macros to perform custom processing on templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html) .

TODO: EXAMPLE

func NewCfnMacro ¶ 

func NewCfnMacro(scope Construct, id *string, props *CfnMacroProps) CfnMacro

Create a new `AWS::CloudFormation::Macro`.

type CfnMacroProps ¶ 

type CfnMacroProps struct {
	// The Amazon Resource Name (ARN) of the underlying AWS Lambda function that you want AWS CloudFormation to invoke when the macro is run.
	FunctionName *string `json:"functionName" yaml:"functionName"`
	// The name of the macro.
	//
	// The name of the macro must be unique across all macros in the account.
	Name *string `json:"name" yaml:"name"`
	// A description of the macro.
	Description *string `json:"description" yaml:"description"`
	// The CloudWatch Logs group to which AWS CloudFormation sends error logging information when invoking the macro's underlying AWS Lambda function.
	LogGroupName *string `json:"logGroupName" yaml:"logGroupName"`
	// The ARN of the role AWS CloudFormation should assume when sending log entries to CloudWatch Logs .
	LogRoleArn *string `json:"logRoleArn" yaml:"logRoleArn"`
}

Properties for defining a `CfnMacro`.

TODO: EXAMPLE

type CfnMapping ¶ 

type CfnMapping interface {
	CfnRefElement
	CreationStack() *[]*string
	LogicalId() *string
	Node() ConstructNode
	Ref() *string
	Stack() Stack
	FindInMap(key1 *string, key2 *string) *string
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	SetValue(key1 *string, key2 *string, value interface{})
	Synthesize(session ISynthesisSession)
	ToString() *string
	Validate() *[]*string
}

Represents a CloudFormation mapping.

TODO: EXAMPLE

Experimental.

func NewCfnMapping ¶ 

func NewCfnMapping(scope constructs.Construct, id *string, props *CfnMappingProps) CfnMapping

Experimental.

type CfnMappingProps ¶ 

type CfnMappingProps struct {
	// Experimental.
	Lazy *bool `json:"lazy" yaml:"lazy"`
	// Mapping of key to a set of corresponding set of named values.
	//
	// The key identifies a map of name-value pairs and must be unique within the mapping.
	//
	// For example, if you want to set values based on a region, you can create a mapping
	// that uses the region name as a key and contains the values you want to specify for
	// each specific region.
	// Experimental.
	Mapping *map[string]*map[string]interface{} `json:"mapping" yaml:"mapping"`
}

TODO: EXAMPLE

Experimental.

type CfnModuleDefaultVersion ¶ 

type CfnModuleDefaultVersion interface {
	CfnResource
	IInspectable
	Arn() *string
	SetArn(val *string)
	CfnOptions() ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	LogicalId() *string
	ModuleName() *string
	SetModuleName(val *string)
	Node() ConstructNode
	Ref() *string
	Stack() Stack
	UpdatedProperites() *map[string]interface{}
	VersionId() *string
	SetVersionId(val *string)
	AddDeletionOverride(path *string)
	AddDependsOn(target CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy RemovalPolicy, options *RemovalPolicyOptions)
	GetAtt(attributeName *string) Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::CloudFormation::ModuleDefaultVersion`.

Specifies the default version of a module. The default version of the module will be used in CloudFormation operations for this account and Region.

To register a module version, use the `[AWS::CloudFormation::ModuleVersion](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduleversion.html)` resource.

For more information using modules, see [Using modules to encapsulate and reuse resource configurations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/modules.html) and [Registering extensions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html#registry-register) in the *CloudFormation User Guide* . For information on developing modules, see [Developing modules](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/modules.html) in the *CloudFormation CLI User Guide* .

TODO: EXAMPLE

func NewCfnModuleDefaultVersion ¶ 

func NewCfnModuleDefaultVersion(scope Construct, id *string, props *CfnModuleDefaultVersionProps) CfnModuleDefaultVersion

Create a new `AWS::CloudFormation::ModuleDefaultVersion`.

type CfnModuleDefaultVersionProps ¶ 

type CfnModuleDefaultVersionProps struct {
	// The Amazon Resource Name (ARN) of the module version to set as the default version.
	//
	// Conditional: You must specify either `Arn` , or `ModuleName` and `VersionId` .
	Arn *string `json:"arn" yaml:"arn"`
	// The name of the module.
	//
	// Conditional: You must specify either `Arn` , or `ModuleName` and `VersionId` .
	ModuleName *string `json:"moduleName" yaml:"moduleName"`
	// The ID for the specific version of the module.
	//
	// Conditional: You must specify either `Arn` , or `ModuleName` and `VersionId` .
	VersionId *string `json:"versionId" yaml:"versionId"`
}

Properties for defining a `CfnModuleDefaultVersion`.

TODO: EXAMPLE

type CfnModuleVersion ¶ 

type CfnModuleVersion interface {
	CfnResource
	IInspectable
	AttrArn() *string
	AttrDescription() *string
	AttrDocumentationUrl() *string
	AttrIsDefaultVersion() IResolvable
	AttrSchema() *string
	AttrTimeCreated() *string
	AttrVersionId() *string
	AttrVisibility() *string
	CfnOptions() ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	LogicalId() *string
	ModuleName() *string
	SetModuleName(val *string)
	ModulePackage() *string
	SetModulePackage(val *string)
	Node() ConstructNode
	Ref() *string
	Stack() Stack
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy RemovalPolicy, options *RemovalPolicyOptions)
	GetAtt(attributeName *string) Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::CloudFormation::ModuleVersion`.

Registers the specified version of the module with the CloudFormation service. Registering a module makes it available for use in CloudFormation templates in your AWS account and Region.

To specify a module version as the default version, use the `[AWS::CloudFormation::ModuleDefaultVersion](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduledefaultversion.html)` resource.

For more information using modules, see [Using modules to encapsulate and reuse resource configurations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/modules.html) and [Registering extensions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html#registry-register) in the *CloudFormation User Guide* . For information on developing modules, see [Developing modules](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/modules.html) in the *CloudFormation CLI User Guide* .

TODO: EXAMPLE

func NewCfnModuleVersion ¶ 

func NewCfnModuleVersion(scope Construct, id *string, props *CfnModuleVersionProps) CfnModuleVersion

Create a new `AWS::CloudFormation::ModuleVersion`.

type CfnModuleVersionProps ¶ 

type CfnModuleVersionProps struct {
	// The name of the module being registered.
	ModuleName *string `json:"moduleName" yaml:"moduleName"`
	// A URL to the S3 bucket containing the package that contains the template fragment and schema files for the module version to register.
	//
	// > The user registering the module version must be able to access the module package in the S3 bucket. That's, the user needs to have [GetObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) permissions for the package. For more information, see [Actions, Resources, and Condition Keys for Amazon S3](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazons3.html) in the *AWS Identity and Access Management User Guide* .
	ModulePackage *string `json:"modulePackage" yaml:"modulePackage"`
}

Properties for defining a `CfnModuleVersion`.

TODO: EXAMPLE

type CfnOutput ¶ 

type CfnOutput interface {
	CfnElement
	Condition() CfnCondition
	SetCondition(val CfnCondition)
	CreationStack() *[]*string
	Description() *string
	SetDescription(val *string)
	ExportName() *string
	SetExportName(val *string)
	ImportValue() *string
	LogicalId() *string
	Node() ConstructNode
	Stack() Stack
	Value() interface{}
	SetValue(val interface{})
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	Synthesize(session ISynthesisSession)
	ToString() *string
	Validate() *[]*string
}

TODO: EXAMPLE

Experimental.

func NewCfnOutput ¶ 

func NewCfnOutput(scope constructs.Construct, id *string, props *CfnOutputProps) CfnOutput

Creates an CfnOutput value for this stack. Experimental.

type CfnOutputProps ¶ 

type CfnOutputProps struct {
	// The value of the property returned by the aws cloudformation describe-stacks command.
	//
	// The value of an output can include literals, parameter references, pseudo-parameters,
	// a mapping value, or intrinsic functions.
	// Experimental.
	Value *string `json:"value" yaml:"value"`
	// A condition to associate with this output value.
	//
	// If the condition evaluates
	// to `false`, this output value will not be included in the stack.
	// Experimental.
	Condition CfnCondition `json:"condition" yaml:"condition"`
	// A String type that describes the output value.
	//
	// The description can be a maximum of 4 K in length.
	// Experimental.
	Description *string `json:"description" yaml:"description"`
	// The name used to export the value of this output across stacks.
	//
	// To import the value from another stack, use `Fn.importValue(exportName)`.
	// Experimental.
	ExportName *string `json:"exportName" yaml:"exportName"`
}

TODO: EXAMPLE

Experimental.

type CfnParameter ¶ 

type CfnParameter interface {
	CfnElement
	AllowedPattern() *string
	SetAllowedPattern(val *string)
	AllowedValues() *[]*string
	SetAllowedValues(val *[]*string)
	ConstraintDescription() *string
	SetConstraintDescription(val *string)
	CreationStack() *[]*string
	Default() interface{}
	SetDefault(val interface{})
	Description() *string
	SetDescription(val *string)
	LogicalId() *string
	MaxLength() *float64
	SetMaxLength(val *float64)
	MaxValue() *float64
	SetMaxValue(val *float64)
	MinLength() *float64
	SetMinLength(val *float64)
	MinValue() *float64
	SetMinValue(val *float64)
	Node() ConstructNode
	NoEcho() *bool
	SetNoEcho(val *bool)
	Stack() Stack
	Type() *string
	SetType(val *string)
	Value() IResolvable
	ValueAsList() *[]*string
	ValueAsNumber() *float64
	ValueAsString() *string
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	Resolve(_context IResolveContext) interface{}
	Synthesize(session ISynthesisSession)
	ToString() *string
	Validate() *[]*string
}

A CloudFormation parameter.

Use the optional Parameters section to customize your templates. Parameters enable you to input custom values to your template each time you create or update a stack.

TODO: EXAMPLE

Experimental.

func NewCfnParameter ¶ 

func NewCfnParameter(scope constructs.Construct, id *string, props *CfnParameterProps) CfnParameter

Creates a parameter construct.

Note that the name (logical ID) of the parameter will derive from it's `coname` and location within the stack. Therefore, it is recommended that parameters are defined at the stack level. Experimental.

type CfnParameterProps ¶ 

type CfnParameterProps struct {
	// A regular expression that represents the patterns to allow for String types.
	// Experimental.
	AllowedPattern *string `json:"allowedPattern" yaml:"allowedPattern"`
	// An array containing the list of values allowed for the parameter.
	// Experimental.
	AllowedValues *[]*string `json:"allowedValues" yaml:"allowedValues"`
	// A string that explains a constraint when the constraint is violated.
	//
	// For example, without a constraint description, a parameter that has an allowed
	// pattern of [A-Za-z0-9]+ displays the following error message when the user specifies
	// an invalid value:
	// Experimental.
	ConstraintDescription *string `json:"constraintDescription" yaml:"constraintDescription"`
	// A value of the appropriate type for the template to use if no value is specified when a stack is created.
	//
	// If you define constraints for the parameter, you must specify
	// a value that adheres to those constraints.
	// Experimental.
	Default interface{} `json:"default" yaml:"default"`
	// A string of up to 4000 characters that describes the parameter.
	// Experimental.
	Description *string `json:"description" yaml:"description"`
	// An integer value that determines the largest number of characters you want to allow for String types.
	// Experimental.
	MaxLength *float64 `json:"maxLength" yaml:"maxLength"`
	// A numeric value that determines the largest numeric value you want to allow for Number types.
	// Experimental.
	MaxValue *float64 `json:"maxValue" yaml:"maxValue"`
	// An integer value that determines the smallest number of characters you want to allow for String types.
	// Experimental.
	MinLength *float64 `json:"minLength" yaml:"minLength"`
	// A numeric value that determines the smallest numeric value you want to allow for Number types.
	// Experimental.
	MinValue *float64 `json:"minValue" yaml:"minValue"`
	// Whether to mask the parameter value when anyone makes a call that describes the stack.
	//
	// If you set the value to “true“, the parameter value is masked with asterisks (“*****“).
	// Experimental.
	NoEcho *bool `json:"noEcho" yaml:"noEcho"`
	// The data type for the parameter (DataType).
	// Experimental.
	Type *string `json:"type" yaml:"type"`
}

TODO: EXAMPLE

Experimental.

type CfnPublicTypeVersion ¶ 

type CfnPublicTypeVersion interface {
	CfnResource
	IInspectable
	Arn() *string
	SetArn(val *string)
	AttrPublicTypeArn() *string
	AttrPublisherId() *string
	AttrTypeVersionArn() *string
	CfnOptions() ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	LogDeliveryBucket() *string
	SetLogDeliveryBucket(val *string)
	LogicalId() *string
	Node() ConstructNode
	PublicVersionNumber() *string
	SetPublicVersionNumber(val *string)
	Ref() *string
	Stack() Stack
	Type() *string
	SetType(val *string)
	TypeName() *string
	SetTypeName(val *string)
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy RemovalPolicy, options *RemovalPolicyOptions)
	GetAtt(attributeName *string) Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::CloudFormation::PublicTypeVersion`.

Tests and publishes a registered extension as a public, third-party extension.

CloudFormation first tests the extension to make sure it meets all necessary requirements for being published in the CloudFormation registry. If it does, CloudFormation then publishes it to the registry as a public third-party extension in this Region. Public extensions are available for use by all CloudFormation users.

- For resource types, testing includes passing all contracts tests defined for the type. - For modules, testing includes determining if the module's model meets all necessary requirements.

For more information, see [Testing your public extension prior to publishing](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html#publish-extension-testing) in the *CloudFormation CLI User Guide* .

If you don't specify a version, CloudFormation uses the default version of the extension in your account and Region for testing.

To perform testing, CloudFormation assumes the execution role specified when the type was registered.

An extension must have a test status of `PASSED` before it can be published. For more information, see [Publishing extensions to make them available for public use](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-publish.html) in the *CloudFormation CLI User Guide* .

TODO: EXAMPLE

func NewCfnPublicTypeVersion ¶ 

func NewCfnPublicTypeVersion(scope Construct, id *string, props *CfnPublicTypeVersionProps) CfnPublicTypeVersion

Create a new `AWS::CloudFormation::PublicTypeVersion`.

type CfnPublicTypeVersionProps ¶ 

type CfnPublicTypeVersionProps struct {
	// The Amazon Resource Number (ARN) of the extension.
	//
	// Conditional: You must specify `Arn` , or `TypeName` and `Type` .
	Arn *string `json:"arn" yaml:"arn"`
	// The S3 bucket to which CloudFormation delivers the contract test execution logs.
	//
	// CloudFormation delivers the logs by the time contract testing has completed and the extension has been assigned a test type status of `PASSED` or `FAILED` .
	//
	// The user initiating the stack operation must be able to access items in the specified S3 bucket. Specifically, the user needs the following permissions:
	//
	// - GetObject
	// - PutObject
	//
	// For more information, see [Actions, Resources, and Condition Keys for Amazon S3](https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazons3.html) in the *AWS Identity and Access Management User Guide* .
	LogDeliveryBucket *string `json:"logDeliveryBucket" yaml:"logDeliveryBucket"`
	// The version number to assign to this version of the extension.
	//
	// Use the following format, and adhere to semantic versioning when assigning a version number to your extension:
	//
	// `MAJOR.MINOR.PATCH`
	//
	// For more information, see [Semantic Versioning 2.0.0](https://docs.aws.amazon.com/https://semver.org/) .
	//
	// If you don't specify a version number, CloudFormation increments the version number by one minor version release.
	//
	// You cannot specify a version number the first time you publish a type. AWS CloudFormation automatically sets the first version number to be `1.0.0` .
	PublicVersionNumber *string `json:"publicVersionNumber" yaml:"publicVersionNumber"`
	// The type of the extension to test.
	//
	// Conditional: You must specify `Arn` , or `TypeName` and `Type` .
	Type *string `json:"type" yaml:"type"`
	// The name of the extension to test.
	//
	// Conditional: You must specify `Arn` , or `TypeName` and `Type` .
	TypeName *string `json:"typeName" yaml:"typeName"`
}

Properties for defining a `CfnPublicTypeVersion`.

TODO: EXAMPLE

type CfnPublisher ¶ 

type CfnPublisher interface {
	CfnResource
	IInspectable
	AcceptTermsAndConditions() interface{}
	SetAcceptTermsAndConditions(val interface{})
	AttrIdentityProvider() *string
	AttrPublisherId() *string
	AttrPublisherProfile() *string
	AttrPublisherStatus() *string
	CfnOptions() ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	ConnectionArn() *string
	SetConnectionArn(val *string)
	CreationStack() *[]*string
	LogicalId() *string
	Node() ConstructNode
	Ref() *string
	Stack() Stack
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy RemovalPolicy, options *RemovalPolicyOptions)
	GetAtt(attributeName *string) Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::CloudFormation::Publisher`.

Registers your account as a publisher of public extensions in the CloudFormation registry. Public extensions are available for use by all CloudFormation users.

For information on requirements for registering as a public extension publisher, see [Registering your account to publish CloudFormation extensions](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html#publish-extension-prereqs) in the *CloudFormation CLI User Guide* .

TODO: EXAMPLE

func NewCfnPublisher ¶ 

func NewCfnPublisher(scope Construct, id *string, props *CfnPublisherProps) CfnPublisher

Create a new `AWS::CloudFormation::Publisher`.

type CfnPublisherProps ¶ 

type CfnPublisherProps struct {
	// Whether you accept the [Terms and Conditions](https://docs.aws.amazon.com/https://cloudformation-registry-documents.s3.amazonaws.com/Terms_and_Conditions_for_AWS_CloudFormation_Registry_Publishers.pdf) for publishing extensions in the CloudFormation registry. You must accept the terms and conditions in order to register to publish public extensions to the CloudFormation registry.
	//
	// The default is `false` .
	AcceptTermsAndConditions interface{} `json:"acceptTermsAndConditions" yaml:"acceptTermsAndConditions"`
	// If you are using a Bitbucket or GitHub account for identity verification, the Amazon Resource Name (ARN) for your connection to that account.
	//
	// For more information, see [Registering your account to publish CloudFormation extensions](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html#publish-extension-prereqs) in the *CloudFormation CLI User Guide* .
	ConnectionArn *string `json:"connectionArn" yaml:"connectionArn"`
}

Properties for defining a `CfnPublisher`.

TODO: EXAMPLE

type CfnRefElement ¶ 

type CfnRefElement interface {
	CfnElement
	CreationStack() *[]*string
	LogicalId() *string
	Node() ConstructNode
	Ref() *string
	Stack() Stack
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	Synthesize(session ISynthesisSession)
	ToString() *string
	Validate() *[]*string
}

Base class for referenceable CloudFormation constructs which are not Resources.

These constructs are things like Conditions and Parameters, can be referenced by taking the `.ref` attribute.

Resource constructs do not inherit from CfnRefElement because they have their own, more specific types returned from the .ref attribute. Also, some resources aren't referenceable at all (such as BucketPolicies or GatewayAttachments). Experimental.

type CfnResource ¶ 

type CfnResource interface {
	CfnRefElement
	CfnOptions() ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	LogicalId() *string
	Node() ConstructNode
	Ref() *string
	Stack() Stack
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy RemovalPolicy, options *RemovalPolicyOptions)
	GetAtt(attributeName *string) Reference
	GetMetadata(key *string) interface{}
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

Represents a CloudFormation resource.

TODO: EXAMPLE

Experimental.

func NewCfnResource ¶ 

func NewCfnResource(scope constructs.Construct, id *string, props *CfnResourceProps) CfnResource

Creates a resource construct. Experimental.

type CfnResourceAutoScalingCreationPolicy ¶ 

type CfnResourceAutoScalingCreationPolicy struct {
	// Specifies the percentage of instances in an Auto Scaling replacement update that must signal success for the update to succeed.
	//
	// You can specify a value from 0 to 100. AWS CloudFormation rounds to the nearest tenth of a percent.
	// For example, if you update five instances with a minimum successful percentage of 50, three instances must signal success.
	// If an instance doesn't send a signal within the time specified by the Timeout property, AWS CloudFormation assumes that the
	// instance wasn't created.
	// Experimental.
	MinSuccessfulInstancesPercent *float64 `json:"minSuccessfulInstancesPercent" yaml:"minSuccessfulInstancesPercent"`
}

For an Auto Scaling group replacement update, specifies how many instances must signal success for the update to succeed.

TODO: EXAMPLE

Experimental.

type CfnResourceDefaultVersion ¶ 

type CfnResourceDefaultVersion interface {
	CfnResource
	IInspectable
	AttrArn() *string
	CfnOptions() ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	LogicalId() *string
	Node() ConstructNode
	Ref() *string
	Stack() Stack
	TypeName() *string
	SetTypeName(val *string)
	TypeVersionArn() *string
	SetTypeVersionArn(val *string)
	UpdatedProperites() *map[string]interface{}
	VersionId() *string
	SetVersionId(val *string)
	AddDeletionOverride(path *string)
	AddDependsOn(target CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy RemovalPolicy, options *RemovalPolicyOptions)
	GetAtt(attributeName *string) Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::CloudFormation::ResourceDefaultVersion`.

Specifies the default version of a resource. The default version of a resource will be used in CloudFormation operations.

TODO: EXAMPLE

func NewCfnResourceDefaultVersion ¶ 

func NewCfnResourceDefaultVersion(scope Construct, id *string, props *CfnResourceDefaultVersionProps) CfnResourceDefaultVersion

Create a new `AWS::CloudFormation::ResourceDefaultVersion`.

type CfnResourceDefaultVersionProps ¶ 

type CfnResourceDefaultVersionProps struct {
	// The name of the resource.
	//
	// Conditional: You must specify either `TypeVersionArn` , or `TypeName` and `VersionId` .
	TypeName *string `json:"typeName" yaml:"typeName"`
	// The Amazon Resource Name (ARN) of the resource version.
	//
	// Conditional: You must specify either `TypeVersionArn` , or `TypeName` and `VersionId` .
	TypeVersionArn *string `json:"typeVersionArn" yaml:"typeVersionArn"`
	// The ID of a specific version of the resource.
	//
	// The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the resource version when it's registered.
	//
	// Conditional: You must specify either `TypeVersionArn` , or `TypeName` and `VersionId` .
	VersionId *string `json:"versionId" yaml:"versionId"`
}

Properties for defining a `CfnResourceDefaultVersion`.

TODO: EXAMPLE

type CfnResourceProps ¶ 

type CfnResourceProps struct {
	// CloudFormation resource type (e.g. `AWS::S3::Bucket`).
	// Experimental.
	Type *string `json:"type" yaml:"type"`
	// Resource properties.
	// Experimental.
	Properties *map[string]interface{} `json:"properties" yaml:"properties"`
}

TODO: EXAMPLE

Experimental.

type CfnResourceSignal ¶ 

type CfnResourceSignal struct {
	// The number of success signals AWS CloudFormation must receive before it sets the resource status as CREATE_COMPLETE.
	//
	// If the resource receives a failure signal or doesn't receive the specified number of signals before the timeout period
	// expires, the resource creation fails and AWS CloudFormation rolls the stack back.
	// Experimental.
	Count *float64 `json:"count" yaml:"count"`
	// The length of time that AWS CloudFormation waits for the number of signals that was specified in the Count property.
	//
	// The timeout period starts after AWS CloudFormation starts creating the resource, and the timeout expires no sooner
	// than the time you specify but can occur shortly thereafter. The maximum time that you can specify is 12 hours.
	// Experimental.
	Timeout *string `json:"timeout" yaml:"timeout"`
}

When AWS CloudFormation creates the associated resource, configures the number of required success signals and the length of time that AWS CloudFormation waits for those signals.

TODO: EXAMPLE

Experimental.

type CfnResourceVersion ¶ 

type CfnResourceVersion interface {
	CfnResource
	IInspectable
	AttrArn() *string
	AttrIsDefaultVersion() IResolvable
	AttrProvisioningType() *string
	AttrTypeArn() *string
	AttrVersionId() *string
	AttrVisibility() *string
	CfnOptions() ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	ExecutionRoleArn() *string
	SetExecutionRoleArn(val *string)
	LoggingConfig() interface{}
	SetLoggingConfig(val interface{})
	LogicalId() *string
	Node() ConstructNode
	Ref() *string
	SchemaHandlerPackage() *string
	SetSchemaHandlerPackage(val *string)
	Stack() Stack
	TypeName() *string
	SetTypeName(val *string)
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy RemovalPolicy, options *RemovalPolicyOptions)
	GetAtt(attributeName *string) Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::CloudFormation::ResourceVersion`.

Registers a resource version with the CloudFormation service. Registering a resource version makes it available for use in CloudFormation templates in your AWS account , and includes:

- Validating the resource schema. - Determining which handlers, if any, have been specified for the resource. - Making the resource available for use in your account.

For more information on how to develop resources and ready them for registration, see [Creating Resource Providers](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-types.html) in the *CloudFormation CLI User Guide* .

You can have a maximum of 50 resource versions registered at a time. This maximum is per account and per Region.

TODO: EXAMPLE

func NewCfnResourceVersion ¶ 

func NewCfnResourceVersion(scope Construct, id *string, props *CfnResourceVersionProps) CfnResourceVersion

Create a new `AWS::CloudFormation::ResourceVersion`.

type CfnResourceVersionProps ¶ 

type CfnResourceVersionProps struct {
	// A URL to the S3 bucket containing the resource project package that contains the necessary files for the resource you want to register.
	//
	// For information on generating a schema handler package for the resource you want to register, see [submit](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-cli-submit.html) in the *CloudFormation CLI User Guide* .
	//
	// > The user registering the resource must be able to access the package in the S3 bucket. That is, the user needs to have [GetObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) permissions for the schema handler package. For more information, see [Actions, Resources, and Condition Keys for Amazon S3](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazons3.html) in the *AWS Identity and Access Management User Guide* .
	SchemaHandlerPackage *string `json:"schemaHandlerPackage" yaml:"schemaHandlerPackage"`
	// The name of the resource being registered.
	//
	// We recommend that resource names adhere to the following pattern: *company_or_organization* :: *service* :: *type* .
	//
	// > The following organization namespaces are reserved and can't be used in your resource names:
	// >
	// > - `Alexa`
	// > - `AMZN`
	// > - `Amazon`
	// > - `AWS`
	// > - `Custom`
	// > - `Dev`
	TypeName *string `json:"typeName" yaml:"typeName"`
	// The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the resource.
	//
	// If your resource calls AWS APIs in any of its handlers, you must create an *[IAM execution role](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html)* that includes the necessary permissions to call those AWS APIs, and provision that execution role in your account. When CloudFormation needs to invoke the resource type handler, CloudFormation assumes this execution role to create a temporary session token, which it then passes to the resource type handler, thereby supplying your resource type with the appropriate credentials.
	ExecutionRoleArn *string `json:"executionRoleArn" yaml:"executionRoleArn"`
	// Logging configuration information for a resource.
	LoggingConfig interface{} `json:"loggingConfig" yaml:"loggingConfig"`
}

Properties for defining a `CfnResourceVersion`.

TODO: EXAMPLE

type CfnResourceVersion_LoggingConfigProperty ¶ 

type CfnResourceVersion_LoggingConfigProperty struct {
	// The Amazon CloudWatch log group to which CloudFormation sends error logging information when invoking the type's handlers.
	LogGroupName *string `json:"logGroupName" yaml:"logGroupName"`
	// The ARN of the role that CloudFormation should assume when sending log entries to CloudWatch logs.
	LogRoleArn *string `json:"logRoleArn" yaml:"logRoleArn"`
}

Logging configuration information for a resource.

TODO: EXAMPLE

type CfnRule ¶ 

type CfnRule interface {
	CfnRefElement
	CreationStack() *[]*string
	LogicalId() *string
	Node() ConstructNode
	Ref() *string
	Stack() Stack
	AddAssertion(condition ICfnConditionExpression, description *string)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	Synthesize(session ISynthesisSession)
	ToString() *string
	Validate() *[]*string
}

The Rules that define template constraints in an AWS Service Catalog portfolio describe when end users can use the template and which values they can specify for parameters that are declared in the AWS CloudFormation template used to create the product they are attempting to use.

Rules are useful for preventing end users from inadvertently specifying an incorrect value. For example, you can add a rule to verify whether end users specified a valid subnet in a given VPC or used m1.small instance types for test environments. AWS CloudFormation uses rules to validate parameter values before it creates the resources for the product.

A rule can include a RuleCondition property and must include an Assertions property. For each rule, you can define only one rule condition; you can define one or more asserts within the Assertions property. You define a rule condition and assertions by using rule-specific intrinsic functions.

TODO: EXAMPLE

Experimental.

func NewCfnRule ¶ 

func NewCfnRule(scope constructs.Construct, id *string, props *CfnRuleProps) CfnRule

Creates and adds a rule. Experimental.

type CfnRuleAssertion ¶ 

type CfnRuleAssertion struct {
	// The assertion.
	// Experimental.
	Assert ICfnConditionExpression `json:"assert" yaml:"assert"`
	// The assertion description.
	// Experimental.
	AssertDescription *string `json:"assertDescription" yaml:"assertDescription"`
}

A rule assertion.

TODO: EXAMPLE

Experimental.

type CfnRuleProps ¶ 

type CfnRuleProps struct {
	// Assertions which define the rule.
	// Experimental.
	Assertions *[]*CfnRuleAssertion `json:"assertions" yaml:"assertions"`
	// If the rule condition evaluates to false, the rule doesn't take effect.
	//
	// If the function in the rule condition evaluates to true, expressions in each assert are evaluated and applied.
	// Experimental.
	RuleCondition ICfnConditionExpression `json:"ruleCondition" yaml:"ruleCondition"`
}

A rule can include a RuleCondition property and must include an Assertions property.

For each rule, you can define only one rule condition; you can define one or more asserts within the Assertions property. You define a rule condition and assertions by using rule-specific intrinsic functions.

You can use the following rule-specific intrinsic functions to define rule conditions and assertions: 

Fn::And
Fn::Contains
Fn::EachMemberEquals
Fn::EachMemberIn
Fn::Equals
Fn::If
Fn::Not
Fn::Or
Fn::RefAll
Fn::ValueOf
Fn::ValueOfAll

https://docs.aws.amazon.com/servicecatalog/latest/adminguide/reference-template_constraint_rules.html

TODO: EXAMPLE

Experimental.

type CfnStack ¶ 

type CfnStack interface {
	CfnResource
	IInspectable
	CfnOptions() ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	LogicalId() *string
	Node() ConstructNode
	NotificationArns() *[]*string
	SetNotificationArns(val *[]*string)
	Parameters() interface{}
	SetParameters(val interface{})
	Ref() *string
	Stack() Stack
	Tags() TagManager
	TemplateUrl() *string
	SetTemplateUrl(val *string)
	TimeoutInMinutes() *float64
	SetTimeoutInMinutes(val *float64)
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy RemovalPolicy, options *RemovalPolicyOptions)
	GetAtt(attributeName *string) Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::CloudFormation::Stack`.

The `AWS::CloudFormation::Stack` resource nests a stack as a resource in a top-level template.

You can add output values from a nested stack within the containing template. You use the [GetAtt](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html) function with the nested stack's logical name and the name of the output value in the nested stack in the format `Outputs. *NestedStackOutputName*` .

> We strongly recommend that updates to nested stacks are run from the parent stack.

When you apply template changes to update a top-level stack, CloudFormation updates the top-level stack and initiates an update to its nested stacks. CloudFormation updates the resources of modified nested stacks, but doesn't update the resources of unmodified nested stacks. For more information, see [CloudFormation stack updates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html) .

> You must acknowledge IAM capabilities for nested stacks that contain IAM resources. Also, verify that you have cancel update stack permissions, which is required if an update rolls back. For more information about IAM and CloudFormation , see [Controlling access with AWS Identity and Access Management](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html) .

TODO: EXAMPLE

func NewCfnStack ¶ 

func NewCfnStack(scope Construct, id *string, props *CfnStackProps) CfnStack

Create a new `AWS::CloudFormation::Stack`.

type CfnStackProps ¶ 

type CfnStackProps struct {
	// Location of file containing the template body.
	//
	// The URL must point to a template (max size: 460,800 bytes) that's located in an Amazon S3 bucket. For more information, see [Template anatomy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) .
	//
	// Whether an update causes interruptions depends on the resources that are being updated. An update never causes a nested stack to be replaced.
	TemplateUrl *string `json:"templateUrl" yaml:"templateUrl"`
	// The Amazon Simple Notification Service (Amazon SNS) topic ARNs to publish stack related events.
	//
	// You can find your Amazon SNS topic ARNs using the Amazon SNS console or your Command Line Interface (CLI).
	NotificationArns *[]*string `json:"notificationArns" yaml:"notificationArns"`
	// The set value pairs that represent the parameters passed to CloudFormation when this nested stack is created.
	//
	// Each parameter has a name corresponding to a parameter defined in the embedded template and a value representing the value that you want to set for the parameter.
	//
	// > If you use the `Ref` function to pass a parameter value to a nested stack, comma-delimited list parameters must be of type `String` . In other words, you can't pass values that are of type `CommaDelimitedList` to nested stacks.
	//
	// Conditional. Required if the nested stack requires input parameters.
	//
	// Whether an update causes interruptions depends on the resources that are being updated. An update never causes a nested stack to be replaced.
	Parameters interface{} `json:"parameters" yaml:"parameters"`
	// Key-value pairs to associate with this stack.
	//
	// AWS CloudFormation also propagates these tags to the resources created in the stack. A maximum number of 50 tags can be specified.
	Tags *[]*CfnTag `json:"tags" yaml:"tags"`
	// The length of time, in minutes, that CloudFormation waits for the nested stack to reach the `CREATE_COMPLETE` state.
	//
	// The default is no timeout. When CloudFormation detects that the nested stack has reached the `CREATE_COMPLETE` state, it marks the nested stack resource as `CREATE_COMPLETE` in the parent stack and resumes creating the parent stack. If the timeout period expires before the nested stack reaches `CREATE_COMPLETE` , CloudFormation marks the nested stack as failed and rolls back both the nested stack and parent stack.
	//
	// Updates aren't supported.
	TimeoutInMinutes *float64 `json:"timeoutInMinutes" yaml:"timeoutInMinutes"`
}

Properties for defining a `CfnStack`.

TODO: EXAMPLE

type CfnStackSet ¶ 

type CfnStackSet interface {
	CfnResource
	IInspectable
	AdministrationRoleArn() *string
	SetAdministrationRoleArn(val *string)
	AttrStackSetId() *string
	AutoDeployment() interface{}
	SetAutoDeployment(val interface{})
	CallAs() *string
	SetCallAs(val *string)
	Capabilities() *[]*string
	SetCapabilities(val *[]*string)
	CfnOptions() ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Description() *string
	SetDescription(val *string)
	ExecutionRoleName() *string
	SetExecutionRoleName(val *string)
	LogicalId() *string
	ManagedExecution() interface{}
	SetManagedExecution(val interface{})
	Node() ConstructNode
	OperationPreferences() interface{}
	SetOperationPreferences(val interface{})
	Parameters() interface{}
	SetParameters(val interface{})
	PermissionModel() *string
	SetPermissionModel(val *string)
	Ref() *string
	Stack() Stack
	StackInstancesGroup() interface{}
	SetStackInstancesGroup(val interface{})
	StackSetName() *string
	SetStackSetName(val *string)
	Tags() TagManager
	TemplateBody() *string
	SetTemplateBody(val *string)
	TemplateUrl() *string
	SetTemplateUrl(val *string)
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy RemovalPolicy, options *RemovalPolicyOptions)
	GetAtt(attributeName *string) Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::CloudFormation::StackSet`.

The `AWS::CloudFormation::StackSet` enables you to provision stacks into AWS accounts and across Regions by using a single CloudFormation template. In the stack set, you specify the template to use, in addition to any parameters and capabilities that the template requires.

TODO: EXAMPLE

func NewCfnStackSet ¶ 

func NewCfnStackSet(scope Construct, id *string, props *CfnStackSetProps) CfnStackSet

Create a new `AWS::CloudFormation::StackSet`.

type CfnStackSetProps ¶ 

type CfnStackSetProps struct {
	// Describes how the IAM roles required for stack set operations are created.
	//
	// - With `SELF_MANAGED` permissions, you must create the administrator and execution roles required to deploy to target accounts. For more information, see [Grant Self-Managed Stack Set Permissions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html) .
	// - With `SERVICE_MANAGED` permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by AWS Organizations . For more information, see [Grant Service-Managed Stack Set Permissions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-service-managed.html) .
	//
	// *Allowed Values* : `SERVICE_MANAGED` | `SELF_MANAGED`
	//
	// > The `PermissionModel` property is required.
	PermissionModel *string `json:"permissionModel" yaml:"permissionModel"`
	// The name to associate with the stack set.
	//
	// The name must be unique in the Region where you create your stack set.
	//
	// *Maximum* : `128`
	//
	// *Pattern* : `^[a-zA-Z][a-zA-Z0-9-]{0,127}$`
	//
	// > The `StackSetName` property is required.
	StackSetName *string `json:"stackSetName" yaml:"stackSetName"`
	// The Amazon Resource Number (ARN) of the IAM role to use to create this stack set.
	//
	// Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account.
	//
	// Use customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see [Prerequisites: Granting Permissions for Stack Set Operations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html) in the *AWS CloudFormation User Guide* .
	//
	// *Minimum* : `20`
	//
	// *Maximum* : `2048`
	AdministrationRoleArn *string `json:"administrationRoleArn" yaml:"administrationRoleArn"`
	// [ `Service-managed` permissions] Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU).
	AutoDeployment interface{} `json:"autoDeployment" yaml:"autoDeployment"`
	// [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.
	//
	// By default, `SELF` is specified. Use `SELF` for stack sets with self-managed permissions.
	//
	// - To create a stack set with service-managed permissions while signed in to the management account, specify `SELF` .
	// - To create a stack set with service-managed permissions while signed in to a delegated administrator account, specify `DELEGATED_ADMIN` .
	//
	// Your AWS account must be registered as a delegated admin in the management account. For more information, see [Register a delegated administrator](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) in the *AWS CloudFormation User Guide* .
	//
	// Stack sets with service-managed permissions are created in the management account, including stack sets that are created by delegated administrators.
	//
	// *Valid Values* : `SELF` | `DELEGATED_ADMIN`
	CallAs *string `json:"callAs" yaml:"callAs"`
	// The capabilities that are allowed in the stack set.
	//
	// Some stack set templates might include resources that can affect permissions in your AWS account —for example, by creating new AWS Identity and Access Management ( IAM ) users. For more information, see [Acknowledging IAM Resources in AWS CloudFormation Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities) .
	Capabilities *[]*string `json:"capabilities" yaml:"capabilities"`
	// A description of the stack set.
	//
	// *Minimum* : `1`
	//
	// *Maximum* : `1024`
	Description *string `json:"description" yaml:"description"`
	// The name of the IAM execution role to use to create the stack set.
	//
	// If you don't specify an execution role, AWS CloudFormation uses the `AWSCloudFormationStackSetExecutionRole` role for the stack set operation.
	//
	// *Minimum* : `1`
	//
	// *Maximum* : `64`
	//
	// *Pattern* : `[a-zA-Z_0-9+=,.@-]+`
	ExecutionRoleName *string `json:"executionRoleName" yaml:"executionRoleName"`
	// Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.
	//
	// When active, StackSets performs non-conflicting operations concurrently and queues conflicting operations. After conflicting operations finish, StackSets starts queued operations in request order.
	//
	// > If there are already running or queued operations, StackSets queues all incoming operations even if they are non-conflicting.
	// >
	// > You can't modify your stack set's execution configuration while there are running or queued operations for that stack set.
	//
	// When inactive (default), StackSets performs one operation at a time in request order.
	ManagedExecution interface{} `json:"managedExecution" yaml:"managedExecution"`
	// The user-specified preferences for how AWS CloudFormation performs a stack set operation.
	OperationPreferences interface{} `json:"operationPreferences" yaml:"operationPreferences"`
	// The input parameters for the stack set template.
	Parameters interface{} `json:"parameters" yaml:"parameters"`
	// A group of stack instances with parameters in some specific accounts and Regions.
	StackInstancesGroup interface{} `json:"stackInstancesGroup" yaml:"stackInstancesGroup"`
	// The key-value pairs to associate with this stack set and the stacks created from it.
	//
	// AWS CloudFormation also propagates these tags to supported resources that are created in the stacks. A maximum number of 50 tags can be specified.
	Tags *[]*CfnTag `json:"tags" yaml:"tags"`
	// The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes.
	//
	// You must include either `TemplateURL` or `TemplateBody` in a StackSet, but you can't use both. Dynamic references in the `TemplateBody` may not work correctly in all cases. It's recommended to pass templates containing dynamic references through `TemplateUrl` instead.
	//
	// *Minimum* : `1`
	//
	// *Maximum* : `51200`
	TemplateBody *string `json:"templateBody" yaml:"templateBody"`
	// Location of file containing the template body.
	//
	// The URL must point to a template (max size: 460,800 bytes) that's located in an Amazon S3 bucket.
	//
	// You must include either `TemplateURL` or `TemplateBody` in a StackSet, but you can't use both.
	//
	// *Minimum* : `1`
	//
	// *Maximum* : `1024`
	TemplateUrl *string `json:"templateUrl" yaml:"templateUrl"`
}

Properties for defining a `CfnStackSet`.

TODO: EXAMPLE

type CfnStackSet_AutoDeploymentProperty ¶ 

type CfnStackSet_AutoDeploymentProperty struct {
	// If set to `true` , StackSets automatically deploys additional stack instances to AWS Organizations accounts that are added to a target organization or organizational unit (OU) in the specified Regions.
	//
	// If an account is removed from a target organization or OU, StackSets deletes stack instances from the account in the specified Regions.
	Enabled interface{} `json:"enabled" yaml:"enabled"`
	// If set to `true` , stack resources are retained when an account is removed from a target organization or OU.
	//
	// If set to `false` , stack resources are deleted. Specify only if `Enabled` is set to `True` .
	RetainStacksOnAccountRemoval interface{} `json:"retainStacksOnAccountRemoval" yaml:"retainStacksOnAccountRemoval"`
}

[ `Service-managed` permissions] Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organizational unit (OU).

TODO: EXAMPLE

type CfnStackSet_DeploymentTargetsProperty ¶ 

type CfnStackSet_DeploymentTargetsProperty struct {
	// The names of one or more AWS accounts for which you want to deploy stack set updates.
	//
	// *Pattern* : `^[0-9]{12}$`
	Accounts *[]*string `json:"accounts" yaml:"accounts"`
	// The organization root ID or organizational unit (OU) IDs to which StackSets deploys.
	//
	// *Pattern* : `^(ou-[a-z0-9]{4,32}-[a-z0-9]{8,32}|r-[a-z0-9]{4,32})$`
	OrganizationalUnitIds *[]*string `json:"organizationalUnitIds" yaml:"organizationalUnitIds"`
}

The AWS OrganizationalUnitIds or Accounts for which to create stack instances in the specified Regions.

TODO: EXAMPLE

type CfnStackSet_OperationPreferencesProperty ¶ 

type CfnStackSet_OperationPreferencesProperty struct {
	// The number of accounts, per Region, for which this operation can fail before AWS CloudFormation stops the operation in that Region.
	//
	// If the operation is stopped in a Region, AWS CloudFormation doesn't attempt the operation in any subsequent Regions.
	//
	// Conditional: You must specify either `FailureToleranceCount` or `FailureTolerancePercentage` (but not both).
	FailureToleranceCount *float64 `json:"failureToleranceCount" yaml:"failureToleranceCount"`
	// The percentage of accounts, per Region, for which this stack operation can fail before AWS CloudFormation stops the operation in that Region.
	//
	// If the operation is stopped in a Region, AWS CloudFormation doesn't attempt the operation in any subsequent Regions.
	//
	// When calculating the number of accounts based on the specified percentage, AWS CloudFormation rounds *down* to the next whole number.
	//
	// Conditional: You must specify either `FailureToleranceCount` or `FailureTolerancePercentage` , but not both.
	FailureTolerancePercentage *float64 `json:"failureTolerancePercentage" yaml:"failureTolerancePercentage"`
	// The maximum number of accounts in which to perform this operation at one time.
	//
	// This is dependent on the value of `FailureToleranceCount` . `MaxConcurrentCount` is at most one more than the `FailureToleranceCount` .
	//
	// Note that this setting lets you specify the *maximum* for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.
	//
	// Conditional: You must specify either `MaxConcurrentCount` or `MaxConcurrentPercentage` , but not both.
	MaxConcurrentCount *float64 `json:"maxConcurrentCount" yaml:"maxConcurrentCount"`
	// The maximum percentage of accounts in which to perform this operation at one time.
	//
	// When calculating the number of accounts based on the specified percentage, AWS CloudFormation rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, CloudFormation sets the number as one instead.
	//
	// Note that this setting lets you specify the *maximum* for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.
	//
	// Conditional: You must specify either `MaxConcurrentCount` or `MaxConcurrentPercentage` , but not both.
	MaxConcurrentPercentage *float64 `json:"maxConcurrentPercentage" yaml:"maxConcurrentPercentage"`
	// The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time.
	//
	// *Allowed values* : `SEQUENTIAL` | `PARALLEL`
	RegionConcurrencyType *string `json:"regionConcurrencyType" yaml:"regionConcurrencyType"`
	// The order of the Regions where you want to perform the stack operation.
	RegionOrder *[]*string `json:"regionOrder" yaml:"regionOrder"`
}

The user-specified preferences for how AWS CloudFormation performs a stack set operation.

For more information on maximum concurrent accounts and failure tolerance, see [Stack set operation options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options) .

TODO: EXAMPLE

type CfnStackSet_ParameterProperty ¶ 

type CfnStackSet_ParameterProperty struct {
	// The key associated with the parameter.
	//
	// If you don't specify a key and value for a particular parameter, AWS CloudFormation uses the default value that's specified in your template.
	ParameterKey *string `json:"parameterKey" yaml:"parameterKey"`
	// The input value associated with the parameter.
	ParameterValue *string `json:"parameterValue" yaml:"parameterValue"`
}

The Parameter data type.

TODO: EXAMPLE

type CfnStackSet_StackInstancesProperty ¶ 

type CfnStackSet_StackInstancesProperty struct {
	// The AWS `OrganizationalUnitIds` or `Accounts` for which to create stack instances in the specified Regions.
	DeploymentTargets interface{} `json:"deploymentTargets" yaml:"deploymentTargets"`
	// The names of one or more Regions where you want to create stack instances using the specified AWS accounts .
	Regions *[]*string `json:"regions" yaml:"regions"`
	// A list of stack set parameters whose values you want to override in the selected stack instances.
	ParameterOverrides interface{} `json:"parameterOverrides" yaml:"parameterOverrides"`
}

Stack instances in some specific accounts and Regions.

TODO: EXAMPLE

type CfnTag ¶ 

type CfnTag struct {
	// Experimental.
	Key *string `json:"key" yaml:"key"`
	// Experimental.
	Value *string `json:"value" yaml:"value"`
}

TODO: EXAMPLE

Experimental.

type CfnTrafficRoute ¶ 

type CfnTrafficRoute struct {
	// The logical id of the target resource.
	// Experimental.
	LogicalId *string `json:"logicalId" yaml:"logicalId"`
	// The resource type of the route.
	//
	// Today, the only allowed value is 'AWS::ElasticLoadBalancingV2::Listener'.
	// Experimental.
	Type *string `json:"type" yaml:"type"`
}

A traffic route, representing where the traffic is being directed to.

TODO: EXAMPLE

Experimental.

type CfnTrafficRouting ¶ 

type CfnTrafficRouting struct {
	// The listener to be used by your load balancer to direct traffic to your target groups.
	// Experimental.
	ProdTrafficRoute *CfnTrafficRoute `json:"prodTrafficRoute" yaml:"prodTrafficRoute"`
	// The logical IDs of the blue and green, respectively, AWS::ElasticLoadBalancingV2::TargetGroup target groups.
	// Experimental.
	TargetGroups *[]*string `json:"targetGroups" yaml:"targetGroups"`
	// The listener to be used by your load balancer to direct traffic to your target groups.
	// Experimental.
	TestTrafficRoute *CfnTrafficRoute `json:"testTrafficRoute" yaml:"testTrafficRoute"`
}

Type of the {@link CfnCodeDeployBlueGreenEcsAttributes.trafficRouting} property.

TODO: EXAMPLE

Experimental.

type CfnTrafficRoutingConfig ¶ 

type CfnTrafficRoutingConfig struct {
	// The type of traffic shifting used by the blue-green deployment configuration.
	// Experimental.
	Type CfnTrafficRoutingType `json:"type" yaml:"type"`
	// The configuration for traffic routing when {@link type} is {@link CfnTrafficRoutingType.TIME_BASED_CANARY}.
	// Experimental.
	TimeBasedCanary *CfnTrafficRoutingTimeBasedCanary `json:"timeBasedCanary" yaml:"timeBasedCanary"`
	// The configuration for traffic routing when {@link type} is {@link CfnTrafficRoutingType.TIME_BASED_LINEAR}.
	// Experimental.
	TimeBasedLinear *CfnTrafficRoutingTimeBasedLinear `json:"timeBasedLinear" yaml:"timeBasedLinear"`
}

Traffic routing configuration settings.

The type of the {@link CfnCodeDeployBlueGreenHookProps.trafficRoutingConfig} property.

TODO: EXAMPLE

Experimental.

type CfnTrafficRoutingTimeBasedCanary ¶ 

type CfnTrafficRoutingTimeBasedCanary struct {
	// The number of minutes between the first and second traffic shifts of a time-based canary deployment.
	// Experimental.
	BakeTimeMins *float64 `json:"bakeTimeMins" yaml:"bakeTimeMins"`
	// The percentage of traffic to shift in the first increment of a time-based canary deployment.
	//
	// The step percentage must be 14% or greater.
	// Experimental.
	StepPercentage *float64 `json:"stepPercentage" yaml:"stepPercentage"`
}

The traffic routing configuration if {@link CfnTrafficRoutingConfig.type} is {@link CfnTrafficRoutingType.TIME_BASED_CANARY}.

TODO: EXAMPLE

Experimental.

type CfnTrafficRoutingTimeBasedLinear ¶ 

type CfnTrafficRoutingTimeBasedLinear struct {
	// The number of minutes between the first and second traffic shifts of a time-based linear deployment.
	// Experimental.
	BakeTimeMins *float64 `json:"bakeTimeMins" yaml:"bakeTimeMins"`
	// The percentage of traffic that is shifted at the start of each increment of a time-based linear deployment.
	//
	// The step percentage must be 14% or greater.
	// Experimental.
	StepPercentage *float64 `json:"stepPercentage" yaml:"stepPercentage"`
}

The traffic routing configuration if {@link CfnTrafficRoutingConfig.type} is {@link CfnTrafficRoutingType.TIME_BASED_LINEAR}.

TODO: EXAMPLE

Experimental.

type CfnTrafficRoutingType ¶ 

type CfnTrafficRoutingType string

The possible types of traffic shifting for the blue-green deployment configuration.

The type of the {@link CfnTrafficRoutingConfig.type} property. Experimental. 

const (
	CfnTrafficRoutingType_ALL_AT_ONCE       CfnTrafficRoutingType = "ALL_AT_ONCE"
	CfnTrafficRoutingType_TIME_BASED_CANARY CfnTrafficRoutingType = "TIME_BASED_CANARY"
	CfnTrafficRoutingType_TIME_BASED_LINEAR CfnTrafficRoutingType = "TIME_BASED_LINEAR"
)

type CfnTypeActivation ¶ 

type CfnTypeActivation interface {
	CfnResource
	IInspectable
	AttrArn() *string
	AutoUpdate() interface{}
	SetAutoUpdate(val interface{})
	CfnOptions() ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	ExecutionRoleArn() *string
	SetExecutionRoleArn(val *string)
	LoggingConfig() interface{}
	SetLoggingConfig(val interface{})
	LogicalId() *string
	MajorVersion() *string
	SetMajorVersion(val *string)
	Node() ConstructNode
	PublicTypeArn() *string
	SetPublicTypeArn(val *string)
	PublisherId() *string
	SetPublisherId(val *string)
	Ref() *string
	Stack() Stack
	Type() *string
	SetType(val *string)
	TypeName() *string
	SetTypeName(val *string)
	TypeNameAlias() *string
	SetTypeNameAlias(val *string)
	UpdatedProperites() *map[string]interface{}
	VersionBump() *string
	SetVersionBump(val *string)
	AddDeletionOverride(path *string)
	AddDependsOn(target CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy RemovalPolicy, options *RemovalPolicyOptions)
	GetAtt(attributeName *string) Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::CloudFormation::TypeActivation`.

Activates a public third-party extension, making it available for use in stack templates. For more information, see [Using public extensions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html) in the *AWS CloudFormation User Guide* .

Once you have activated a public third-party extension in your account and region, use [SetTypeConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html) to specify configuration properties for the extension. For more information, see [Configuring extensions at the account level](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration) in the *CloudFormation User Guide* .

TODO: EXAMPLE

func NewCfnTypeActivation ¶ 

func NewCfnTypeActivation(scope Construct, id *string, props *CfnTypeActivationProps) CfnTypeActivation

Create a new `AWS::CloudFormation::TypeActivation`.

type CfnTypeActivationProps ¶ 

type CfnTypeActivationProps struct {
	// Whether to automatically update the extension in this account and region when a new *minor* version is published by the extension publisher.
	//
	// Major versions released by the publisher must be manually updated.
	//
	// The default is `true` .
	AutoUpdate interface{} `json:"autoUpdate" yaml:"autoUpdate"`
	// The name of the IAM execution role to use to activate the extension.
	ExecutionRoleArn *string `json:"executionRoleArn" yaml:"executionRoleArn"`
	// Specifies logging configuration information for an extension.
	LoggingConfig interface{} `json:"loggingConfig" yaml:"loggingConfig"`
	// The major version of this extension you want to activate, if multiple major versions are available.
	//
	// The default is the latest major version. CloudFormation uses the latest available *minor* version of the major version selected.
	//
	// You can specify `MajorVersion` or `VersionBump` , but not both.
	MajorVersion *string `json:"majorVersion" yaml:"majorVersion"`
	// The Amazon Resource Number (ARN) of the public extension.
	//
	// Conditional: You must specify `PublicTypeArn` , or `TypeName` , `Type` , and `PublisherId` .
	PublicTypeArn *string `json:"publicTypeArn" yaml:"publicTypeArn"`
	// The ID of the extension publisher.
	//
	// Conditional: You must specify `PublicTypeArn` , or `TypeName` , `Type` , and `PublisherId` .
	PublisherId *string `json:"publisherId" yaml:"publisherId"`
	// The extension type.
	//
	// Conditional: You must specify `PublicTypeArn` , or `TypeName` , `Type` , and `PublisherId` .
	Type *string `json:"type" yaml:"type"`
	// The name of the extension.
	//
	// Conditional: You must specify `PublicTypeArn` , or `TypeName` , `Type` , and `PublisherId` .
	TypeName *string `json:"typeName" yaml:"typeName"`
	// An alias to assign to the public extension, in this account and region.
	//
	// If you specify an alias for the extension, CloudFormation treats the alias as the extension type name within this account and region. You must use the alias to refer to the extension in your templates, API calls, and CloudFormation console.
	//
	// An extension alias must be unique within a given account and region. You can activate the same public resource multiple times in the same account and region, using different type name aliases.
	TypeNameAlias *string `json:"typeNameAlias" yaml:"typeNameAlias"`
	// Manually updates a previously-activated type to a new major or minor version, if available.
	//
	// You can also use this parameter to update the value of `AutoUpdate` .
	//
	// - `MAJOR` : CloudFormation updates the extension to the newest major version, if one is available.
	// - `MINOR` : CloudFormation updates the extension to the newest minor version, if one is available.
	VersionBump *string `json:"versionBump" yaml:"versionBump"`
}

Properties for defining a `CfnTypeActivation`.

TODO: EXAMPLE

type CfnTypeActivation_LoggingConfigProperty ¶ 

type CfnTypeActivation_LoggingConfigProperty struct {
	// The Amazon CloudWatch Logs group to which CloudFormation sends error logging information when invoking the extension's handlers.
	LogGroupName *string `json:"logGroupName" yaml:"logGroupName"`
	// The Amazon Resource Name (ARN) of the role that CloudFormation should assume when sending log entries to CloudWatch Logs.
	LogRoleArn *string `json:"logRoleArn" yaml:"logRoleArn"`
}

Contains logging configuration information for an extension.

TODO: EXAMPLE

type CfnUpdatePolicy ¶ 

type CfnUpdatePolicy struct {
	// Specifies whether an Auto Scaling group and the instances it contains are replaced during an update.
	//
	// During replacement,
	// AWS CloudFormation retains the old group until it finishes creating the new one. If the update fails, AWS CloudFormation
	// can roll back to the old Auto Scaling group and delete the new Auto Scaling group.
	// Experimental.
	AutoScalingReplacingUpdate *CfnAutoScalingReplacingUpdate `json:"autoScalingReplacingUpdate" yaml:"autoScalingReplacingUpdate"`
	// To specify how AWS CloudFormation handles rolling updates for an Auto Scaling group, use the AutoScalingRollingUpdate policy.
	//
	// Rolling updates enable you to specify whether AWS CloudFormation updates instances that are in an Auto Scaling
	// group in batches or all at once.
	// Experimental.
	AutoScalingRollingUpdate *CfnAutoScalingRollingUpdate `json:"autoScalingRollingUpdate" yaml:"autoScalingRollingUpdate"`
	// To specify how AWS CloudFormation handles updates for the MinSize, MaxSize, and DesiredCapacity properties when the AWS::AutoScaling::AutoScalingGroup resource has an associated scheduled action, use the AutoScalingScheduledAction policy.
	// Experimental.
	AutoScalingScheduledAction *CfnAutoScalingScheduledAction `json:"autoScalingScheduledAction" yaml:"autoScalingScheduledAction"`
	// To perform an AWS CodeDeploy deployment when the version changes on an AWS::Lambda::Alias resource, use the CodeDeployLambdaAliasUpdate update policy.
	// Experimental.
	CodeDeployLambdaAliasUpdate *CfnCodeDeployLambdaAliasUpdate `json:"codeDeployLambdaAliasUpdate" yaml:"codeDeployLambdaAliasUpdate"`
	// To upgrade an Amazon ES domain to a new version of Elasticsearch rather than replacing the entire AWS::Elasticsearch::Domain resource, use the EnableVersionUpgrade update policy.
	// Experimental.
	EnableVersionUpgrade *bool `json:"enableVersionUpgrade" yaml:"enableVersionUpgrade"`
	// To modify a replication group's shards by adding or removing shards, rather than replacing the entire AWS::ElastiCache::ReplicationGroup resource, use the UseOnlineResharding update policy.
	// Experimental.
	UseOnlineResharding *bool `json:"useOnlineResharding" yaml:"useOnlineResharding"`
}

Use the UpdatePolicy attribute to specify how AWS CloudFormation handles updates to the AWS::AutoScaling::AutoScalingGroup resource.

AWS CloudFormation invokes one of three update policies depending on the type of change you make or whether a scheduled action is associated with the Auto Scaling group.

TODO: EXAMPLE

Experimental.

type CfnWaitCondition ¶ 

type CfnWaitCondition interface {
	CfnResource
	IInspectable
	AttrData() IResolvable
	CfnOptions() ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	Count() *float64
	SetCount(val *float64)
	CreationStack() *[]*string
	Handle() *string
	SetHandle(val *string)
	LogicalId() *string
	Node() ConstructNode
	Ref() *string
	Stack() Stack
	Timeout() *string
	SetTimeout(val *string)
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy RemovalPolicy, options *RemovalPolicyOptions)
	GetAtt(attributeName *string) Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::CloudFormation::WaitCondition`.

> For Amazon EC2 and Auto Scaling resources, we recommend that you use a `CreationPolicy` attribute instead of wait conditions. Add a CreationPolicy attribute to those resources, and use the cfn-signal helper script to signal when an instance creation process has completed successfully.

You can use a wait condition for situations like the following:

- To coordinate stack resource creation with configuration actions that are external to the stack creation. - To track the status of a configuration process.

For these situations, we recommend that you associate a [CreationPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-creationpolicy.html) attribute with the wait condition so that you don't have to use a wait condition handle. For more information and an example, see [Creating wait conditions in a template](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-waitcondition.html) . If you use a CreationPolicy with a wait condition, don't specify any of the wait condition's properties.

> If you use the [VPC endpoints](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-endpoints.html) feature, resources in the VPC that respond to wait conditions must have access to CloudFormation , specific Amazon Simple Storage Service ( Amazon S3 ) buckets. Resources must send wait condition responses to a presigned Amazon S3 URL. If they can't send responses to Amazon S3 , CloudFormation won't receive a response and the stack operation fails. For more information, see [Setting up VPC endpoints for AWS CloudFormation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-vpce-bucketnames.html) .

TODO: EXAMPLE

func NewCfnWaitCondition ¶ 

func NewCfnWaitCondition(scope Construct, id *string, props *CfnWaitConditionProps) CfnWaitCondition

Create a new `AWS::CloudFormation::WaitCondition`.

type CfnWaitConditionHandle ¶ 

type CfnWaitConditionHandle interface {
	CfnResource
	IInspectable
	CfnOptions() ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	LogicalId() *string
	Node() ConstructNode
	Ref() *string
	Stack() Stack
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy RemovalPolicy, options *RemovalPolicyOptions)
	GetAtt(attributeName *string) Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::CloudFormation::WaitConditionHandle`.

> For Amazon EC2 and Auto Scaling resources, we recommend that you use a `CreationPolicy` attribute instead of wait conditions. Add a `CreationPolicy` attribute to those resources, and use the cfn-signal helper script to signal when an instance creation process has completed successfully. > > For more information, see [Deploying applications on Amazon EC2 with AWS CloudFormation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/deploying.applications.html) .

The `AWS::CloudFormation::WaitConditionHandle` type has no properties. When you reference the `WaitConditionHandle` resource by using the Ref function, AWS CloudFormation returns a presigned URL. You pass this URL to applications or scripts that are running on your Amazon EC2 instances to send signals to that URL. An associated `AWS::CloudFormation::WaitCondition` resource checks the URL for the required number of success signals or for a failure signal.

> Anytime you add a `WaitCondition` resource during a stack update or update a resource with a wait condition, you must associate the wait condition with a new `WaitConditionHandle` resource. Don't reuse an old wait condition handle that has already been defined in the template. If you reuse a wait condition handle, the wait condition might evaluate old signals from a previous create or update stack command. > Updates aren't supported for this resource.

TODO: EXAMPLE

func NewCfnWaitConditionHandle ¶ 

func NewCfnWaitConditionHandle(scope Construct, id *string) CfnWaitConditionHandle

Create a new `AWS::CloudFormation::WaitConditionHandle`.

type CfnWaitConditionProps ¶ 

type CfnWaitConditionProps struct {
	// The number of success signals that CloudFormation must receive before it continues the stack creation process.
	//
	// When the wait condition receives the requisite number of success signals, CloudFormation resumes the creation of the stack. If the wait condition doesn't receive the specified number of success signals before the Timeout period expires, CloudFormation assumes that the wait condition has failed and rolls the stack back.
	//
	// Updates aren't supported.
	Count *float64 `json:"count" yaml:"count"`
	// A reference to the wait condition handle used to signal this wait condition.
	//
	// Use the `Ref` intrinsic function to specify an [AWS::CloudFormation::WaitConditionHandle](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waitconditionhandle.html) resource.
	//
	// Anytime you add a WaitCondition resource during a stack update, you must associate the wait condition with a new WaitConditionHandle resource. Don't reuse an old wait condition handle that has already been defined in the template. If you reuse a wait condition handle, the wait condition might evaluate old signals from a previous create or update stack command.
	//
	// Updates aren't supported.
	Handle *string `json:"handle" yaml:"handle"`
	// The length of time (in seconds) to wait for the number of signals that the `Count` property specifies.
	//
	// `Timeout` is a minimum-bound property, meaning the timeout occurs no sooner than the time you specify, but can occur shortly thereafter. The maximum time that can be specified for this property is 12 hours (43200 seconds).
	//
	// Updates aren't supported.
	Timeout *string `json:"timeout" yaml:"timeout"`
}

Properties for defining a `CfnWaitCondition`.

TODO: EXAMPLE

type CliCredentialsStackSynthesizer ¶ 

type CliCredentialsStackSynthesizer interface {
	StackSynthesizer
	AddDockerImageAsset(asset *DockerImageAssetSource) *DockerImageAssetLocation
	AddFileAsset(asset *FileAssetSource) *FileAssetLocation
	Bind(stack Stack)
	EmitStackArtifact(stack Stack, session ISynthesisSession, options *SynthesizeStackArtifactOptions)
	Synthesize(session ISynthesisSession)
	SynthesizeStackTemplate(stack Stack, session ISynthesisSession)
}

A synthesizer that uses conventional asset locations, but not conventional deployment roles.

Instead of assuming the bootstrapped deployment roles, all stack operations will be performed using the CLI's current credentials.

  • This synthesizer does not support deploying to accounts to which the CLI does not have credentials. It also does not support deploying using **CDK Pipelines**. For either of those features, use `DefaultStackSynthesizer`.
  • This synthesizer requires an S3 bucket and ECR repository with well-known names. To not depend on those, use `LegacyStackSynthesizer`.

Be aware that your CLI credentials must be valid for the duration of the entire deployment. If you are using session credentials, make sure the session lifetime is long enough.

By default, expects the environment to have been bootstrapped with just the staging resources of the Bootstrap Stack V2 (also known as "modern bootstrap stack"). You can override the default names using the synthesizer's construction properties.

TODO: EXAMPLE

Experimental.

func NewCliCredentialsStackSynthesizer ¶ 

func NewCliCredentialsStackSynthesizer(props *CliCredentialsStackSynthesizerProps) CliCredentialsStackSynthesizer

Experimental.

type CliCredentialsStackSynthesizerProps ¶ 

type CliCredentialsStackSynthesizerProps struct {
	// bucketPrefix to use while storing S3 Assets.
	// Experimental.
	BucketPrefix *string `json:"bucketPrefix" yaml:"bucketPrefix"`
	// A prefix to use while tagging and uploading Docker images to ECR.
	//
	// This does not add any separators - the source hash will be appended to
	// this string directly.
	// Experimental.
	DockerTagPrefix *string `json:"dockerTagPrefix" yaml:"dockerTagPrefix"`
	// Name of the S3 bucket to hold file assets.
	//
	// You must supply this if you have given a non-standard name to the staging bucket.
	//
	// The placeholders `${Qualifier}`, `${AWS::AccountId}` and `${AWS::Region}` will
	// be replaced with the values of qualifier and the stack's account and region,
	// respectively.
	// Experimental.
	FileAssetsBucketName *string `json:"fileAssetsBucketName" yaml:"fileAssetsBucketName"`
	// Name of the ECR repository to hold Docker Image assets.
	//
	// You must supply this if you have given a non-standard name to the ECR repository.
	//
	// The placeholders `${Qualifier}`, `${AWS::AccountId}` and `${AWS::Region}` will
	// be replaced with the values of qualifier and the stack's account and region,
	// respectively.
	// Experimental.
	ImageAssetsRepositoryName *string `json:"imageAssetsRepositoryName" yaml:"imageAssetsRepositoryName"`
	// Qualifier to disambiguate multiple environments in the same account.
	//
	// You can use this and leave the other naming properties empty if you have deployed
	// the bootstrap environment with standard names but only differnet qualifiers.
	// Experimental.
	Qualifier *string `json:"qualifier" yaml:"qualifier"`
}

Properties for the CliCredentialsStackSynthesizer.

TODO: EXAMPLE

Experimental.

type ConcreteDependable ¶ 

type ConcreteDependable interface {
	IDependable
	Add(construct IConstruct)
}

A set of constructs to be used as a dependable.

This class can be used when a set of constructs which are disjoint in the construct tree needs to be combined to be used as a single dependable.

TODO: EXAMPLE

Experimental.

func NewConcreteDependable ¶ 

func NewConcreteDependable() ConcreteDependable

Experimental.

type Construct ¶ 

type Construct interface {
	constructs.Construct
	IConstruct
	Node() ConstructNode
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	Prepare()
	Synthesize(session ISynthesisSession)
	ToString() *string
	Validate() *[]*string
}

Represents the building block of the construct graph.

All constructs besides the root construct must be created within the scope of another construct.

TODO: EXAMPLE

Experimental.

func NewConstruct ¶ 

func NewConstruct(scope constructs.Construct, id *string) Construct

Experimental.

type ConstructNode ¶ 

type ConstructNode interface {
	Addr() *string
	Children() *[]IConstruct
	DefaultChild() IConstruct
	SetDefaultChild(val IConstruct)
	Dependencies() *[]*Dependency
	Id() *string
	Locked() *bool
	Metadata() *[]*cxapi.MetadataEntry
	MetadataEntry() *[]*constructs.MetadataEntry
	Path() *string
	Root() IConstruct
	Scope() IConstruct
	Scopes() *[]IConstruct
	UniqueId() *string
	AddDependency(dependencies ...IDependable)
	AddError(message *string)
	AddInfo(message *string)
	AddMetadata(type_ *string, data interface{}, fromFunction interface{})
	AddValidation(validation constructs.IValidation)
	AddWarning(message *string)
	ApplyAspect(aspect IAspect)
	FindAll(order ConstructOrder) *[]IConstruct
	FindChild(id *string) IConstruct
	SetContext(key *string, value interface{})
	TryFindChild(id *string) IConstruct
	TryGetContext(key *string) interface{}
	TryRemoveChild(childName *string) *bool
}

Represents the construct node in the scope tree.

TODO: EXAMPLE

Experimental.

func NewConstructNode ¶ 

func NewConstructNode(host Construct, scope IConstruct, id *string) ConstructNode

Experimental.

type ConstructOrder ¶ 

type ConstructOrder string

In what order to return constructs. Experimental. 

const (
	ConstructOrder_PREORDER  ConstructOrder = "PREORDER"
	ConstructOrder_POSTORDER ConstructOrder = "POSTORDER"
)

type ContextProvider ¶ 

type ContextProvider interface {
}

Base class for the model side of context providers.

Instances of this class communicate with context provider plugins in the 'cdk toolkit' via context variables (input), outputting specialized queries for more context variables (output).

ContextProvider needs access to a Construct to hook into the context mechanism. Experimental.

type CopyOptions ¶ 

type CopyOptions struct {
	// Glob patterns to exclude from the copy.
	// Experimental.
	Exclude *[]*string `json:"exclude" yaml:"exclude"`
	// A strategy for how to handle symlinks.
	// Experimental.
	Follow SymlinkFollowMode `json:"follow" yaml:"follow"`
	// The ignore behavior to use for exclude patterns.
	// Experimental.
	IgnoreMode IgnoreMode `json:"ignoreMode" yaml:"ignoreMode"`
}

Options applied when copying directories.

TODO: EXAMPLE

Experimental.

type CustomResource ¶ 

type CustomResource interface {
	Resource
	Env() *ResourceEnvironment
	Node() ConstructNode
	PhysicalName() *string
	Ref() *string
	Stack() Stack
	ApplyRemovalPolicy(policy RemovalPolicy)
	GeneratePhysicalName() *string
	GetAtt(attributeName *string) Reference
	GetAttString(attributeName *string) *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	Prepare()
	Synthesize(session ISynthesisSession)
	ToString() *string
	Validate() *[]*string
}

Instantiation of a custom resource, whose implementation is provided a Provider.

This class is intended to be used by construct library authors. Application builder should not be able to tell whether or not a construct is backed by a custom resource, and so the use of this class should be invisible.

Instead, construct library authors declare a custom construct that hides the choice of provider, and accepts a strongly-typed properties object with the properties your provider accepts.

Your custom resource provider (identified by the `serviceToken` property) can be one of 4 constructs:

  • If you are authoring a construct library or application, we recommend you use the `Provider` class in the `custom-resources` module.
  • If you are authoring a construct for the CDK's AWS Construct Library, you should use the `CustomResourceProvider` construct in this package.
  • If you want full control over the provider, you can always directly use a Lambda Function or SNS Topic by passing the ARN into `serviceToken`.

TODO: EXAMPLE

Experimental.

func NewCustomResource ¶ 

func NewCustomResource(scope constructs.Construct, id *string, props *CustomResourceProps) CustomResource

Experimental.

type CustomResourceProps ¶ 

type CustomResourceProps struct {
	// The ARN of the provider which implements this custom resource type.
	//
	// You can implement a provider by listening to raw AWS CloudFormation events
	// and specify the ARN of an SNS topic (`topic.topicArn`) or the ARN of an AWS
	// Lambda function (`lambda.functionArn`) or use the CDK's custom [resource
	// provider framework] which makes it easier to implement robust providers.
	//
	// [resource provider framework]:
	// https://docs.aws.amazon.com/cdk/api/latest/docs/custom-resources-readme.html
	//
	// Provider framework:
	//
	// “`ts
	// // use the provider framework from aws-cdk/custom-resources:
	// const provider = new customresources.Provider(this, 'ResourceProvider', {
	//    onEventHandler,
	//    isCompleteHandler, // optional
	// });
	//
	// new CustomResource(this, 'MyResource', {
	//    serviceToken: provider.serviceToken,
	// });
	// “`
	//
	// AWS Lambda function:
	//
	// “`ts
	// // invoke an AWS Lambda function when a lifecycle event occurs:
	// new CustomResource(this, 'MyResource', {
	//    serviceToken: myFunction.functionArn,
	// });
	// “`
	//
	// SNS topic:
	//
	// “`ts
	// // publish lifecycle events to an SNS topic:
	// new CustomResource(this, 'MyResource', {
	//    serviceToken: myTopic.topicArn,
	// });
	// “`
	// Experimental.
	ServiceToken *string `json:"serviceToken" yaml:"serviceToken"`
	// Convert all property keys to pascal case.
	// Experimental.
	PascalCaseProperties *bool `json:"pascalCaseProperties" yaml:"pascalCaseProperties"`
	// Properties to pass to the Lambda.
	// Experimental.
	Properties *map[string]interface{} `json:"properties" yaml:"properties"`
	// The policy to apply when this resource is removed from the application.
	// Experimental.
	RemovalPolicy RemovalPolicy `json:"removalPolicy" yaml:"removalPolicy"`
	// For custom resources, you can specify AWS::CloudFormation::CustomResource (the default) as the resource type, or you can specify your own resource type name.
	//
	// For example, you can use "Custom::MyCustomResourceTypeName".
	//
	// Custom resource type names must begin with "Custom::" and can include
	// alphanumeric characters and the following characters: _@-. You can specify
	// a custom resource type name up to a maximum length of 60 characters. You
	// cannot change the type during an update.
	//
	// Using your own resource type names helps you quickly differentiate the
	// types of custom resources in your stack. For example, if you had two custom
	// resources that conduct two different ping tests, you could name their type
	// as Custom::PingTester to make them easily identifiable as ping testers
	// (instead of using AWS::CloudFormation::CustomResource).
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cfn-customresource.html#aws-cfn-resource-type-name
	//
	// Experimental.
	ResourceType *string `json:"resourceType" yaml:"resourceType"`
}

Properties to provide a Lambda-backed custom resource.

TODO: EXAMPLE

Experimental.

type CustomResourceProvider ¶ 

type CustomResourceProvider interface {
	Construct
	Node() ConstructNode
	RoleArn() *string
	ServiceToken() *string
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	Prepare()
	Synthesize(session ISynthesisSession)
	ToString() *string
	Validate() *[]*string
}

An AWS-Lambda backed custom resource provider, for CDK Construct Library constructs.

This is a provider for `CustomResource` constructs, backed by an AWS Lambda Function. It only supports NodeJS runtimes.

**This is not a generic custom resource provider class**. It is specifically intended to be used only by constructs in the AWS CDK Construct Library, and only exists here because of reverse dependency issues (for example, it cannot use `iam.PolicyStatement` objects, since the `iam` library already depends on the CDK `core` library and we cannot have cyclic dependencies).

If you are not writing constructs for the AWS Construct Library, you should use the `Provider` class in the `custom-resources` module instead, which has a better API and supports all Lambda runtimes, not just Node.

N.B.: When you are writing Custom Resource Providers, there are a number of lifecycle events you have to pay attention to. These are documented in the README of the `custom-resources` module. Be sure to give the documentation in that module a read, regardless of whether you end up using the Provider class in there or this one.

TODO: EXAMPLE

Experimental.

func CustomResourceProvider_GetOrCreateProvider ¶ 

func CustomResourceProvider_GetOrCreateProvider(scope constructs.Construct, uniqueid *string, props *CustomResourceProviderProps) CustomResourceProvider

Returns a stack-level singleton for the custom resource provider.

Returns: the service token of the custom resource provider, which should be used when defining a `CustomResource`. Experimental.

func NewCustomResourceProvider ¶ 

func NewCustomResourceProvider(scope constructs.Construct, id *string, props *CustomResourceProviderProps) CustomResourceProvider

Experimental.

type CustomResourceProviderProps ¶ 

type CustomResourceProviderProps struct {
	// A local file system directory with the provider's code.
	//
	// The code will be
	// bundled into a zip asset and wired to the provider's AWS Lambda function.
	// Experimental.
	CodeDirectory *string `json:"codeDirectory" yaml:"codeDirectory"`
	// The AWS Lambda runtime and version to use for the provider.
	// Experimental.
	Runtime CustomResourceProviderRuntime `json:"runtime" yaml:"runtime"`
	// A description of the function.
	// Experimental.
	Description *string `json:"description" yaml:"description"`
	// Key-value pairs that are passed to Lambda as Environment.
	// Experimental.
	Environment *map[string]*string `json:"environment" yaml:"environment"`
	// The amount of memory that your function has access to.
	//
	// Increasing the
	// function's memory also increases its CPU allocation.
	// Experimental.
	MemorySize Size `json:"memorySize" yaml:"memorySize"`
	// A set of IAM policy statements to include in the inline policy of the provider's lambda function.
	//
	// **Please note**: these are direct IAM JSON policy blobs, *not* `iam.PolicyStatement`
	// objects like you will see in the rest of the CDK.
	//
	// TODO: EXAMPLE
	//
	// Experimental.
	PolicyStatements *[]interface{} `json:"policyStatements" yaml:"policyStatements"`
	// AWS Lambda timeout for the provider.
	// Experimental.
	Timeout Duration `json:"timeout" yaml:"timeout"`
}

Initialization properties for `CustomResourceProvider`.

TODO: EXAMPLE

Experimental.

type CustomResourceProviderRuntime ¶ 

type CustomResourceProviderRuntime string

The lambda runtime to use for the resource provider.

This also indicates which language is used for the handler.

TODO: EXAMPLE

Experimental. 

const (
	CustomResourceProviderRuntime_NODEJS_12   CustomResourceProviderRuntime = "NODEJS_12"
	CustomResourceProviderRuntime_NODEJS_14_X CustomResourceProviderRuntime = "NODEJS_14_X"
)

type DefaultStackSynthesizer ¶ 

type DefaultStackSynthesizer interface {
	StackSynthesizer
	CloudFormationExecutionRoleArn() *string
	DeployRoleArn() *string
	Stack() Stack
	AddDockerImageAsset(asset *DockerImageAssetSource) *DockerImageAssetLocation
	AddFileAsset(asset *FileAssetSource) *FileAssetLocation
	Bind(stack Stack)
	EmitStackArtifact(stack Stack, session ISynthesisSession, options *SynthesizeStackArtifactOptions)
	Synthesize(session ISynthesisSession)
	SynthesizeStackTemplate(stack Stack, session ISynthesisSession)
}

Uses conventionally named roles and asset storage locations.

This synthesizer:

  • Supports cross-account deployments (the CLI can have credentials to one account, and you can still deploy to another account by assuming roles with well-known names in the other account).
  • Supports the **CDK Pipelines** library.

Requires the environment to have been bootstrapped with Bootstrap Stack V2 (also known as "modern bootstrap stack"). The synthesizer adds a version check to the template, to make sure the bootstrap stack is recent enough to support all features expected by this synthesizer.

TODO: EXAMPLE

Experimental.

func NewDefaultStackSynthesizer ¶ 

func NewDefaultStackSynthesizer(props *DefaultStackSynthesizerProps) DefaultStackSynthesizer

Experimental.

type DefaultStackSynthesizerProps ¶ 

type DefaultStackSynthesizerProps struct {
	// Bootstrap stack version SSM parameter.
	//
	// The placeholder `${Qualifier}` will be replaced with the value of qualifier.
	// Experimental.
	BootstrapStackVersionSsmParameter *string `json:"bootstrapStackVersionSsmParameter" yaml:"bootstrapStackVersionSsmParameter"`
	// bucketPrefix to use while storing S3 Assets.
	// Experimental.
	BucketPrefix *string `json:"bucketPrefix" yaml:"bucketPrefix"`
	// The role CloudFormation will assume when deploying the Stack.
	//
	// You must supply this if you have given a non-standard name to the execution role.
	//
	// The placeholders `${Qualifier}`, `${AWS::AccountId}` and `${AWS::Region}` will
	// be replaced with the values of qualifier and the stack's account and region,
	// respectively.
	// Experimental.
	CloudFormationExecutionRole *string `json:"cloudFormationExecutionRole" yaml:"cloudFormationExecutionRole"`
	// The role to assume to initiate a deployment in this environment.
	//
	// You must supply this if you have given a non-standard name to the publishing role.
	//
	// The placeholders `${Qualifier}`, `${AWS::AccountId}` and `${AWS::Region}` will
	// be replaced with the values of qualifier and the stack's account and region,
	// respectively.
	// Experimental.
	DeployRoleArn *string `json:"deployRoleArn" yaml:"deployRoleArn"`
	// External ID to use when assuming role for cloudformation deployments.
	// Experimental.
	DeployRoleExternalId *string `json:"deployRoleExternalId" yaml:"deployRoleExternalId"`
	// A prefix to use while tagging and uploading Docker images to ECR.
	//
	// This does not add any separators - the source hash will be appended to
	// this string directly.
	// Experimental.
	DockerTagPrefix *string `json:"dockerTagPrefix" yaml:"dockerTagPrefix"`
	// Name of the CloudFormation Export with the asset key name.
	//
	// You must supply this if you have given a non-standard name to the KMS key export
	//
	// The placeholders `${Qualifier}`, `${AWS::AccountId}` and `${AWS::Region}` will
	// be replaced with the values of qualifier and the stack's account and region,
	// respectively.
	// Deprecated: This property is not used anymore
	FileAssetKeyArnExportName *string `json:"fileAssetKeyArnExportName" yaml:"fileAssetKeyArnExportName"`
	// External ID to use when assuming role for file asset publishing.
	// Experimental.
	FileAssetPublishingExternalId *string `json:"fileAssetPublishingExternalId" yaml:"fileAssetPublishingExternalId"`
	// The role to use to publish file assets to the S3 bucket in this environment.
	//
	// You must supply this if you have given a non-standard name to the publishing role.
	//
	// The placeholders `${Qualifier}`, `${AWS::AccountId}` and `${AWS::Region}` will
	// be replaced with the values of qualifier and the stack's account and region,
	// respectively.
	// Experimental.
	FileAssetPublishingRoleArn *string `json:"fileAssetPublishingRoleArn" yaml:"fileAssetPublishingRoleArn"`
	// Name of the S3 bucket to hold file assets.
	//
	// You must supply this if you have given a non-standard name to the staging bucket.
	//
	// The placeholders `${Qualifier}`, `${AWS::AccountId}` and `${AWS::Region}` will
	// be replaced with the values of qualifier and the stack's account and region,
	// respectively.
	// Experimental.
	FileAssetsBucketName *string `json:"fileAssetsBucketName" yaml:"fileAssetsBucketName"`
	// Whether to add a Rule to the stack template verifying the bootstrap stack version.
	//
	// This generally should be left set to `true`, unless you explicitly
	// want to be able to deploy to an unbootstrapped environment.
	// Experimental.
	GenerateBootstrapVersionRule *bool `json:"generateBootstrapVersionRule" yaml:"generateBootstrapVersionRule"`
	// External ID to use when assuming role for image asset publishing.
	// Experimental.
	ImageAssetPublishingExternalId *string `json:"imageAssetPublishingExternalId" yaml:"imageAssetPublishingExternalId"`
	// The role to use to publish image assets to the ECR repository in this environment.
	//
	// You must supply this if you have given a non-standard name to the publishing role.
	//
	// The placeholders `${Qualifier}`, `${AWS::AccountId}` and `${AWS::Region}` will
	// be replaced with the values of qualifier and the stack's account and region,
	// respectively.
	// Experimental.
	ImageAssetPublishingRoleArn *string `json:"imageAssetPublishingRoleArn" yaml:"imageAssetPublishingRoleArn"`
	// Name of the ECR repository to hold Docker Image assets.
	//
	// You must supply this if you have given a non-standard name to the ECR repository.
	//
	// The placeholders `${Qualifier}`, `${AWS::AccountId}` and `${AWS::Region}` will
	// be replaced with the values of qualifier and the stack's account and region,
	// respectively.
	// Experimental.
	ImageAssetsRepositoryName *string `json:"imageAssetsRepositoryName" yaml:"imageAssetsRepositoryName"`
	// The role to use to look up values from the target AWS account during synthesis.
	// Experimental.
	LookupRoleArn *string `json:"lookupRoleArn" yaml:"lookupRoleArn"`
	// External ID to use when assuming lookup role.
	// Experimental.
	LookupRoleExternalId *string `json:"lookupRoleExternalId" yaml:"lookupRoleExternalId"`
	// Qualifier to disambiguate multiple environments in the same account.
	//
	// You can use this and leave the other naming properties empty if you have deployed
	// the bootstrap environment with standard names but only differnet qualifiers.
	// Experimental.
	Qualifier *string `json:"qualifier" yaml:"qualifier"`
	// Use the bootstrapped lookup role for (read-only) stack operations.
	//
	// Use the lookup role when performing a `cdk diff`. If set to `false`, the
	// `deploy role` credentials will be used to perform a `cdk diff`.
	//
	// Requires bootstrap stack version 8.
	// Experimental.
	UseLookupRoleForStackOperations *bool `json:"useLookupRoleForStackOperations" yaml:"useLookupRoleForStackOperations"`
}

Configuration properties for DefaultStackSynthesizer.

TODO: EXAMPLE

Experimental.

type DefaultTokenResolver ¶ 

type DefaultTokenResolver interface {
	ITokenResolver
	ResolveList(xs *[]*string, context IResolveContext) interface{}
	ResolveString(fragments TokenizedStringFragments, context IResolveContext) interface{}
	ResolveToken(t IResolvable, context IResolveContext, postProcessor IPostProcessor) interface{}
}

Default resolver implementation.

TODO: EXAMPLE

Experimental.

func NewDefaultTokenResolver ¶ 

func NewDefaultTokenResolver(concat IFragmentConcatenator) DefaultTokenResolver

Experimental.

type DependableTrait ¶ 

type DependableTrait interface {
	DependencyRoots() *[]IConstruct
}

Trait for IDependable.

Traits are interfaces that are privately implemented by objects. Instead of showing up in the public interface of a class, they need to be queried explicitly. This is used to implement certain framework features that are not intended to be used by Construct consumers, and so should be hidden from accidental use.

TODO: EXAMPLE

Experimental.

func DependableTrait_Get ¶ 

func DependableTrait_Get(instance IDependable) DependableTrait

Return the matching DependableTrait for the given class instance. Experimental.

type Dependency ¶ 

type Dependency struct {
	// Source the dependency.
	// Experimental.
	Source IConstruct `json:"source" yaml:"source"`
	// Target of the dependency.
	// Experimental.
	Target IConstruct `json:"target" yaml:"target"`
}

A single dependency.

TODO: EXAMPLE

Experimental.

type DockerBuildOptions ¶ 

type DockerBuildOptions struct {
	// Build args.
	// Experimental.
	BuildArgs *map[string]*string `json:"buildArgs" yaml:"buildArgs"`
	// Name of the Dockerfile, must relative to the docker build path.
	// Experimental.
	File *string `json:"file" yaml:"file"`
	// Set platform if server is multi-platform capable. _Requires Docker Engine API v1.38+_.
	//
	// Example value: `linux/amd64`
	// Experimental.
	Platform *string `json:"platform" yaml:"platform"`
}

Docker build options.

TODO: EXAMPLE

Experimental.

type DockerIgnoreStrategy ¶ 

type DockerIgnoreStrategy interface {
	IgnoreStrategy
	Add(pattern *string)
	Ignores(absoluteFilePath *string) *bool
}

Ignores file paths based on the [`.dockerignore specification`](https://docs.docker.com/engine/reference/builder/#dockerignore-file).

TODO: EXAMPLE

Experimental.

func DockerIgnoreStrategy_Docker ¶ 

func DockerIgnoreStrategy_Docker(absoluteRootPath *string, patterns *[]*string) DockerIgnoreStrategy

Ignores file paths based on the [`.dockerignore specification`](https://docs.docker.com/engine/reference/builder/#dockerignore-file).

Returns: `DockerIgnorePattern` associated with the given patterns. Experimental.

func GitIgnoreStrategy_Docker ¶ 

func GitIgnoreStrategy_Docker(absoluteRootPath *string, patterns *[]*string) DockerIgnoreStrategy

Ignores file paths based on the [`.dockerignore specification`](https://docs.docker.com/engine/reference/builder/#dockerignore-file).

Returns: `DockerIgnorePattern` associated with the given patterns. Experimental.

func GlobIgnoreStrategy_Docker ¶ 

func GlobIgnoreStrategy_Docker(absoluteRootPath *string, patterns *[]*string) DockerIgnoreStrategy

Ignores file paths based on the [`.dockerignore specification`](https://docs.docker.com/engine/reference/builder/#dockerignore-file).

Returns: `DockerIgnorePattern` associated with the given patterns. Experimental.

func IgnoreStrategy_Docker ¶ 

func IgnoreStrategy_Docker(absoluteRootPath *string, patterns *[]*string) DockerIgnoreStrategy

Ignores file paths based on the [`.dockerignore specification`](https://docs.docker.com/engine/reference/builder/#dockerignore-file).

Returns: `DockerIgnorePattern` associated with the given patterns. Experimental.

func NewDockerIgnoreStrategy ¶ 

func NewDockerIgnoreStrategy(absoluteRootPath *string, patterns *[]*string) DockerIgnoreStrategy

Experimental.

type DockerImage ¶ 

type DockerImage interface {
	BundlingDockerImage
	Image() *string
	Cp(imagePath *string, outputPath *string) *string
	Run(options *DockerRunOptions)
	ToJSON() *string
}

A Docker image.

TODO: EXAMPLE

Experimental.

func BundlingDockerImage_FromRegistry ¶ 

func BundlingDockerImage_FromRegistry(image *string) DockerImage

Reference an image on DockerHub or another online registry. Deprecated: use DockerImage

func DockerImage_FromBuild ¶ 

func DockerImage_FromBuild(path *string, options *DockerBuildOptions) DockerImage

Builds a Docker image. Experimental.

func DockerImage_FromRegistry ¶ 

func DockerImage_FromRegistry(image *string) DockerImage

Reference an image on DockerHub or another online registry. Experimental.

func NewDockerImage ¶ 

func NewDockerImage(image *string, _imageHash *string) DockerImage

Experimental.

type DockerImageAssetLocation ¶ 

type DockerImageAssetLocation struct {
	// The URI of the image in Amazon ECR.
	// Experimental.
	ImageUri *string `json:"imageUri" yaml:"imageUri"`
	// The name of the ECR repository.
	// Experimental.
	RepositoryName *string `json:"repositoryName" yaml:"repositoryName"`
}

The location of the published docker image.

This is where the image can be consumed at runtime.

TODO: EXAMPLE

Experimental.

type DockerImageAssetSource ¶ 

type DockerImageAssetSource struct {
	// The hash of the contents of the docker build context.
	//
	// This hash is used
	// throughout the system to identify this image and avoid duplicate work
	// in case the source did not change.
	//
	// NOTE: this means that if you wish to update your docker image, you
	// must make a modification to the source (e.g. add some metadata to your Dockerfile).
	// Experimental.
	SourceHash *string `json:"sourceHash" yaml:"sourceHash"`
	// The directory where the Dockerfile is stored, must be relative to the cloud assembly root.
	// Experimental.
	DirectoryName *string `json:"directoryName" yaml:"directoryName"`
	// Build args to pass to the `docker build` command.
	//
	// Since Docker build arguments are resolved before deployment, keys and
	// values cannot refer to unresolved tokens (such as `lambda.functionArn` or
	// `queue.queueUrl`).
	//
	// Only allowed when `directoryName` is specified.
	// Experimental.
	DockerBuildArgs *map[string]*string `json:"dockerBuildArgs" yaml:"dockerBuildArgs"`
	// Docker target to build to.
	//
	// Only allowed when `directoryName` is specified.
	// Experimental.
	DockerBuildTarget *string `json:"dockerBuildTarget" yaml:"dockerBuildTarget"`
	// Path to the Dockerfile (relative to the directory).
	//
	// Only allowed when `directoryName` is specified.
	// Experimental.
	DockerFile *string `json:"dockerFile" yaml:"dockerFile"`
	// An external command that will produce the packaged asset.
	//
	// The command should produce the name of a local Docker image on `stdout`.
	// Experimental.
	Executable *[]*string `json:"executable" yaml:"executable"`
	// Networking mode for the RUN commands during build. _Requires Docker Engine API v1.25+_.
	//
	// Specify this property to build images on a specific networking mode.
	// Experimental.
	NetworkMode *string `json:"networkMode" yaml:"networkMode"`
	// ECR repository name.
	//
	// Specify this property if you need to statically address the image, e.g.
	// from a Kubernetes Pod. Note, this is only the repository name, without the
	// registry and the tag parts.
	// Deprecated: repository name should be specified at the environment-level and not at the image level
	RepositoryName *string `json:"repositoryName" yaml:"repositoryName"`
}

TODO: EXAMPLE

Experimental.

type DockerRunOptions ¶ 

type DockerRunOptions struct {
	// The command to run in the container.
	// Experimental.
	Command *[]*string `json:"command" yaml:"command"`
	// The entrypoint to run in the container.
	// Experimental.
	Entrypoint *[]*string `json:"entrypoint" yaml:"entrypoint"`
	// The environment variables to pass to the container.
	// Experimental.
	Environment *map[string]*string `json:"environment" yaml:"environment"`
	// [Security configuration](https://docs.docker.com/engine/reference/run/#security-configuration) when running the docker container.
	// Experimental.
	SecurityOpt *string `json:"securityOpt" yaml:"securityOpt"`
	// The user to use when running the container.
	// Experimental.
	User *string `json:"user" yaml:"user"`
	// Docker volumes to mount.
	// Experimental.
	Volumes *[]*DockerVolume `json:"volumes" yaml:"volumes"`
	// Working directory inside the container.
	// Experimental.
	WorkingDirectory *string `json:"workingDirectory" yaml:"workingDirectory"`
}

Docker run options.

TODO: EXAMPLE

Experimental.

type DockerVolume ¶ 

type DockerVolume struct {
	// The path where the file or directory is mounted in the container.
	// Experimental.
	ContainerPath *string `json:"containerPath" yaml:"containerPath"`
	// The path to the file or directory on the host machine.
	// Experimental.
	HostPath *string `json:"hostPath" yaml:"hostPath"`
	// Mount consistency.
	//
	// Only applicable for macOS
	// See: https://docs.docker.com/storage/bind-mounts/#configure-mount-consistency-for-macos
	//
	// Experimental.
	Consistency DockerVolumeConsistency `json:"consistency" yaml:"consistency"`
}

A Docker volume.

TODO: EXAMPLE

Experimental.

type DockerVolumeConsistency ¶ 

type DockerVolumeConsistency string

Supported Docker volume consistency types.

Only valid on macOS due to the way file storage works on Mac Experimental. 

const (
	DockerVolumeConsistency_CONSISTENT DockerVolumeConsistency = "CONSISTENT"
	DockerVolumeConsistency_DELEGATED  DockerVolumeConsistency = "DELEGATED"
	DockerVolumeConsistency_CACHED     DockerVolumeConsistency = "CACHED"
)

type Duration ¶ 

type Duration interface {
	FormatTokenToNumber() *string
	IsUnresolved() *bool
	Minus(rhs Duration) Duration
	Plus(rhs Duration) Duration
	ToDays(opts *TimeConversionOptions) *float64
	ToHours(opts *TimeConversionOptions) *float64
	ToHumanString() *string
	ToIsoString() *string
	ToISOString() *string
	ToMilliseconds(opts *TimeConversionOptions) *float64
	ToMinutes(opts *TimeConversionOptions) *float64
	ToSeconds(opts *TimeConversionOptions) *float64
	ToString() *string
	UnitLabel() *string
}

Represents a length of time.

The amount can be specified either as a literal value (e.g: `10`) which cannot be negative, or as an unresolved number token.

When the amount is passed as a token, unit conversion is not possible.

TODO: EXAMPLE

Experimental.

func Duration_Days ¶ 

func Duration_Days(amount *float64) Duration

Create a Duration representing an amount of days.

Returns: a new `Duration` representing `amount` Days. Experimental.

func Duration_Hours ¶ 

func Duration_Hours(amount *float64) Duration

Create a Duration representing an amount of hours.

Returns: a new `Duration` representing `amount` Hours. Experimental.

func Duration_Millis ¶ 

func Duration_Millis(amount *float64) Duration

Create a Duration representing an amount of milliseconds.

Returns: a new `Duration` representing `amount` ms. Experimental.

func Duration_Minutes ¶ 

func Duration_Minutes(amount *float64) Duration

Create a Duration representing an amount of minutes.

Returns: a new `Duration` representing `amount` Minutes. Experimental.

func Duration_Parse ¶ 

func Duration_Parse(duration *string) Duration

Parse a period formatted according to the ISO 8601 standard.

Returns: the parsed `Duration`. See: https://www.iso.org/fr/standard/70907.html

Experimental.

func Duration_Seconds ¶ 

func Duration_Seconds(amount *float64) Duration

Create a Duration representing an amount of seconds.

Returns: a new `Duration` representing `amount` Seconds. Experimental.

type EncodingOptions ¶ 

type EncodingOptions struct {
	// A hint for the Token's purpose when stringifying it.
	// Experimental.
	DisplayHint *string `json:"displayHint" yaml:"displayHint"`
}

Properties to string encodings.

TODO: EXAMPLE

Experimental.

type Environment ¶ 

type Environment struct {
	// The AWS account ID for this environment.
	//
	// This can be either a concrete value such as `585191031104` or `Aws.accountId` which
	// indicates that account ID will only be determined during deployment (it
	// will resolve to the CloudFormation intrinsic `{"Ref":"AWS::AccountId"}`).
	// Note that certain features, such as cross-stack references and
	// environmental context providers require concerete region information and
	// will cause this stack to emit synthesis errors.
	// Experimental.
	Account *string `json:"account" yaml:"account"`
	// The AWS region for this environment.
	//
	// This can be either a concrete value such as `eu-west-2` or `Aws.region`
	// which indicates that account ID will only be determined during deployment
	// (it will resolve to the CloudFormation intrinsic `{"Ref":"AWS::Region"}`).
	// Note that certain features, such as cross-stack references and
	// environmental context providers require concerete region information and
	// will cause this stack to emit synthesis errors.
	// Experimental.
	Region *string `json:"region" yaml:"region"`
}

The deployment environment for a stack.

TODO: EXAMPLE

Experimental.

type Expiration ¶ 

type Expiration interface {
	Date() *time.Time
	IsAfter(t Duration) *bool
	IsBefore(t Duration) *bool
	ToEpoch() *float64
}

Represents a date of expiration.

The amount can be specified either as a Date object, timestamp, Duration or string.

TODO: EXAMPLE

Experimental.

func Expiration_After ¶ 

func Expiration_After(t Duration) Expiration

Expire once the specified duration has passed since deployment time. Experimental.

func Expiration_AtDate ¶ 

func Expiration_AtDate(d *time.Time) Expiration

Expire at the specified date. Experimental.

func Expiration_AtTimestamp ¶ 

func Expiration_AtTimestamp(t *float64) Expiration

Expire at the specified timestamp. Experimental.

func Expiration_FromString ¶ 

func Expiration_FromString(s *string) Expiration

Expire at specified date, represented as a string. Experimental.

type ExportValueOptions ¶ 

type ExportValueOptions struct {
	// The name of the export to create.
	// Experimental.
	Name *string `json:"name" yaml:"name"`
}

Options for the `stack.exportValue()` method.

TODO: EXAMPLE

Experimental.

type FeatureFlags ¶ 

type FeatureFlags interface {
	IsEnabled(featureFlag *string) *bool
}

Features that are implemented behind a flag in order to preserve backwards compatibility for existing apps.

The list of flags are available in the `@aws-cdk/cx-api` module.

The state of the flag for this application is stored as a CDK context variable.

TODO: EXAMPLE

Experimental.

func FeatureFlags_Of ¶ 

func FeatureFlags_Of(scope Construct) FeatureFlags

Inspect feature flags on the construct node's context. Experimental.

type FileAssetLocation ¶ 

type FileAssetLocation struct {
	// The name of the Amazon S3 bucket.
	// Experimental.
	BucketName *string `json:"bucketName" yaml:"bucketName"`
	// The HTTP URL of this asset on Amazon S3.
	//
	// This value suitable for inclusion in a CloudFormation template, and
	// may be an encoded token.
	//
	// Example value: `https://s3-us-east-1.amazonaws.com/mybucket/myobject`
	// Experimental.
	HttpUrl *string `json:"httpUrl" yaml:"httpUrl"`
	// The Amazon S3 object key.
	// Experimental.
	ObjectKey *string `json:"objectKey" yaml:"objectKey"`
	// The S3 URL of this asset on Amazon S3.
	//
	// This value suitable for inclusion in a CloudFormation template, and
	// may be an encoded token.
	//
	// Example value: `s3://mybucket/myobject`
	// Experimental.
	S3ObjectUrl *string `json:"s3ObjectUrl" yaml:"s3ObjectUrl"`
	// The ARN of the KMS key used to encrypt the file asset bucket, if any.
	//
	// If so, the consuming role should be given "kms:Decrypt" permissions in its
	// identity policy.
	//
	// It's the responsibility of they key's creator to make sure that all
	// consumers that the key's key policy is configured such that the key can be used
	// by all consumers that need it.
	//
	// The default bootstrap stack provisioned by the CDK CLI ensures this, and
	// can be used as an example for how to configure the key properly.
	// Deprecated: Since bootstrap bucket v4, the key policy properly allows use of the
	// key via the bucket and no additional parameters have to be granted anymore.
	KmsKeyArn *string `json:"kmsKeyArn" yaml:"kmsKeyArn"`
	// Like `s3ObjectUrl`, but not suitable for CloudFormation consumption.
	//
	// If there are placeholders in the S3 URL, they will be returned unreplaced
	// and un-evaluated.
	// Experimental.
	S3ObjectUrlWithPlaceholders *string `json:"s3ObjectUrlWithPlaceholders" yaml:"s3ObjectUrlWithPlaceholders"`
	// The HTTP URL of this asset on Amazon S3.
	// Deprecated: use `httpUrl`
	S3Url *string `json:"s3Url" yaml:"s3Url"`
}

The location of the published file asset.

This is where the asset can be consumed at runtime.

TODO: EXAMPLE

Experimental.

type FileAssetPackaging ¶ 

type FileAssetPackaging string

Packaging modes for file assets. Experimental. 

const (
	FileAssetPackaging_ZIP_DIRECTORY FileAssetPackaging = "ZIP_DIRECTORY"
	FileAssetPackaging_FILE          FileAssetPackaging = "FILE"
)

type FileAssetSource ¶ 

type FileAssetSource struct {
	// A hash on the content source.
	//
	// This hash is used to uniquely identify this
	// asset throughout the system. If this value doesn't change, the asset will
	// not be rebuilt or republished.
	// Experimental.
	SourceHash *string `json:"sourceHash" yaml:"sourceHash"`
	// An external command that will produce the packaged asset.
	//
	// The command should produce the location of a ZIP file on `stdout`.
	// Experimental.
	Executable *[]*string `json:"executable" yaml:"executable"`
	// The path, relative to the root of the cloud assembly, in which this asset source resides.
	//
	// This can be a path to a file or a directory, depending on the
	// packaging type.
	// Experimental.
	FileName *string `json:"fileName" yaml:"fileName"`
	// Which type of packaging to perform.
	// Experimental.
	Packaging FileAssetPackaging `json:"packaging" yaml:"packaging"`
}

Represents the source for a file asset.

TODO: EXAMPLE

Experimental.

type FileCopyOptions ¶ 

type FileCopyOptions struct {
	// Glob patterns to exclude from the copy.
	// Experimental.
	Exclude *[]*string `json:"exclude" yaml:"exclude"`
	// A strategy for how to handle symlinks.
	// Experimental.
	FollowSymlinks SymlinkFollowMode `json:"followSymlinks" yaml:"followSymlinks"`
	// The ignore behavior to use for exclude patterns.
	// Experimental.
	IgnoreMode IgnoreMode `json:"ignoreMode" yaml:"ignoreMode"`
}

Options applied when copying directories into the staging location.

TODO: EXAMPLE

Experimental.

type FileFingerprintOptions ¶ 

type FileFingerprintOptions struct {
	// Glob patterns to exclude from the copy.
	// Experimental.
	Exclude *[]*string `json:"exclude" yaml:"exclude"`
	// A strategy for how to handle symlinks.
	// Experimental.
	FollowSymlinks SymlinkFollowMode `json:"followSymlinks" yaml:"followSymlinks"`
	// The ignore behavior to use for exclude patterns.
	// Experimental.
	IgnoreMode IgnoreMode `json:"ignoreMode" yaml:"ignoreMode"`
	// Extra information to encode into the fingerprint (e.g. build instructions and other inputs).
	// Experimental.
	ExtraHash *string `json:"extraHash" yaml:"extraHash"`
}

Options related to calculating source hash.

TODO: EXAMPLE

Experimental.

type FileSystem ¶ 

type FileSystem interface {
}

File system utilities.

TODO: EXAMPLE

Experimental.

func NewFileSystem ¶ 

func NewFileSystem() FileSystem

Experimental.

type FingerprintOptions ¶ 

type FingerprintOptions struct {
	// Glob patterns to exclude from the copy.
	// Experimental.
	Exclude *[]*string `json:"exclude" yaml:"exclude"`
	// A strategy for how to handle symlinks.
	// Experimental.
	Follow SymlinkFollowMode `json:"follow" yaml:"follow"`
	// The ignore behavior to use for exclude patterns.
	// Experimental.
	IgnoreMode IgnoreMode `json:"ignoreMode" yaml:"ignoreMode"`
	// Extra information to encode into the fingerprint (e.g. build instructions and other inputs).
	// Experimental.
	ExtraHash *string `json:"extraHash" yaml:"extraHash"`
}

Options related to calculating source hash.

TODO: EXAMPLE

Experimental.

type Fn ¶ 

type Fn interface {
}

CloudFormation intrinsic functions.

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference.html

TODO: EXAMPLE

Experimental.

type GetContextKeyOptions ¶ 

type GetContextKeyOptions struct {
	// The context provider to query.
	// Experimental.
	Provider *string `json:"provider" yaml:"provider"`
	// Whether to include the stack's account and region automatically.
	// Experimental.
	IncludeEnvironment *bool `json:"includeEnvironment" yaml:"includeEnvironment"`
	// Provider-specific properties.
	// Experimental.
	Props *map[string]interface{} `json:"props" yaml:"props"`
}

TODO: EXAMPLE

Experimental.

type GetContextKeyResult ¶ 

type GetContextKeyResult struct {
	// Experimental.
	Key *string `json:"key" yaml:"key"`
	// Experimental.
	Props *map[string]interface{} `json:"props" yaml:"props"`
}

TODO: EXAMPLE

Experimental.

func ContextProvider_GetKey ¶ 

func ContextProvider_GetKey(scope constructs.Construct, options *GetContextKeyOptions) *GetContextKeyResult

Returns: the context key or undefined if a key cannot be rendered (due to tokens used in any of the props) Experimental.

type GetContextValueOptions ¶ 

type GetContextValueOptions struct {
	// The context provider to query.
	// Experimental.
	Provider *string `json:"provider" yaml:"provider"`
	// Whether to include the stack's account and region automatically.
	// Experimental.
	IncludeEnvironment *bool `json:"includeEnvironment" yaml:"includeEnvironment"`
	// Provider-specific properties.
	// Experimental.
	Props *map[string]interface{} `json:"props" yaml:"props"`
	// The value to return if the context value was not found and a missing context is reported.
	//
	// This should be a dummy value that should preferably
	// fail during deployment since it represents an invalid state.
	// Experimental.
	DummyValue interface{} `json:"dummyValue" yaml:"dummyValue"`
}

TODO: EXAMPLE

Experimental.

type GetContextValueResult ¶ 

type GetContextValueResult struct {
	// Experimental.
	Value interface{} `json:"value" yaml:"value"`
}

TODO: EXAMPLE

Experimental.

func ContextProvider_GetValue ¶ 

func ContextProvider_GetValue(scope constructs.Construct, options *GetContextValueOptions) *GetContextValueResult

Experimental.

type GitIgnoreStrategy ¶ 

type GitIgnoreStrategy interface {
	IgnoreStrategy
	Add(pattern *string)
	Ignores(absoluteFilePath *string) *bool
}

Ignores file paths based on the [`.gitignore specification`](https://git-scm.com/docs/gitignore).

TODO: EXAMPLE

Experimental.

func DockerIgnoreStrategy_Git ¶ 

func DockerIgnoreStrategy_Git(absoluteRootPath *string, patterns *[]*string) GitIgnoreStrategy

Ignores file paths based on the [`.gitignore specification`](https://git-scm.com/docs/gitignore).

Returns: `GitIgnorePattern` associated with the given patterns. Experimental.

func GitIgnoreStrategy_Git ¶ 

func GitIgnoreStrategy_Git(absoluteRootPath *string, patterns *[]*string) GitIgnoreStrategy

Ignores file paths based on the [`.gitignore specification`](https://git-scm.com/docs/gitignore).

Returns: `GitIgnorePattern` associated with the given patterns. Experimental.

func GlobIgnoreStrategy_Git ¶ 

func GlobIgnoreStrategy_Git(absoluteRootPath *string, patterns *[]*string) GitIgnoreStrategy

Ignores file paths based on the [`.gitignore specification`](https://git-scm.com/docs/gitignore).

Returns: `GitIgnorePattern` associated with the given patterns. Experimental.

func IgnoreStrategy_Git ¶ 

func IgnoreStrategy_Git(absoluteRootPath *string, patterns *[]*string) GitIgnoreStrategy

Ignores file paths based on the [`.gitignore specification`](https://git-scm.com/docs/gitignore).

Returns: `GitIgnorePattern` associated with the given patterns. Experimental.

func NewGitIgnoreStrategy ¶ 

func NewGitIgnoreStrategy(absoluteRootPath *string, patterns *[]*string) GitIgnoreStrategy

Experimental.

type GlobIgnoreStrategy ¶ 

type GlobIgnoreStrategy interface {
	IgnoreStrategy
	Add(pattern *string)
	Ignores(absoluteFilePath *string) *bool
}

Ignores file paths based on simple glob patterns.

TODO: EXAMPLE

Experimental.

func DockerIgnoreStrategy_Glob ¶ 

func DockerIgnoreStrategy_Glob(absoluteRootPath *string, patterns *[]*string) GlobIgnoreStrategy

Ignores file paths based on simple glob patterns.

Returns: `GlobIgnorePattern` associated with the given patterns. Experimental.

func GitIgnoreStrategy_Glob ¶ 

func GitIgnoreStrategy_Glob(absoluteRootPath *string, patterns *[]*string) GlobIgnoreStrategy

Ignores file paths based on simple glob patterns.

Returns: `GlobIgnorePattern` associated with the given patterns. Experimental.

func GlobIgnoreStrategy_Glob ¶ 

func GlobIgnoreStrategy_Glob(absoluteRootPath *string, patterns *[]*string) GlobIgnoreStrategy

Ignores file paths based on simple glob patterns.

Returns: `GlobIgnorePattern` associated with the given patterns. Experimental.

func IgnoreStrategy_Glob ¶ 

func IgnoreStrategy_Glob(absoluteRootPath *string, patterns *[]*string) GlobIgnoreStrategy

Ignores file paths based on simple glob patterns.

Returns: `GlobIgnorePattern` associated with the given patterns. Experimental.

func NewGlobIgnoreStrategy ¶ 

func NewGlobIgnoreStrategy(absoluteRootPath *string, patterns *[]*string) GlobIgnoreStrategy

Experimental.

type IAnyProducer ¶ 

type IAnyProducer interface {
	// Produce the value.
	// Experimental.
	Produce(context IResolveContext) interface{}
}

Interface for lazy untyped value producers. Experimental.

type IAspect ¶ 

type IAspect interface {
	// All aspects can visit an IConstruct.
	// Experimental.
	Visit(node IConstruct)
}

Represents an Aspect. Experimental.

type IAsset ¶ 

type IAsset interface {
	// A hash of this asset, which is available at construction time.
	//
	// As this is a plain string, it
	// can be used in construct IDs in order to enforce creation of a new resource when the content
	// hash has changed.
	// Experimental.
	AssetHash() *string
}

Common interface for all assets. Experimental.

type ICfnConditionExpression ¶ 

type ICfnConditionExpression interface {
	IResolvable
}

Represents a CloudFormation element that can be used within a Condition.

You can use intrinsic functions, such as “Fn.conditionIf“, “Fn.conditionEquals“, and “Fn.conditionNot“, to conditionally create stack resources. These conditions are evaluated based on input parameters that you declare when you create or update a stack. After you define all your conditions, you can associate them with resources or resource properties in the Resources and Outputs sections of a template.

You define all conditions in the Conditions section of a template except for “Fn.conditionIf“ conditions. You can use the “Fn.conditionIf“ condition in the metadata attribute, update policy attribute, and property values in the Resources section and Outputs sections of a template.

You might use conditions when you want to reuse a template that can create resources in different contexts, such as a test environment versus a production environment. In your template, you can add an EnvironmentType input parameter, which accepts either prod or test as inputs. For the production environment, you might include Amazon EC2 instances with certain capabilities; however, for the test environment, you want to use less capabilities to save costs. With conditions, you can define which resources are created and how they're configured for each environment type.

You can use `toString` when you wish to embed a condition expression in a property value that accepts a `string`. For example:

```ts 

new sqs.Queue(this, 'MyQueue', {
   queueName: Fn.conditionIf('Condition', 'Hello', 'World').toString()
});

``` Experimental.

type ICfnResourceOptions ¶ 

type ICfnResourceOptions interface {
	// A condition to associate with this resource.
	//
	// This means that only if the condition evaluates to 'true' when the stack
	// is deployed, the resource will be included. This is provided to allow CDK projects to produce legacy templates, but noramlly
	// there is no need to use it in CDK projects.
	// Experimental.
	Condition() CfnCondition
	// A condition to associate with this resource.
	//
	// This means that only if the condition evaluates to 'true' when the stack
	// is deployed, the resource will be included. This is provided to allow CDK projects to produce legacy templates, but noramlly
	// there is no need to use it in CDK projects.
	// Experimental.
	SetCondition(c CfnCondition)
	// 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. AWS CloudFormation publishes valid signals
	// to the stack events so that you track the number of signals sent.
	// Experimental.
	CreationPolicy() *CfnCreationPolicy
	// 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. AWS CloudFormation publishes valid signals
	// to the stack events so that you track the number of signals sent.
	// Experimental.
	SetCreationPolicy(c *CfnCreationPolicy)
	// With the DeletionPolicy attribute you can preserve or (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. Note that this capability also applies to update operations
	// that lead to resources being removed.
	// Experimental.
	DeletionPolicy() CfnDeletionPolicy
	// With the DeletionPolicy attribute you can preserve or (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. Note that this capability also applies to update operations
	// that lead to resources being removed.
	// Experimental.
	SetDeletionPolicy(d CfnDeletionPolicy)
	// The description of this resource.
	//
	// Used for informational purposes only, is not processed in any way
	// (and stays with the CloudFormation template, is not passed to the underlying resource,
	// even if it does have a 'description' property).
	// Experimental.
	Description() *string
	// The description of this resource.
	//
	// Used for informational purposes only, is not processed in any way
	// (and stays with the CloudFormation template, is not passed to the underlying resource,
	// even if it does have a 'description' property).
	// Experimental.
	SetDescription(d *string)
	// Metadata associated with the CloudFormation resource.
	//
	// This is not the same as the construct metadata which can be added
	// using construct.addMetadata(), but would not appear in the CloudFormation template automatically.
	// Experimental.
	Metadata() *map[string]interface{}
	// Metadata associated with the CloudFormation resource.
	//
	// This is not the same as the construct metadata which can be added
	// using construct.addMetadata(), but would not appear in the CloudFormation template automatically.
	// Experimental.
	SetMetadata(m *map[string]interface{})
	// Use the UpdatePolicy attribute to specify how AWS CloudFormation handles updates to the AWS::AutoScaling::AutoScalingGroup resource.
	//
	// AWS CloudFormation invokes one of three update policies depending on the type of change you make or whether a
	// scheduled action is associated with the Auto Scaling group.
	// Experimental.
	UpdatePolicy() *CfnUpdatePolicy
	// Use the UpdatePolicy attribute to specify how AWS CloudFormation handles updates to the AWS::AutoScaling::AutoScalingGroup resource.
	//
	// AWS CloudFormation invokes one of three update policies depending on the type of change you make or whether a
	// scheduled action is associated with the Auto Scaling group.
	// Experimental.
	SetUpdatePolicy(u *CfnUpdatePolicy)
	// Use the UpdateReplacePolicy attribute to retain or (in some cases) backup the existing physical instance of a resource when it is replaced during a stack update operation.
	// Experimental.
	UpdateReplacePolicy() CfnDeletionPolicy
	// Use the UpdateReplacePolicy attribute to retain or (in some cases) backup the existing physical instance of a resource when it is replaced during a stack update operation.
	// Experimental.
	SetUpdateReplacePolicy(u CfnDeletionPolicy)
	// The version of this resource.
	//
	// Used only for custom CloudFormation resources.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cfn-customresource.html
	//
	// Experimental.
	Version() *string
	// The version of this resource.
	//
	// Used only for custom CloudFormation resources.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cfn-customresource.html
	//
	// Experimental.
	SetVersion(v *string)
}

Experimental.

type ICfnRuleConditionExpression ¶ 

type ICfnRuleConditionExpression interface {
	ICfnConditionExpression
	// This field is only needed to defeat TypeScript's structural typing.
	//
	// It is never used.
	// Experimental.
	Disambiguator() *bool
}

Interface to specify certain functions as Service Catalog rule-specifc.

These functions can only be used in “Rules“ section of template. Experimental.

func Fn_ConditionAnd ¶ 

func Fn_ConditionAnd(conditions ...ICfnConditionExpression) ICfnRuleConditionExpression

Returns true if all the specified conditions evaluate to true, or returns false if any one of the conditions evaluates to false.

“Fn::And“ acts as an AND operator. The minimum number of conditions that you can include is 1.

Returns: an FnCondition token Experimental.

func Fn_ConditionContains ¶ 

func Fn_ConditionContains(listOfStrings *[]*string, value *string) ICfnRuleConditionExpression

Returns true if a specified string matches at least one value in a list of strings.

Returns: an FnCondition token Experimental.

func Fn_ConditionEachMemberEquals ¶ 

func Fn_ConditionEachMemberEquals(listOfStrings *[]*string, value *string) ICfnRuleConditionExpression

Returns true if a specified string matches all values in a list.

Returns: an FnCondition token Experimental.

func Fn_ConditionEachMemberIn ¶ 

func Fn_ConditionEachMemberIn(stringsToCheck *[]*string, stringsToMatch *[]*string) ICfnRuleConditionExpression

Returns true if each member in a list of strings matches at least one value in a second list of strings.

Returns: an FnCondition token Experimental.

func Fn_ConditionEquals ¶ 

func Fn_ConditionEquals(lhs interface{}, rhs interface{}) ICfnRuleConditionExpression

Compares if two values are equal.

Returns true if the two values are equal or false if they aren't.

Returns: an FnCondition token Experimental.

func Fn_ConditionIf ¶ 

func Fn_ConditionIf(conditionId *string, valueIfTrue interface{}, valueIfFalse interface{}) ICfnRuleConditionExpression

Returns one value if the specified condition evaluates to true and another value if the specified condition evaluates to false.

Currently, AWS CloudFormation supports the “Fn::If“ intrinsic function in the metadata attribute, update policy attribute, and property values in the Resources section and Outputs sections of a template. You can use the AWS::NoValue pseudo parameter as a return value to remove the corresponding property.

Returns: an FnCondition token Experimental.

func Fn_ConditionNot ¶ 

func Fn_ConditionNot(condition ICfnConditionExpression) ICfnRuleConditionExpression

Returns true for a condition that evaluates to false or returns false for a condition that evaluates to true.

“Fn::Not“ acts as a NOT operator.

Returns: an FnCondition token Experimental.

func Fn_ConditionOr ¶ 

func Fn_ConditionOr(conditions ...ICfnConditionExpression) ICfnRuleConditionExpression

Returns true if any one of the specified conditions evaluate to true, or returns false if all of the conditions evaluates to false.

“Fn::Or“ acts as an OR operator. The minimum number of conditions that you can include is 1.

Returns: an FnCondition token Experimental.

type IConstruct ¶ 

type IConstruct interface {
	constructs.IConstruct
	IDependable
	// The construct tree node for this construct.
	// Experimental.
	Node() ConstructNode
}

Represents a construct. Experimental.

type IDependable ¶ 

type IDependable interface {
}

Trait marker for classes that can be depended upon.

The presence of this interface indicates that an object has an `IDependableTrait` implementation.

This interface can be used to take an (ordering) dependency on a set of constructs. An ordering dependency implies that the resources represented by those constructs are deployed before the resources depending ON them are deployed. Experimental.

type IFragmentConcatenator ¶ 

type IFragmentConcatenator interface {
	// Join the fragment on the left and on the right.
	// Experimental.
	Join(left interface{}, right interface{}) interface{}
}

Function used to concatenate symbols in the target document language.

Interface so it could potentially be exposed over jsii. Experimental.

type IInspectable ¶ 

type IInspectable interface {
	// Examines construct.
	// Experimental.
	Inspect(inspector TreeInspector)
}

Interface for examining a construct and exposing metadata. Experimental.

type IListProducer ¶ 

type IListProducer interface {
	// Produce the list value.
	// Experimental.
	Produce(context IResolveContext) *[]*string
}

Interface for lazy list producers. Experimental.

type ILocalBundling ¶ 

type ILocalBundling interface {
	// This method is called before attempting docker bundling to allow the bundler to be executed locally.
	//
	// If the local bundler exists, and bundling
	// was performed locally, return `true`. Otherwise, return `false`.
	// Experimental.
	TryBundle(outputDir *string, options *BundlingOptions) *bool
}

Local bundling. Experimental.

type INumberProducer ¶ 

type INumberProducer interface {
	// Produce the number value.
	// Experimental.
	Produce(context IResolveContext) *float64
}

Interface for lazy number producers. Experimental.

type IPostProcessor ¶ 

type IPostProcessor interface {
	// Process the completely resolved value, after full recursion/resolution has happened.
	// Experimental.
	PostProcess(input interface{}, context IResolveContext) interface{}
}

A Token that can post-process the complete resolved value, after resolve() has recursed over it. Experimental.

type IResolvable ¶ 

type IResolvable interface {
	// Produce the Token's value at resolution time.
	// Experimental.
	Resolve(context IResolveContext) interface{}
	// Return a string representation of this resolvable object.
	//
	// Returns a reversible string representation.
	// Experimental.
	ToString() *string
	// The creation stack of this resolvable which will be appended to errors thrown during resolution.
	//
	// This may return an array with a single informational element indicating how
	// to get this property populated, if it was skipped for performance reasons.
	// Experimental.
	CreationStack() *[]*string
}

Interface for values that can be resolvable later.

Tokens are special objects that participate in synthesis. Experimental.

func Fn_GetAtt ¶ 

func Fn_GetAtt(logicalNameOfResource *string, attributeName *string) IResolvable

The “Fn::GetAtt“ intrinsic function returns the value of an attribute from a resource in the template.

Returns: an IResolvable object Experimental.

func Fn_Transform ¶ 

func Fn_Transform(macroName *string, parameters *map[string]interface{}) IResolvable

Creates a token representing the “Fn::Transform“ expression.

Returns: a token representing the transform expression See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-transform.html

Experimental.

func Lazy_Any ¶ 

func Lazy_Any(producer IStableAnyProducer, options *LazyAnyValueOptions) IResolvable

Defer the one-time calculation of an arbitrarily typed value to synthesis time.

Use this if you want to render an object to a template whose actual value depends on some state mutation that may happen after the construct has been created.

The inner function will only be invoked one time and cannot depend on resolution context. Experimental.

func Lazy_AnyValue ¶ 

func Lazy_AnyValue(producer IAnyProducer, options *LazyAnyValueOptions) IResolvable

Defer the one-time calculation of an arbitrarily typed value to synthesis time.

Use this if you want to render an object to a template whose actual value depends on some state mutation that may happen after the construct has been created. Deprecated: Use `Lazy.any()` or `Lazy.uncachedAny()` instead.

func Lazy_UncachedAny ¶ 

func Lazy_UncachedAny(producer IAnyProducer, options *LazyAnyValueOptions) IResolvable

Defer the calculation of an untyped value to synthesis time.

Use of this function is not recommended; unless you know you need it for sure, you probably don't. Use `Lazy.any()` instead.

The inner function may be invoked multiple times during synthesis. You should only use this method if the returned value depends on variables that may change during the Aspect application phase of synthesis, or if the value depends on the Stack the value is being used in. Both of these cases are rare, and only ever occur for AWS Construct Library authors. Experimental.

func Token_AsAny ¶ 

func Token_AsAny(value interface{}) IResolvable

Return a resolvable representation of the given value. Experimental.

func Tokenization_Reverse ¶ 

func Tokenization_Reverse(x interface{}, options *ReverseOptions) IResolvable

Reverse any value into a Resolvable, if possible.

In case of a string, the string must not be a concatenation. Experimental.

func Tokenization_ReverseCompleteString ¶ 

func Tokenization_ReverseCompleteString(s *string) IResolvable

Un-encode a string which is either a complete encoded token, or doesn't contain tokens at all.

It's illegal for the string to be a concatenation of an encoded token and something else. Experimental.

func Tokenization_ReverseList ¶ 

func Tokenization_ReverseList(l *[]*string) IResolvable

Un-encode a Tokenized value from a list. Experimental.

func Tokenization_ReverseNumber ¶ 

func Tokenization_ReverseNumber(n *float64) IResolvable

Un-encode a Tokenized value from a number. Experimental.

type IResolveContext ¶ 

type IResolveContext interface {
	// Use this postprocessor after the entire token structure has been resolved.
	// Experimental.
	RegisterPostProcessor(postProcessor IPostProcessor)
	// Resolve an inner object.
	// Experimental.
	Resolve(x interface{}, options *ResolveChangeContextOptions) interface{}
	// True when we are still preparing, false if we're rendering the final output.
	// Experimental.
	Preparing() *bool
	// The scope from which resolution has been initiated.
	// Experimental.
	Scope() IConstruct
}

Current resolution context for tokens. Experimental.

type IResource ¶ 

type IResource interface {
	IConstruct
	// Apply the given removal policy to this resource.
	//
	// 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`).
	// Experimental.
	ApplyRemovalPolicy(policy RemovalPolicy)
	// The environment this resource belongs to.
	//
	// For resources that are created and managed by the CDK
	// (generally, those created by creating new class instances like Role, Bucket, etc.),
	// this is always the same as the environment of the stack they belong to;
	// however, for imported resources
	// (those obtained from static methods like fromRoleArn, fromBucketName, etc.),
	// that might be different than the stack they were imported into.
	// Experimental.
	Env() *ResourceEnvironment
	// The stack in which this resource is defined.
	// Experimental.
	Stack() Stack
}

Interface for the Resource construct. Experimental.

type IStableAnyProducer ¶ 

type IStableAnyProducer interface {
	// Produce the value.
	// Experimental.
	Produce() interface{}
}

Interface for (stable) lazy untyped value producers. Experimental.

type IStableListProducer ¶ 

type IStableListProducer interface {
	// Produce the list value.
	// Experimental.
	Produce() *[]*string
}

Interface for (stable) lazy list producers. Experimental.

type IStableNumberProducer ¶ 

type IStableNumberProducer interface {
	// Produce the number value.
	// Experimental.
	Produce() *float64
}

Interface for (stable) lazy number producers. Experimental.

type IStableStringProducer ¶ 

type IStableStringProducer interface {
	// Produce the string value.
	// Experimental.
	Produce() *string
}

Interface for (stable) lazy string producers. Experimental.

type IStackSynthesizer ¶ 

type IStackSynthesizer interface {
	// Register a Docker Image Asset.
	//
	// Returns the parameters that can be used to refer to the asset inside the template.
	// Experimental.
	AddDockerImageAsset(asset *DockerImageAssetSource) *DockerImageAssetLocation
	// Register a File Asset.
	//
	// Returns the parameters that can be used to refer to the asset inside the template.
	// Experimental.
	AddFileAsset(asset *FileAssetSource) *FileAssetLocation
	// Bind to the stack this environment is going to be used on.
	//
	// Must be called before any of the other methods are called.
	// Experimental.
	Bind(stack Stack)
	// Synthesize the associated stack to the session.
	// Experimental.
	Synthesize(session ISynthesisSession)
}

Encodes information how a certain Stack should be deployed. Experimental.

type IStringProducer ¶ 

type IStringProducer interface {
	// Produce the string value.
	// Experimental.
	Produce(context IResolveContext) *string
}

Interface for lazy string producers. Experimental.

type ISynthesisSession ¶ 

type ISynthesisSession interface {
	// Cloud assembly builder.
	// Experimental.
	Assembly() cxapi.CloudAssemblyBuilder
	// Cloud assembly builder.
	// Experimental.
	SetAssembly(a cxapi.CloudAssemblyBuilder)
	// The output directory for this synthesis session.
	// Experimental.
	Outdir() *string
	// The output directory for this synthesis session.
	// Experimental.
	SetOutdir(o *string)
	// Whether the stack should be validated after synthesis to check for error metadata.
	// Experimental.
	ValidateOnSynth() *bool
	// Whether the stack should be validated after synthesis to check for error metadata.
	// Experimental.
	SetValidateOnSynth(v *bool)
}

Represents a single session of synthesis.

Passed into `Construct.synthesize()` methods. Experimental.

type ITaggable ¶ 

type ITaggable interface {
	// TagManager to set, remove and format tags.
	// Experimental.
	Tags() TagManager
}

Interface to implement tags. Experimental.

type ITemplateOptions ¶ 

type ITemplateOptions interface {
	// Gets or sets the description of this stack.
	//
	// If provided, it will be included in the CloudFormation template's "Description" attribute.
	// Experimental.
	Description() *string
	// Gets or sets the description of this stack.
	//
	// If provided, it will be included in the CloudFormation template's "Description" attribute.
	// Experimental.
	SetDescription(d *string)
	// Metadata associated with the CloudFormation template.
	// Experimental.
	Metadata() *map[string]interface{}
	// Metadata associated with the CloudFormation template.
	// Experimental.
	SetMetadata(m *map[string]interface{})
	// Gets or sets the AWSTemplateFormatVersion field of the CloudFormation template.
	// Experimental.
	TemplateFormatVersion() *string
	// Gets or sets the AWSTemplateFormatVersion field of the CloudFormation template.
	// Experimental.
	SetTemplateFormatVersion(t *string)
	// Gets or sets the top-level template transform for this stack (e.g. "AWS::Serverless-2016-10-31").
	// Deprecated: use `transforms` instead.
	Transform() *string
	// Gets or sets the top-level template transform for this stack (e.g. "AWS::Serverless-2016-10-31").
	// Deprecated: use `transforms` instead.
	SetTransform(t *string)
	// Gets or sets the top-level template transform(s) for this stack (e.g. `["AWS::Serverless-2016-10-31"]`).
	// Experimental.
	Transforms() *[]*string
	// Gets or sets the top-level template transform(s) for this stack (e.g. `["AWS::Serverless-2016-10-31"]`).
	// Experimental.
	SetTransforms(t *[]*string)
}

CloudFormation template options for a stack. Experimental.

type ITokenMapper ¶ 

type ITokenMapper interface {
	// Replace a single token.
	// Experimental.
	MapToken(t IResolvable) interface{}
}

Interface to apply operation to tokens in a string.

Interface so it can be exported via jsii. Experimental.

type ITokenResolver ¶ 

type ITokenResolver interface {
	// Resolve a tokenized list.
	// Experimental.
	ResolveList(l *[]*string, context IResolveContext) interface{}
	// Resolve a string with at least one stringified token in it.
	//
	// (May use concatenation)
	// Experimental.
	ResolveString(s TokenizedStringFragments, context IResolveContext) interface{}
	// Resolve a single token.
	// Experimental.
	ResolveToken(t IResolvable, context IResolveContext, postProcessor IPostProcessor) interface{}
}

How to resolve tokens. Experimental.

type IgnoreMode ¶ 

type IgnoreMode string

Determines the ignore behavior to use. Experimental. 

const (
	IgnoreMode_GLOB   IgnoreMode = "GLOB"
	IgnoreMode_GIT    IgnoreMode = "GIT"
	IgnoreMode_DOCKER IgnoreMode = "DOCKER"
)

type IgnoreStrategy ¶ 

type IgnoreStrategy interface {
	Add(pattern *string)
	Ignores(absoluteFilePath *string) *bool
}

Represents file path ignoring behavior.

TODO: EXAMPLE

Experimental.

func DockerIgnoreStrategy_FromCopyOptions ¶ 

func DockerIgnoreStrategy_FromCopyOptions(options *CopyOptions, absoluteRootPath *string) IgnoreStrategy

Creates an IgnoreStrategy based on the `ignoreMode` and `exclude` in a `CopyOptions`.

Returns: `IgnoreStrategy` based on the `CopyOptions` Experimental.

func GitIgnoreStrategy_FromCopyOptions ¶ 

func GitIgnoreStrategy_FromCopyOptions(options *CopyOptions, absoluteRootPath *string) IgnoreStrategy

Creates an IgnoreStrategy based on the `ignoreMode` and `exclude` in a `CopyOptions`.

Returns: `IgnoreStrategy` based on the `CopyOptions` Experimental.

func GlobIgnoreStrategy_FromCopyOptions ¶ 

func GlobIgnoreStrategy_FromCopyOptions(options *CopyOptions, absoluteRootPath *string) IgnoreStrategy

Creates an IgnoreStrategy based on the `ignoreMode` and `exclude` in a `CopyOptions`.

Returns: `IgnoreStrategy` based on the `CopyOptions` Experimental.

func IgnoreStrategy_FromCopyOptions ¶ 

func IgnoreStrategy_FromCopyOptions(options *CopyOptions, absoluteRootPath *string) IgnoreStrategy

Creates an IgnoreStrategy based on the `ignoreMode` and `exclude` in a `CopyOptions`.

Returns: `IgnoreStrategy` based on the `CopyOptions` Experimental.

type Intrinsic ¶ 

type Intrinsic interface {
	IResolvable
	CreationStack() *[]*string
	NewError(message *string) interface{}
	Resolve(_context IResolveContext) interface{}
	ToJSON() interface{}
	ToString() *string
}

Token subclass that represents values intrinsic to the target document language.

WARNING: this class should not be externally exposed, but is currently visible because of a limitation of jsii (https://github.com/aws/jsii/issues/524).

This class will disappear in a future release and should not be used.

TODO: EXAMPLE

Experimental.

func NewIntrinsic ¶ 

func NewIntrinsic(value interface{}, options *IntrinsicProps) Intrinsic

Experimental.

type IntrinsicProps ¶ 

type IntrinsicProps struct {
	// Capture the stack trace of where this token is created.
	// Experimental.
	StackTrace *bool `json:"stackTrace" yaml:"stackTrace"`
}

Customization properties for an Intrinsic token.

TODO: EXAMPLE

Experimental.

type Lazy ¶ 

type Lazy interface {
}

Lazily produce a value.

Can be used to return a string, list or numeric value whose actual value will only be calculated later, during synthesis. Experimental.

type LazyAnyValueOptions ¶ 

type LazyAnyValueOptions struct {
	// Use the given name as a display hint.
	// Experimental.
	DisplayHint *string `json:"displayHint" yaml:"displayHint"`
	// If the produced value is an array and it is empty, return 'undefined' instead.
	// Experimental.
	OmitEmptyArray *bool `json:"omitEmptyArray" yaml:"omitEmptyArray"`
}

Options for creating lazy untyped tokens.

TODO: EXAMPLE

Experimental.

type LazyListValueOptions ¶ 

type LazyListValueOptions struct {
	// Use the given name as a display hint.
	// Experimental.
	DisplayHint *string `json:"displayHint" yaml:"displayHint"`
	// If the produced list is empty, return 'undefined' instead.
	// Experimental.
	OmitEmpty *bool `json:"omitEmpty" yaml:"omitEmpty"`
}

Options for creating a lazy list token.

TODO: EXAMPLE

Experimental.

type LazyStringValueOptions ¶ 

type LazyStringValueOptions struct {
	// Use the given name as a display hint.
	// Experimental.
	DisplayHint *string `json:"displayHint" yaml:"displayHint"`
}

Options for creating a lazy string token.

TODO: EXAMPLE

Experimental.

type LegacyStackSynthesizer ¶ 

type LegacyStackSynthesizer interface {
	StackSynthesizer
	AddDockerImageAsset(asset *DockerImageAssetSource) *DockerImageAssetLocation
	AddFileAsset(asset *FileAssetSource) *FileAssetLocation
	Bind(stack Stack)
	EmitStackArtifact(stack Stack, session ISynthesisSession, options *SynthesizeStackArtifactOptions)
	Synthesize(session ISynthesisSession)
	SynthesizeStackTemplate(stack Stack, session ISynthesisSession)
}

Use the CDK classic way of referencing assets.

This synthesizer will generate CloudFormation parameters for every referenced asset, and use the CLI's current credentials to deploy the stack.

  • It does not support cross-account deployment (the CLI must have credentials to the account you are trying to deploy to).
  • It cannot be used with **CDK Pipelines**. To deploy using CDK Pipelines, you must use the `DefaultStackSynthesizer`.
  • Each asset will take up a CloudFormation Parameter in your template. Keep in mind that there is a maximum of 200 parameters in a CloudFormation template. To use determinstic asset locations instead, use `CliCredentialsStackSynthesizer`.

Be aware that your CLI credentials must be valid for the duration of the entire deployment. If you are using session credentials, make sure the session lifetime is long enough.

This is the only StackSynthesizer that supports customizing asset behavior by overriding `Stack.addFileAsset()` and `Stack.addDockerImageAsset()`.

TODO: EXAMPLE

Experimental.

func NewLegacyStackSynthesizer ¶ 

func NewLegacyStackSynthesizer() LegacyStackSynthesizer

Experimental.

type Names ¶ 

type Names interface {
}

Functions for devising unique names for constructs.

For example, those can be used to allocate unique physical names for resources. Experimental.

type NestedStack ¶ 

type NestedStack interface {
	Stack
	Account() *string
	ArtifactId() *string
	AvailabilityZones() *[]*string
	Dependencies() *[]Stack
	Environment() *string
	Nested() *bool
	NestedStackParent() Stack
	NestedStackResource() CfnResource
	Node() ConstructNode
	NotificationArns() *[]*string
	ParentStack() Stack
	Partition() *string
	Region() *string
	StackId() *string
	StackName() *string
	Synthesizer() IStackSynthesizer
	Tags() TagManager
	TemplateFile() *string
	TemplateOptions() ITemplateOptions
	TerminationProtection() *bool
	UrlSuffix() *string
	AddDependency(target Stack, reason *string)
	AddDockerImageAsset(asset *DockerImageAssetSource) *DockerImageAssetLocation
	AddFileAsset(asset *FileAssetSource) *FileAssetLocation
	AddTransform(transform *string)
	AllocateLogicalId(cfnElement CfnElement) *string
	ExportValue(exportedValue interface{}, options *ExportValueOptions) *string
	FormatArn(components *ArnComponents) *string
	GetLogicalId(element CfnElement) *string
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	ParseArn(arn *string, sepIfToken *string, hasName *bool) *ArnComponents
	Prepare()
	PrepareCrossReference(_sourceStack Stack, reference Reference) IResolvable
	RegionalFact(factName *string, defaultValue *string) *string
	RenameLogicalId(oldId *string, newId *string)
	ReportMissingContext(report *cxapi.MissingContext)
	ReportMissingContextKey(report *cloudassemblyschema.MissingContext)
	Resolve(obj interface{}) interface{}
	SetParameter(name *string, value *string)
	SplitArn(arn *string, arnFormat ArnFormat) *ArnComponents
	Synthesize(session ISynthesisSession)
	ToJsonString(obj interface{}, space *float64) *string
	ToString() *string
	Validate() *[]*string
}

A CloudFormation nested stack.

When you apply template changes to update a top-level stack, CloudFormation updates the top-level stack and initiates an update to its nested stacks. CloudFormation updates the resources of modified nested stacks, but does not update the resources of unmodified nested stacks.

Furthermore, this stack will not be treated as an independent deployment artifact (won't be listed in "cdk list" or deployable through "cdk deploy"), but rather only synthesized as a template and uploaded as an asset to S3.

Cross references of resource attributes between the parent stack and the nested stack will automatically be translated to stack parameters and outputs.

TODO: EXAMPLE

Experimental.

func NewNestedStack ¶ 

func NewNestedStack(scope constructs.Construct, id *string, props *NestedStackProps) NestedStack

Experimental.

type NestedStackProps ¶ 

type NestedStackProps struct {
	// The Simple Notification Service (SNS) topics to publish stack related events.
	// Experimental.
	NotificationArns *[]*string `json:"notificationArns" yaml:"notificationArns"`
	// The set value pairs that represent the parameters passed to CloudFormation when this nested stack is created.
	//
	// Each parameter has a name corresponding
	// to a parameter defined in the embedded template and a value representing
	// the value that you want to set for the parameter.
	//
	// The nested stack construct will automatically synthesize parameters in order
	// to bind references from the parent stack(s) into the nested stack.
	// Experimental.
	Parameters *map[string]*string `json:"parameters" yaml:"parameters"`
	// Policy to apply when the nested stack is removed.
	//
	// The default is `Destroy`, because all Removal Policies of resources inside the
	// Nested Stack should already have been set correctly. You normally should
	// not need to set this value.
	// Experimental.
	RemovalPolicy RemovalPolicy `json:"removalPolicy" yaml:"removalPolicy"`
	// The length of time that CloudFormation waits for the nested stack to reach the CREATE_COMPLETE state.
	//
	// When CloudFormation detects that the nested stack has reached the
	// CREATE_COMPLETE state, it marks the nested stack resource as
	// CREATE_COMPLETE in the parent stack and resumes creating the parent stack.
	// If the timeout period expires before the nested stack reaches
	// CREATE_COMPLETE, CloudFormation marks the nested stack as failed and rolls
	// back both the nested stack and parent stack.
	// Experimental.
	Timeout Duration `json:"timeout" yaml:"timeout"`
}

Initialization props for the `NestedStack` construct.

TODO: EXAMPLE

Experimental.

type NestedStackSynthesizer ¶ 

type NestedStackSynthesizer interface {
	StackSynthesizer
	AddDockerImageAsset(asset *DockerImageAssetSource) *DockerImageAssetLocation
	AddFileAsset(asset *FileAssetSource) *FileAssetLocation
	Bind(stack Stack)
	EmitStackArtifact(stack Stack, session ISynthesisSession, options *SynthesizeStackArtifactOptions)
	Synthesize(session ISynthesisSession)
	SynthesizeStackTemplate(stack Stack, session ISynthesisSession)
}

Synthesizer for a nested stack.

Forwards all calls to the parent stack's synthesizer.

This synthesizer is automatically used for `NestedStack` constructs. App builder do not need to use this class directly.

TODO: EXAMPLE

Experimental.

func NewNestedStackSynthesizer ¶ 

func NewNestedStackSynthesizer(parentDeployment IStackSynthesizer) NestedStackSynthesizer

Experimental.

type PhysicalName ¶ 

type PhysicalName interface {
}

Includes special markers for automatic generation of physical names. Experimental.

type Reference ¶ 

type Reference interface {
	Intrinsic
	CreationStack() *[]*string
	DisplayName() *string
	Target() IConstruct
	NewError(message *string) interface{}
	Resolve(_context IResolveContext) interface{}
	ToJSON() interface{}
	ToString() *string
}

An intrinsic Token that represents a reference to a construct.

References are recorded. Experimental.

type RemovalPolicy ¶ 

type RemovalPolicy string

Possible values for a resource's Removal Policy.

The removal policy controls what happens to the resource if it stops being managed by CloudFormation. This can happen in one of three situations:

  • The resource is removed from the template, so CloudFormation stops managing it;
  • A change to the resource is made that requires it to be replaced, so CloudFormation stops managing it;
  • The stack is deleted, so CloudFormation stops managing all resources in it.

The Removal Policy applies to all above cases.

Many stateful resources in the AWS Construct Library will accept a `removalPolicy` as a property, typically defaulting it to `RETAIN`.

If the AWS Construct Library resource does not accept a `removalPolicy` argument, you can always configure it by using the escape hatch mechanism, as shown in the following example:

```ts declare const bucket: s3.Bucket;

const cfnBucket = bucket.node.findChild('Resource') as CfnResource; cfnBucket.applyRemovalPolicy(RemovalPolicy.DESTROY); ```

TODO: EXAMPLE

Experimental. 

const (
	RemovalPolicy_DESTROY  RemovalPolicy = "DESTROY"
	RemovalPolicy_RETAIN   RemovalPolicy = "RETAIN"
	RemovalPolicy_SNAPSHOT RemovalPolicy = "SNAPSHOT"
)

type RemovalPolicyOptions ¶ 

type RemovalPolicyOptions struct {
	// Apply the same deletion policy to the resource's "UpdateReplacePolicy".
	// Experimental.
	ApplyToUpdateReplacePolicy *bool `json:"applyToUpdateReplacePolicy" yaml:"applyToUpdateReplacePolicy"`
	// The default policy to apply in case the removal policy is not defined.
	// Experimental.
	Default RemovalPolicy `json:"default" yaml:"default"`
}

TODO: EXAMPLE

Experimental.

type RemoveTag ¶ 

type RemoveTag interface {
	IAspect
	Key() *string
	Props() *TagProps
	ApplyTag(resource ITaggable)
	Visit(construct IConstruct)
}

The RemoveTag Aspect will handle removing tags from this node and children.

TODO: EXAMPLE

Experimental.

func NewRemoveTag ¶ 

func NewRemoveTag(key *string, props *TagProps) RemoveTag

Experimental.

type ResolveChangeContextOptions ¶ 

type ResolveChangeContextOptions struct {
	// Change the 'allowIntrinsicKeys' option.
	// Experimental.
	AllowIntrinsicKeys *bool `json:"allowIntrinsicKeys" yaml:"allowIntrinsicKeys"`
}

Options that can be changed while doing a recursive resolve.

TODO: EXAMPLE

Experimental.

type ResolveOptions ¶ 

type ResolveOptions struct {
	// The resolver to apply to any resolvable tokens found.
	// Experimental.
	Resolver ITokenResolver `json:"resolver" yaml:"resolver"`
	// The scope from which resolution is performed.
	// Experimental.
	Scope constructs.IConstruct `json:"scope" yaml:"scope"`
	// Whether the resolution is being executed during the prepare phase or not.
	// Experimental.
	Preparing *bool `json:"preparing" yaml:"preparing"`
	// Whether to remove undefined elements from arrays and objects when resolving.
	// Experimental.
	RemoveEmpty *bool `json:"removeEmpty" yaml:"removeEmpty"`
}

Options to the resolve() operation.

NOT the same as the ResolveContext; ResolveContext is exposed to Token implementors and resolution hooks, whereas this struct is just to bundle a number of things that would otherwise be arguments to resolve() in a readable way.

TODO: EXAMPLE

Experimental.

type Resource ¶ 

type Resource interface {
	Construct
	IResource
	Env() *ResourceEnvironment
	Node() ConstructNode
	PhysicalName() *string
	Stack() Stack
	ApplyRemovalPolicy(policy RemovalPolicy)
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	Prepare()
	Synthesize(session ISynthesisSession)
	ToString() *string
	Validate() *[]*string
}

A construct which represents an AWS resource. Experimental.

type ResourceEnvironment ¶ 

type ResourceEnvironment struct {
	// The AWS account ID that this resource belongs to.
	//
	// Since this can be a Token
	// (for example, when the account is CloudFormation's AWS::AccountId intrinsic),
	// make sure to use Token.compareStrings()
	// instead of just comparing the values for equality.
	// Experimental.
	Account *string `json:"account" yaml:"account"`
	// The AWS region that this resource belongs to.
	//
	// Since this can be a Token
	// (for example, when the region is CloudFormation's AWS::Region intrinsic),
	// make sure to use Token.compareStrings()
	// instead of just comparing the values for equality.
	// Experimental.
	Region *string `json:"region" yaml:"region"`
}

Represents the environment a given resource lives in.

Used as the return value for the {@link IResource.env} property.

TODO: EXAMPLE

Experimental.

type ResourceProps ¶ 

type ResourceProps struct {
	// The AWS account ID this resource belongs to.
	// Experimental.
	Account *string `json:"account" yaml:"account"`
	// ARN to deduce region and account from.
	//
	// The ARN is parsed and the account and region are taken from the ARN.
	// This should be used for imported resources.
	//
	// Cannot be supplied together with either `account` or `region`.
	// Experimental.
	EnvironmentFromArn *string `json:"environmentFromArn" yaml:"environmentFromArn"`
	// The value passed in by users to the physical name prop of the resource.
	//
	// - `undefined` implies that a physical name will be allocated by
	//    CloudFormation during deployment.
	// - a concrete value implies a specific physical name
	// - `PhysicalName.GENERATE_IF_NEEDED` is a marker that indicates that a physical will only be generated
	//    by the CDK if it is needed for cross-environment references. Otherwise, it will be allocated by CloudFormation.
	// Experimental.
	PhysicalName *string `json:"physicalName" yaml:"physicalName"`
	// The AWS region this resource belongs to.
	// Experimental.
	Region *string `json:"region" yaml:"region"`
}

Construction properties for {@link Resource}.

TODO: EXAMPLE

Experimental.

type ReverseOptions ¶ 

type ReverseOptions struct {
	// Fail if the given string is a concatenation.
	//
	// If `false`, just return `undefined`.
	// Experimental.
	FailConcat *bool `json:"failConcat" yaml:"failConcat"`
}

Options for the 'reverse()' operation.

TODO: EXAMPLE

Experimental.

type ScopedAws ¶ 

type ScopedAws interface {
	AccountId() *string
	NotificationArns() *[]*string
	Partition() *string
	Region() *string
	StackId() *string
	StackName() *string
	UrlSuffix() *string
}

Accessor for scoped pseudo parameters.

These pseudo parameters are anchored to a stack somewhere in the construct tree, and their values will be exported automatically.

TODO: EXAMPLE

Experimental.

func NewScopedAws ¶ 

func NewScopedAws(scope Construct) ScopedAws

Experimental.

type SecretValue ¶ 

type SecretValue interface {
	Intrinsic
	CreationStack() *[]*string
	NewError(message *string) interface{}
	Resolve(_context IResolveContext) interface{}
	ToJSON() interface{}
	ToString() *string
}

Work with secret values in the CDK.

Secret values in the CDK (such as those retrieved from SecretsManager) are represented as regular strings, just like other values that are only available at deployment time.

To help you avoid accidental mistakes which would lead to you putting your secret values directly into a CloudFormation template, constructs that take secret values will not allow you to pass in a literal secret value. They do so by calling `Secret.assertSafeSecret()`.

You can escape the check by calling `Secret.plainText()`, but doing so is highly discouraged.

TODO: EXAMPLE

Experimental.

func NewSecretValue ¶ 

func NewSecretValue(value interface{}, options *IntrinsicProps) SecretValue

Experimental.

func SecretValue_CfnDynamicReference ¶ 

func SecretValue_CfnDynamicReference(ref CfnDynamicReference) SecretValue

Obtain the secret value through a CloudFormation dynamic reference.

If possible, use `SecretValue.ssmSecure` or `SecretValue.secretsManager` directly. Experimental.

func SecretValue_CfnParameter ¶ 

func SecretValue_CfnParameter(param CfnParameter) SecretValue

Obtain the secret value through a CloudFormation parameter.

Generally, this is not a recommended approach. AWS Secrets Manager is the recommended way to reference secrets. Experimental.

func SecretValue_PlainText ¶ 

func SecretValue_PlainText(secret *string) SecretValue

Construct a literal secret value for use with secret-aware constructs.

*Do not use this method for any secrets that you care about.*

The only reasonable use case for using this method is when you are testing. Experimental.

func SecretValue_SecretsManager ¶ 

func SecretValue_SecretsManager(secretId *string, options *SecretsManagerSecretOptions) SecretValue

Creates a `SecretValue` with a value which is dynamically loaded from AWS Secrets Manager. Experimental.

func SecretValue_SsmSecure ¶ 

func SecretValue_SsmSecure(parameterName *string, version *string) SecretValue

Use a secret value stored from a Systems Manager (SSM) parameter. Experimental.

type SecretsManagerSecretOptions ¶ 

type SecretsManagerSecretOptions struct {
	// The key of a JSON field to retrieve.
	//
	// This can only be used if the secret
	// stores a JSON object.
	// Experimental.
	JsonField *string `json:"jsonField" yaml:"jsonField"`
	// Specifies the unique identifier of the version of the secret you want to use.
	//
	// Can specify at most one of `versionId` and `versionStage`.
	// Experimental.
	VersionId *string `json:"versionId" yaml:"versionId"`
	// Specifies the secret version that you want to retrieve by the staging label attached to the version.
	//
	// Can specify at most one of `versionId` and `versionStage`.
	// Experimental.
	VersionStage *string `json:"versionStage" yaml:"versionStage"`
}

Options for referencing a secret value from Secrets Manager.

TODO: EXAMPLE

Experimental.

type Size ¶ 

type Size interface {
	ToGibibytes(opts *SizeConversionOptions) *float64
	ToKibibytes(opts *SizeConversionOptions) *float64
	ToMebibytes(opts *SizeConversionOptions) *float64
	ToPebibytes(opts *SizeConversionOptions) *float64
	ToTebibytes(opts *SizeConversionOptions) *float64
}

Represents the amount of digital storage.

The amount can be specified either as a literal value (e.g: `10`) which cannot be negative, or as an unresolved number token.

When the amount is passed as a token, unit conversion is not possible.

TODO: EXAMPLE

Experimental.

func Size_Gibibytes ¶ 

func Size_Gibibytes(amount *float64) Size

Create a Storage representing an amount gibibytes.

1 GiB = 1024 MiB

Returns: a new `Size` instance Experimental.

func Size_Kibibytes ¶ 

func Size_Kibibytes(amount *float64) Size

Create a Storage representing an amount kibibytes.

1 KiB = 1024 bytes

Returns: a new `Size` instance Experimental.

func Size_Mebibytes ¶ 

func Size_Mebibytes(amount *float64) Size

Create a Storage representing an amount mebibytes.

1 MiB = 1024 KiB

Returns: a new `Size` instance Experimental.

func Size_Pebibyte ¶ 

func Size_Pebibyte(amount *float64) Size

Create a Storage representing an amount pebibytes.

1 PiB = 1024 TiB Deprecated: use `pebibytes` instead

func Size_Pebibytes ¶ 

func Size_Pebibytes(amount *float64) Size

Create a Storage representing an amount pebibytes.

1 PiB = 1024 TiB

Returns: a new `Size` instance Experimental.

func Size_Tebibytes ¶ 

func Size_Tebibytes(amount *float64) Size

Create a Storage representing an amount tebibytes.

1 TiB = 1024 GiB

Returns: a new `Size` instance Experimental.

type SizeConversionOptions ¶ 

type SizeConversionOptions struct {
	// How conversions should behave when it encounters a non-integer result.
	// Experimental.
	Rounding SizeRoundingBehavior `json:"rounding" yaml:"rounding"`
}

Options for how to convert time to a different unit.

TODO: EXAMPLE

Experimental.

type SizeRoundingBehavior ¶ 

type SizeRoundingBehavior string

Rounding behaviour when converting between units of `Size`. Experimental. 

const (
	SizeRoundingBehavior_FAIL  SizeRoundingBehavior = "FAIL"
	SizeRoundingBehavior_FLOOR SizeRoundingBehavior = "FLOOR"
	SizeRoundingBehavior_NONE  SizeRoundingBehavior = "NONE"
)

type Stack ¶ 

type Stack interface {
	Construct
	ITaggable
	Account() *string
	ArtifactId() *string
	AvailabilityZones() *[]*string
	Dependencies() *[]Stack
	Environment() *string
	Nested() *bool
	NestedStackParent() Stack
	NestedStackResource() CfnResource
	Node() ConstructNode
	NotificationArns() *[]*string
	ParentStack() Stack
	Partition() *string
	Region() *string
	StackId() *string
	StackName() *string
	Synthesizer() IStackSynthesizer
	Tags() TagManager
	TemplateFile() *string
	TemplateOptions() ITemplateOptions
	TerminationProtection() *bool
	UrlSuffix() *string
	AddDependency(target Stack, reason *string)
	AddDockerImageAsset(asset *DockerImageAssetSource) *DockerImageAssetLocation
	AddFileAsset(asset *FileAssetSource) *FileAssetLocation
	AddTransform(transform *string)
	AllocateLogicalId(cfnElement CfnElement) *string
	ExportValue(exportedValue interface{}, options *ExportValueOptions) *string
	FormatArn(components *ArnComponents) *string
	GetLogicalId(element CfnElement) *string
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	ParseArn(arn *string, sepIfToken *string, hasName *bool) *ArnComponents
	Prepare()
	PrepareCrossReference(_sourceStack Stack, reference Reference) IResolvable
	RegionalFact(factName *string, defaultValue *string) *string
	RenameLogicalId(oldId *string, newId *string)
	ReportMissingContext(report *cxapi.MissingContext)
	ReportMissingContextKey(report *cloudassemblyschema.MissingContext)
	Resolve(obj interface{}) interface{}
	SplitArn(arn *string, arnFormat ArnFormat) *ArnComponents
	Synthesize(session ISynthesisSession)
	ToJsonString(obj interface{}, space *float64) *string
	ToString() *string
	Validate() *[]*string
}

A root construct which represents a single CloudFormation stack.

TODO: EXAMPLE

Experimental.

func NestedStack_Of ¶ 

func NestedStack_Of(construct constructs.IConstruct) Stack

Looks up the first stack scope in which `construct` is defined.

Fails if there is no stack up the tree. Experimental.

func NewStack ¶ 

func NewStack(scope constructs.Construct, id *string, props *StackProps) Stack

Creates a new stack. Experimental.

func Stack_Of ¶ 

func Stack_Of(construct constructs.IConstruct) Stack

Looks up the first stack scope in which `construct` is defined.

Fails if there is no stack up the tree. Experimental.

type StackProps ¶ 

type StackProps struct {
	// Include runtime versioning information in this Stack.
	// Experimental.
	AnalyticsReporting *bool `json:"analyticsReporting" yaml:"analyticsReporting"`
	// A description of the stack.
	// Experimental.
	Description *string `json:"description" yaml:"description"`
	// The AWS environment (account/region) where this stack will be deployed.
	//
	// Set the `region`/`account` fields of `env` to either a concrete value to
	// select the indicated environment (recommended for production stacks), or to
	// the values of environment variables
	// `CDK_DEFAULT_REGION`/`CDK_DEFAULT_ACCOUNT` to let the target environment
	// depend on the AWS credentials/configuration that the CDK CLI is executed
	// under (recommended for development stacks).
	//
	// If the `Stack` is instantiated inside a `Stage`, any undefined
	// `region`/`account` fields from `env` will default to the same field on the
	// encompassing `Stage`, if configured there.
	//
	// If either `region` or `account` are not set nor inherited from `Stage`, the
	// Stack will be considered "*environment-agnostic*"". Environment-agnostic
	// stacks can be deployed to any environment but may not be able to take
	// advantage of all features of the CDK. For example, they will not be able to
	// use environmental context lookups such as `ec2.Vpc.fromLookup` and will not
	// automatically translate Service Principals to the right format based on the
	// environment's AWS partition, and other such enhancements.
	//
	// TODO: EXAMPLE
	//
	// Experimental.
	Env *Environment `json:"env" yaml:"env"`
	// Name to deploy the stack with.
	// Experimental.
	StackName *string `json:"stackName" yaml:"stackName"`
	// Synthesis method to use while deploying this stack.
	// Experimental.
	Synthesizer IStackSynthesizer `json:"synthesizer" yaml:"synthesizer"`
	// Stack tags that will be applied to all the taggable resources and the stack itself.
	// Experimental.
	Tags *map[string]*string `json:"tags" yaml:"tags"`
	// Whether to enable termination protection for this stack.
	// Experimental.
	TerminationProtection *bool `json:"terminationProtection" yaml:"terminationProtection"`
}

TODO: EXAMPLE

Experimental.

type StackSynthesizer ¶ 

type StackSynthesizer interface {
	IStackSynthesizer
	AddDockerImageAsset(asset *DockerImageAssetSource) *DockerImageAssetLocation
	AddFileAsset(asset *FileAssetSource) *FileAssetLocation
	Bind(stack Stack)
	EmitStackArtifact(stack Stack, session ISynthesisSession, options *SynthesizeStackArtifactOptions)
	Synthesize(session ISynthesisSession)
	SynthesizeStackTemplate(stack Stack, session ISynthesisSession)
}

Base class for implementing an IStackSynthesizer.

This class needs to exist to provide public surface area for external implementations of stack synthesizers. The protected methods give access to functions that are otherwise @_internal to the framework and could not be accessed by external implementors. Experimental.

type Stage ¶ 

type Stage interface {
	Construct
	Account() *string
	ArtifactId() *string
	AssetOutdir() *string
	Node() ConstructNode
	Outdir() *string
	ParentStage() Stage
	Region() *string
	StageName() *string
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	Prepare()
	Synth(options *StageSynthesisOptions) cxapi.CloudAssembly
	Synthesize(session ISynthesisSession)
	ToString() *string
	Validate() *[]*string
}

An abstract application modeling unit consisting of Stacks that should be deployed together.

Derive a subclass of `Stage` and use it to model a single instance of your application.

You can then instantiate your subclass multiple times to model multiple copies of your application which should be be deployed to different environments.

TODO: EXAMPLE

Experimental.

func App_Of ¶ 

func App_Of(construct constructs.IConstruct) Stage

Return the stage this construct is contained with, if available.

If called on a nested stage, returns its parent. Experimental.

func NewStage ¶ 

func NewStage(scope constructs.Construct, id *string, props *StageProps) Stage

Experimental.

func Stage_Of ¶ 

func Stage_Of(construct constructs.IConstruct) Stage

Return the stage this construct is contained with, if available.

If called on a nested stage, returns its parent. Experimental.

type StageProps ¶ 

type StageProps struct {
	// Default AWS environment (account/region) for `Stack`s in this `Stage`.
	//
	// Stacks defined inside this `Stage` with either `region` or `account` missing
	// from its env will use the corresponding field given here.
	//
	// If either `region` or `account`is is not configured for `Stack` (either on
	// the `Stack` itself or on the containing `Stage`), the Stack will be
	// *environment-agnostic*.
	//
	// Environment-agnostic stacks can be deployed to any environment, may not be
	// able to take advantage of all features of the CDK. For example, they will
	// not be able to use environmental context lookups, will not automatically
	// translate Service Principals to the right format based on the environment's
	// AWS partition, and other such enhancements.
	//
	// TODO: EXAMPLE
	//
	// Experimental.
	Env *Environment `json:"env" yaml:"env"`
	// The output directory into which to emit synthesized artifacts.
	//
	// Can only be specified if this stage is the root stage (the app). If this is
	// specified and this stage is nested within another stage, an error will be
	// thrown.
	// Experimental.
	Outdir *string `json:"outdir" yaml:"outdir"`
}

Initialization props for a stage.

TODO: EXAMPLE

Experimental.

type StageSynthesisOptions ¶ 

type StageSynthesisOptions struct {
	// Force a re-synth, even if the stage has already been synthesized.
	//
	// This is used by tests to allow for incremental verification of the output.
	// Do not use in production.
	// Experimental.
	Force *bool `json:"force" yaml:"force"`
	// Should we skip construct validation.
	// Experimental.
	SkipValidation *bool `json:"skipValidation" yaml:"skipValidation"`
	// Whether the stack should be validated after synthesis to check for error metadata.
	// Experimental.
	ValidateOnSynthesis *bool `json:"validateOnSynthesis" yaml:"validateOnSynthesis"`
}

Options for assembly synthesis.

TODO: EXAMPLE

Experimental.

type StringConcat ¶ 

type StringConcat interface {
	IFragmentConcatenator
	Join(left interface{}, right interface{}) interface{}
}

Converts all fragments to strings and concats those.

Drops 'undefined's.

TODO: EXAMPLE

Experimental.

func NewStringConcat ¶ 

func NewStringConcat() StringConcat

Experimental.

type SymlinkFollowMode ¶ 

type SymlinkFollowMode string

Determines how symlinks are followed. Experimental. 

const (
	SymlinkFollowMode_NEVER          SymlinkFollowMode = "NEVER"
	SymlinkFollowMode_ALWAYS         SymlinkFollowMode = "ALWAYS"
	SymlinkFollowMode_EXTERNAL       SymlinkFollowMode = "EXTERNAL"
	SymlinkFollowMode_BLOCK_EXTERNAL SymlinkFollowMode = "BLOCK_EXTERNAL"
)

type SynthesisOptions deprecated 

type SynthesisOptions struct {
	// Include the specified runtime information (module versions) in manifest.
	// Deprecated: All template modifications that should result from this should
	// have already been inserted into the template.
	RuntimeInfo *cxapi.RuntimeInfo `json:"runtimeInfo" yaml:"runtimeInfo"`
	// The output directory into which to synthesize the cloud assembly.
	// Deprecated: use `app.synth()` or `stage.synth()` instead
	Outdir *string `json:"outdir" yaml:"outdir"`
	// Whether synthesis should skip the validation phase.
	// Deprecated: use `app.synth()` or `stage.synth()` instead
	SkipValidation *bool `json:"skipValidation" yaml:"skipValidation"`
	// Whether the stack should be validated after synthesis to check for error metadata.
	// Deprecated: use `app.synth()` or `stage.synth()` instead
	ValidateOnSynthesis *bool `json:"validateOnSynthesis" yaml:"validateOnSynthesis"`
}

Options for synthesis.

TODO: EXAMPLE

Deprecated: use `app.synth()` or `stage.synth()` instead

type SynthesizeStackArtifactOptions ¶ 

type SynthesizeStackArtifactOptions struct {
	// Identifiers of additional dependencies.
	// Experimental.
	AdditionalDependencies *[]*string `json:"additionalDependencies" yaml:"additionalDependencies"`
	// The role that needs to be assumed to deploy the stack.
	// Experimental.
	AssumeRoleArn *string `json:"assumeRoleArn" yaml:"assumeRoleArn"`
	// The externalID to use with the assumeRoleArn.
	// Experimental.
	AssumeRoleExternalId *string `json:"assumeRoleExternalId" yaml:"assumeRoleExternalId"`
	// SSM parameter where the bootstrap stack version number can be found.
	//
	// Only used if `requiresBootstrapStackVersion` is set.
	//
	// - If this value is not set, the bootstrap stack name must be known at
	//    deployment time so the stack version can be looked up from the stack
	//    outputs.
	// - If this value is set, the bootstrap stack can have any name because
	//    we won't need to look it up.
	// Experimental.
	BootstrapStackVersionSsmParameter *string `json:"bootstrapStackVersionSsmParameter" yaml:"bootstrapStackVersionSsmParameter"`
	// The role that is passed to CloudFormation to execute the change set.
	// Experimental.
	CloudFormationExecutionRoleArn *string `json:"cloudFormationExecutionRoleArn" yaml:"cloudFormationExecutionRoleArn"`
	// The role to use to look up values from the target AWS account.
	// Experimental.
	LookupRole *cloudassemblyschema.BootstrapRole `json:"lookupRole" yaml:"lookupRole"`
	// Values for CloudFormation stack parameters that should be passed when the stack is deployed.
	// Experimental.
	Parameters *map[string]*string `json:"parameters" yaml:"parameters"`
	// Version of bootstrap stack required to deploy this stack.
	// Experimental.
	RequiresBootstrapStackVersion *float64 `json:"requiresBootstrapStackVersion" yaml:"requiresBootstrapStackVersion"`
	// If the stack template has already been included in the asset manifest, its asset URL.
	// Experimental.
	StackTemplateAssetObjectUrl *string `json:"stackTemplateAssetObjectUrl" yaml:"stackTemplateAssetObjectUrl"`
}

Stack artifact options.

A subset of `cxschema.AwsCloudFormationStackProperties` of optional settings that need to be configurable by synthesizers, plus `additionalDependencies`.

TODO: EXAMPLE

Experimental.

type Tag ¶ 

type Tag interface {
	IAspect
	Key() *string
	Props() *TagProps
	Value() *string
	ApplyTag(resource ITaggable)
	Visit(construct IConstruct)
}

The Tag Aspect will handle adding a tag to this node and cascading tags to children.

TODO: EXAMPLE

Experimental.

func NewTag ¶ 

func NewTag(key *string, value *string, props *TagProps) Tag

Experimental.

type TagManager ¶ 

type TagManager interface {
	RenderedTags() IResolvable
	TagPropertyName() *string
	ApplyTagAspectHere(include *[]*string, exclude *[]*string) *bool
	HasTags() *bool
	RemoveTag(key *string, priority *float64)
	RenderTags() interface{}
	SetTag(key *string, value *string, priority *float64, applyToLaunchedInstances *bool)
	TagValues() *map[string]*string
}

TagManager facilitates a common implementation of tagging for Constructs.

Normally, you do not need to use this class, as the CloudFormation specification will indicate which resources are taggable. However, sometimes you will need this to make custom resources taggable. Used `tagManager.renderedTags` to obtain a value that will resolve to the tags at synthesis time.

TODO: EXAMPLE

Experimental.

func NewTagManager ¶ 

func NewTagManager(tagType TagType, resourceTypeName *string, tagStructure interface{}, options *TagManagerOptions) TagManager

Experimental.

type TagManagerOptions ¶ 

type TagManagerOptions struct {
	// The name of the property in CloudFormation for these tags.
	//
	// Normally this is `tags`, but Cognito UserPool uses UserPoolTags
	// Experimental.
	TagPropertyName *string `json:"tagPropertyName" yaml:"tagPropertyName"`
}

Options to configure TagManager behavior.

TODO: EXAMPLE

Experimental.

type TagProps ¶ 

type TagProps struct {
	// Whether the tag should be applied to instances in an AutoScalingGroup.
	// Experimental.
	ApplyToLaunchedInstances *bool `json:"applyToLaunchedInstances" yaml:"applyToLaunchedInstances"`
	// An array of Resource Types that will not receive this tag.
	//
	// An empty array will allow this tag to be applied to all resources. A
	// non-empty array will apply this tag only if the Resource type is not in
	// this array.
	// Experimental.
	ExcludeResourceTypes *[]*string `json:"excludeResourceTypes" yaml:"excludeResourceTypes"`
	// An array of Resource Types that will receive this tag.
	//
	// An empty array will match any Resource. A non-empty array will apply this
	// tag only to Resource types that are included in this array.
	// Experimental.
	IncludeResourceTypes *[]*string `json:"includeResourceTypes" yaml:"includeResourceTypes"`
	// Priority of the tag operation.
	//
	// Higher or equal priority tags will take precedence.
	//
	// Setting priority will enable the user to control tags when they need to not
	// follow the default precedence pattern of last applied and closest to the
	// construct in the tree.
	// Experimental.
	Priority *float64 `json:"priority" yaml:"priority"`
}

Properties for a tag.

TODO: EXAMPLE

Experimental.

type TagType ¶ 

type TagType string

Experimental. 

const (
	TagType_STANDARD          TagType = "STANDARD"
	TagType_AUTOSCALING_GROUP TagType = "AUTOSCALING_GROUP"
	TagType_MAP               TagType = "MAP"
	TagType_KEY_VALUE         TagType = "KEY_VALUE"
	TagType_NOT_TAGGABLE      TagType = "NOT_TAGGABLE"
)

type Tags ¶ 

type Tags interface {
	Add(key *string, value *string, props *TagProps)
	Remove(key *string, props *TagProps)
}

Manages AWS tags for all resources within a construct scope.

TODO: EXAMPLE

Experimental.

func Tags_Of ¶ 

func Tags_Of(scope IConstruct) Tags

Returns the tags API for this scope. Experimental.

type TimeConversionOptions ¶ 

type TimeConversionOptions struct {
	// If `true`, conversions into a larger time unit (e.g. `Seconds` to `Minutes`) will fail if the result is not an integer.
	// Experimental.
	Integral *bool `json:"integral" yaml:"integral"`
}

Options for how to convert time to a different unit.

TODO: EXAMPLE

Experimental.

type Token ¶ 

type Token interface {
}

Represents a special or lazily-evaluated value.

Can be used to delay evaluation of a certain value in case, for example, that it requires some context or late-bound data. Can also be used to mark values that need special processing at document rendering time.

Tokens can be embedded into strings while retaining their original semantics. Experimental.

type TokenComparison ¶ 

type TokenComparison interface {
}

An enum-like class that represents the result of comparing two Tokens.

The return type of {@link Token.compareStrings}.

TODO: EXAMPLE

Experimental.

func TokenComparison_BOTH_UNRESOLVED ¶ 

func TokenComparison_BOTH_UNRESOLVED() TokenComparison

func TokenComparison_DIFFERENT ¶ 

func TokenComparison_DIFFERENT() TokenComparison

func TokenComparison_ONE_UNRESOLVED ¶ 

func TokenComparison_ONE_UNRESOLVED() TokenComparison

func TokenComparison_SAME ¶ 

func TokenComparison_SAME() TokenComparison

func Token_CompareStrings ¶ 

func Token_CompareStrings(possibleToken1 *string, possibleToken2 *string) TokenComparison

Compare two strings that might contain Tokens with each other. Experimental.

type Tokenization ¶ 

type Tokenization interface {
}

Less oft-needed functions to manipulate Tokens. Experimental.

type TokenizedStringFragments ¶ 

type TokenizedStringFragments interface {
	FirstToken() IResolvable
	FirstValue() interface{}
	Length() *float64
	Tokens() *[]IResolvable
	AddIntrinsic(value interface{})
	AddLiteral(lit interface{})
	AddToken(token IResolvable)
	Join(concat IFragmentConcatenator) interface{}
	MapTokens(mapper ITokenMapper) TokenizedStringFragments
}

Fragments of a concatenated string containing stringified Tokens.

TODO: EXAMPLE

Experimental.

func NewTokenizedStringFragments ¶ 

func NewTokenizedStringFragments() TokenizedStringFragments

Experimental.

func Tokenization_ReverseString ¶ 

func Tokenization_ReverseString(s *string) TokenizedStringFragments

Un-encode a string potentially containing encoded tokens. Experimental.

type TreeInspector ¶ 

type TreeInspector interface {
	Attributes() *map[string]interface{}
	AddAttribute(key *string, value interface{})
}

Inspector that maintains an attribute bag.

TODO: EXAMPLE

Experimental.

func NewTreeInspector ¶ 

func NewTreeInspector() TreeInspector

Experimental.

type ValidationError ¶ 

type ValidationError struct {
	// The error message.
	// Experimental.
	Message *string `json:"message" yaml:"message"`
	// The construct which emitted the error.
	// Experimental.
	Source Construct `json:"source" yaml:"source"`
}

An error returned during the validation phase.

TODO: EXAMPLE

Experimental.

type ValidationResult ¶ 

type ValidationResult interface {
	ErrorMessage() *string
	IsSuccess() *bool
	Results() ValidationResults
	AssertSuccess()
	ErrorTree() *string
	Prefix(message *string) ValidationResult
}

Representation of validation results.

Models a tree of validation errors so that we have as much information as possible about the failure that occurred.

TODO: EXAMPLE

Experimental.

func NewValidationResult ¶ 

func NewValidationResult(errorMessage *string, results ValidationResults) ValidationResult

Experimental.

type ValidationResults ¶ 

type ValidationResults interface {
	IsSuccess() *bool
	Results() *[]ValidationResult
	SetResults(val *[]ValidationResult)
	Collect(result ValidationResult)
	ErrorTreeList() *string
	Wrap(message *string) ValidationResult
}

A collection of validation results.

TODO: EXAMPLE

Experimental.

func NewValidationResults ¶ 

func NewValidationResults(results *[]ValidationResult) ValidationResults

Experimental.

Source Files ¶

View all Source files

Directories ¶

Path Synopsis
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
experimental
experimental/internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
internal
Package jsii contains the functionaility needed for jsii packages to initialize their dependencies and themselves.
 Package jsii contains the functionaility needed for jsii packages to initialize their dependencies and themselves.
internal
internal
internal
internal

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.