@aws-cdk/aws-cloudformation

  • Version 1.174.0
  • Published
  • 1.36 MB
  • 7 dependencies
  • Apache-2.0 license

Install

npm i @aws-cdk/aws-cloudformation
yarn add @aws-cdk/aws-cloudformation
pnpm add @aws-cdk/aws-cloudformation

Overview

The CDK Construct Library for AWS::CloudFormation

Index

Classes

Interfaces

Enums

Type Aliases

Namespaces

Classes

class CfnCustomResource

class CfnCustomResource extends cdk.CfnResource implements cdk.IInspectable {}
  • 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) .

    AWS::CloudFormation::CustomResource external

    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cfn-customresource.html

constructor

constructor(scope: cdk.Construct, id: string, props: CfnCustomResourceProps);
  • Create a new AWS::CloudFormation::CustomResource.

    Parameter scope

    scope in which this resource is defined

    Parameter id

    scoped id of the resource

    Parameter props

    resource properties

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;
  • The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

    property serviceToken

    serviceToken: string;
    • > 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.

      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cfn-customresource.html#cfn-customresource-servicetoken

    method inspect

    inspect: (inspector: cdk.TreeInspector) => void;
    • Examines the CloudFormation resource and discloses attributes.

      Parameter inspector

      tree inspector to collect and process attributes

    method renderProperties

    protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
    };

      class CfnHookDefaultVersion

      class CfnHookDefaultVersion extends cdk.CfnResource implements cdk.IInspectable {}
      • 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 .

        AWS::CloudFormation::HookDefaultVersion external

        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookdefaultversion.html

      constructor

      constructor(
      scope: cdk.Construct,
      id: string,
      props?: CfnHookDefaultVersionProps
      );
      • Create a new AWS::CloudFormation::HookDefaultVersion.

        Parameter scope

        scope in which this resource is defined

        Parameter id

        scoped id of the resource

        Parameter props

        resource properties

      property attrArn

      readonly attrArn: string;
      • The Amazon Resource Number (ARN) of the activated extension, in this account and Region. Arn

      property CFN_RESOURCE_TYPE_NAME

      static readonly CFN_RESOURCE_TYPE_NAME: string;
      • The CloudFormation resource type name for this resource class.

      property cfnProperties

      readonly cfnProperties: { [key: string]: any };

        property typeName

        typeName: string;
        • The name of the hook.

          You must specify either TypeVersionArn , or TypeName and VersionId .

          http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookdefaultversion.html#cfn-cloudformation-hookdefaultversion-typename

        property typeVersionArn

        typeVersionArn: string;
        • The version ID of the type configuration.

          You must specify either TypeVersionArn , or TypeName and VersionId .

          http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookdefaultversion.html#cfn-cloudformation-hookdefaultversion-typeversionarn

        property versionId

        versionId: string;
        • The version ID of the type specified.

          You must specify either TypeVersionArn , or TypeName and VersionId .

          http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookdefaultversion.html#cfn-cloudformation-hookdefaultversion-versionid

        method inspect

        inspect: (inspector: cdk.TreeInspector) => void;
        • Examines the CloudFormation resource and discloses attributes.

          Parameter inspector

          tree inspector to collect and process attributes

        method renderProperties

        protected renderProperties: (props: { [key: string]: any }) => {
        [key: string]: any;
        };

          class CfnHookTypeConfig

          class CfnHookTypeConfig extends cdk.CfnResource implements cdk.IInspectable {}
          • A CloudFormation AWS::CloudFormation::HookTypeConfig

            The HookTypeConfig resource specifies the configuration of a hook.

            AWS::CloudFormation::HookTypeConfig external

            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hooktypeconfig.html

          constructor

          constructor(scope: cdk.Construct, id: string, props: CfnHookTypeConfigProps);
          • Create a new AWS::CloudFormation::HookTypeConfig.

            Parameter scope

            scope in which this resource is defined

            Parameter id

            scoped id of the resource

            Parameter props

            resource properties

          property attrConfigurationArn

          readonly attrConfigurationArn: string;
          • The Amazon Resource Number (ARN) of the activated hook type configuration, in this account and Region. ConfigurationArn

          property CFN_RESOURCE_TYPE_NAME

          static readonly CFN_RESOURCE_TYPE_NAME: string;
          • The CloudFormation resource type name for this resource class.

          property cfnProperties

          readonly cfnProperties: { [key: string]: any };

            property configuration

            configuration: string;
            • Specifies the activated hook type configuration, in this AWS account and AWS Region .

              You must specify either TypeName and Configuration or TypeARN and Configuration .

              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hooktypeconfig.html#cfn-cloudformation-hooktypeconfig-configuration

            property configurationAlias

            configurationAlias: string;
            • Specifies the activated hook type configuration, in this AWS account and AWS Region .

              Defaults to default alias. Hook types currently support default configuration alias.

              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hooktypeconfig.html#cfn-cloudformation-hooktypeconfig-configurationalias

            property typeArn

            typeArn: string;
            • The Amazon Resource Number (ARN) for the hook to set Configuration for.

              You must specify either TypeName and Configuration or TypeARN and Configuration .

              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hooktypeconfig.html#cfn-cloudformation-hooktypeconfig-typearn

            property typeName

            typeName: string;
            • 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 .

              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hooktypeconfig.html#cfn-cloudformation-hooktypeconfig-typename

            method inspect

            inspect: (inspector: cdk.TreeInspector) => void;
            • Examines the CloudFormation resource and discloses attributes.

              Parameter inspector

              tree inspector to collect and process attributes

            method renderProperties

            protected renderProperties: (props: { [key: string]: any }) => {
            [key: string]: any;
            };

              class CfnHookVersion

              class CfnHookVersion extends cdk.CfnResource implements cdk.IInspectable {}
              • A CloudFormation AWS::CloudFormation::HookVersion

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

                AWS::CloudFormation::HookVersion external

                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookversion.html

              constructor

              constructor(scope: cdk.Construct, id: string, props: CfnHookVersionProps);
              • Create a new AWS::CloudFormation::HookVersion.

                Parameter scope

                scope in which this resource is defined

                Parameter id

                scoped id of the resource

                Parameter props

                resource properties

              property attrArn

              readonly attrArn: string;
              • The Amazon Resource Name (ARN) of the hook. Arn

              property attrIsDefaultVersion

              readonly attrIsDefaultVersion: cdk.IResolvable;
              • Whether the specified hook version is set as the default version. IsDefaultVersion

              property attrTypeArn

              readonly attrTypeArn: string;
              • The Amazon Resource Number (ARN) assigned to this version of the hook. TypeArn

              property attrVersionId

              readonly attrVersionId: string;
              • The ID of this version of the hook. VersionId

              property attrVisibility

              readonly attrVisibility: string;
              • The scope at which the resource is visible and usable in CloudFormation operations.

                Valid values include:

                - PRIVATE : The resource is only visible and usable within the account in which it's registered. CloudFormation marks any resources you register as PRIVATE . - PUBLIC : The resource is publicly visible and usable within any Amazon account. Visibility

              property CFN_RESOURCE_TYPE_NAME

              static readonly CFN_RESOURCE_TYPE_NAME: string;
              • The CloudFormation resource type name for this resource class.

              property cfnProperties

              readonly cfnProperties: { [key: string]: any };

                property executionRoleArn

                executionRoleArn: string;
                • The Amazon Resource Name (ARN) of the task execution role that grants the hook permission.

                  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookversion.html#cfn-cloudformation-hookversion-executionrolearn

                property loggingConfig

                loggingConfig: any;
                • Contains logging configuration information for an extension.

                  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookversion.html#cfn-cloudformation-hookversion-loggingconfig

                property schemaHandlerPackage

                schemaHandlerPackage: string;
                • 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* .

                  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookversion.html#cfn-cloudformation-hookversion-schemahandlerpackage

                property typeName

                typeName: string;
                • 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

                  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookversion.html#cfn-cloudformation-hookversion-typename

                method inspect

                inspect: (inspector: cdk.TreeInspector) => void;
                • Examines the CloudFormation resource and discloses attributes.

                  Parameter inspector

                  tree inspector to collect and process attributes

                method renderProperties

                protected renderProperties: (props: { [key: string]: any }) => {
                [key: string]: any;
                };

                  class CfnMacro

                  class CfnMacro extends cdk.CfnResource implements cdk.IInspectable {}
                  • 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) .

                    AWS::CloudFormation::Macro external

                    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html

                  constructor

                  constructor(scope: cdk.Construct, id: string, props: CfnMacroProps);
                  • Create a new AWS::CloudFormation::Macro.

                    Parameter scope

                    scope in which this resource is defined

                    Parameter id

                    scoped id of the resource

                    Parameter props

                    resource properties

                  property CFN_RESOURCE_TYPE_NAME

                  static readonly CFN_RESOURCE_TYPE_NAME: string;
                  • The CloudFormation resource type name for this resource class.

                  property cfnProperties

                  readonly cfnProperties: { [key: string]: any };

                    property description

                    description: string;
                    • A description of the macro.

                      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html#cfn-cloudformation-macro-description

                    property functionName

                    functionName: string;
                    • The Amazon Resource Name (ARN) of the underlying AWS Lambda function that you want AWS CloudFormation to invoke when the macro is run.

                      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html#cfn-cloudformation-macro-functionname

                    property logGroupName

                    logGroupName: string;
                    • The CloudWatch Logs group to which AWS CloudFormation sends error logging information when invoking the macro's underlying AWS Lambda function.

                      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html#cfn-cloudformation-macro-loggroupname

                    property logRoleArn

                    logRoleArn: string;
                    • The ARN of the role AWS CloudFormation should assume when sending log entries to CloudWatch Logs .

                      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html#cfn-cloudformation-macro-logrolearn

                    property name

                    name: string;
                    • The name of the macro. The name of the macro must be unique across all macros in the account.

                      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html#cfn-cloudformation-macro-name

                    method inspect

                    inspect: (inspector: cdk.TreeInspector) => void;
                    • Examines the CloudFormation resource and discloses attributes.

                      Parameter inspector

                      tree inspector to collect and process attributes

                    method renderProperties

                    protected renderProperties: (props: { [key: string]: any }) => {
                    [key: string]: any;
                    };

                      class CfnModuleDefaultVersion

                      class CfnModuleDefaultVersion extends cdk.CfnResource implements cdk.IInspectable {}
                      • 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* .

                        AWS::CloudFormation::ModuleDefaultVersion external

                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduledefaultversion.html

                      constructor

                      constructor(
                      scope: cdk.Construct,
                      id: string,
                      props?: CfnModuleDefaultVersionProps
                      );
                      • Create a new AWS::CloudFormation::ModuleDefaultVersion.

                        Parameter scope

                        scope in which this resource is defined

                        Parameter id

                        scoped id of the resource

                        Parameter props

                        resource properties

                      property arn

                      arn: string;
                      • 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 .

                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduledefaultversion.html#cfn-cloudformation-moduledefaultversion-arn

                      property CFN_RESOURCE_TYPE_NAME

                      static readonly CFN_RESOURCE_TYPE_NAME: string;
                      • The CloudFormation resource type name for this resource class.

                      property cfnProperties

                      readonly cfnProperties: { [key: string]: any };

                        property moduleName

                        moduleName: string;
                        • The name of the module.

                          Conditional: You must specify either Arn , or ModuleName and VersionId .

                          http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduledefaultversion.html#cfn-cloudformation-moduledefaultversion-modulename

                        property versionId

                        versionId: string;
                        • The ID for the specific version of the module.

                          Conditional: You must specify either Arn , or ModuleName and VersionId .

                          http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduledefaultversion.html#cfn-cloudformation-moduledefaultversion-versionid

                        method inspect

                        inspect: (inspector: cdk.TreeInspector) => void;
                        • Examines the CloudFormation resource and discloses attributes.

                          Parameter inspector

                          tree inspector to collect and process attributes

                        method renderProperties

                        protected renderProperties: (props: { [key: string]: any }) => {
                        [key: string]: any;
                        };

                          class CfnModuleVersion

                          class CfnModuleVersion extends cdk.CfnResource implements cdk.IInspectable {}
                          • 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* .

                            AWS::CloudFormation::ModuleVersion external

                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduleversion.html

                          constructor

                          constructor(scope: cdk.Construct, id: string, props: CfnModuleVersionProps);
                          • Create a new AWS::CloudFormation::ModuleVersion.

                            Parameter scope

                            scope in which this resource is defined

                            Parameter id

                            scoped id of the resource

                            Parameter props

                            resource properties

                          property attrArn

                          readonly attrArn: string;
                          • The Amazon Resource Name (ARN) of the module. Arn

                          property attrDescription

                          readonly attrDescription: string;
                          • The description of the module. Description

                          property attrDocumentationUrl

                          readonly attrDocumentationUrl: string;
                          • The URL of a page providing detailed documentation for this module. DocumentationUrl

                          property attrIsDefaultVersion

                          readonly attrIsDefaultVersion: cdk.IResolvable;
                          • Whether the specified module version is set as the default version. IsDefaultVersion

                          property attrSchema

                          readonly attrSchema: string;
                          • The schema that defines the module. Schema

                          property attrTimeCreated

                          readonly attrTimeCreated: string;
                          • When the specified module version was registered. TimeCreated

                          property attrVersionId

                          readonly attrVersionId: string;
                          • The ID of this version of the module. VersionId

                          property attrVisibility

                          readonly attrVisibility: string;
                          • The scope at which the module is visible and usable in CloudFormation operations.

                            Valid values include:

                            - PRIVATE : The module is only visible and usable within the account in which it's registered. - PUBLIC : The module is publicly visible and usable within any Amazon account. Visibility

                          property CFN_RESOURCE_TYPE_NAME

                          static readonly CFN_RESOURCE_TYPE_NAME: string;
                          • The CloudFormation resource type name for this resource class.

                          property cfnProperties

                          readonly cfnProperties: { [key: string]: any };

                            property moduleName

                            moduleName: string;
                            • The name of the module being registered.

                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduleversion.html#cfn-cloudformation-moduleversion-modulename

                            property modulePackage

                            modulePackage: string;
                            • 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* .

                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduleversion.html#cfn-cloudformation-moduleversion-modulepackage

                            method inspect

                            inspect: (inspector: cdk.TreeInspector) => void;
                            • Examines the CloudFormation resource and discloses attributes.

                              Parameter inspector

                              tree inspector to collect and process attributes

                            method renderProperties

                            protected renderProperties: (props: { [key: string]: any }) => {
                            [key: string]: any;
                            };

                              class CfnPublicTypeVersion

                              class CfnPublicTypeVersion extends cdk.CfnResource implements cdk.IInspectable {}
                              • 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* .

                                AWS::CloudFormation::PublicTypeVersion external

                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publictypeversion.html

                              constructor

                              constructor(scope: cdk.Construct, id: string, props?: CfnPublicTypeVersionProps);
                              • Create a new AWS::CloudFormation::PublicTypeVersion.

                                Parameter scope

                                scope in which this resource is defined

                                Parameter id

                                scoped id of the resource

                                Parameter props

                                resource properties

                              property arn

                              arn: string;
                              • The Amazon Resource Number (ARN) of the extension.

                                Conditional: You must specify Arn , or TypeName and Type .

                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publictypeversion.html#cfn-cloudformation-publictypeversion-arn

                              property attrPublicTypeArn

                              readonly attrPublicTypeArn: string;
                              • The Amazon Resource Number (ARN) assigned to the public extension upon publication. PublicTypeArn

                              property attrPublisherId

                              readonly attrPublisherId: string;
                              • The publisher ID of the extension publisher. PublisherId

                              property attrTypeVersionArn

                              readonly attrTypeVersionArn: string;
                              • The Amazon Resource Number (ARN) assigned to this version of the extension. TypeVersionArn

                              property CFN_RESOURCE_TYPE_NAME

                              static readonly CFN_RESOURCE_TYPE_NAME: string;
                              • The CloudFormation resource type name for this resource class.

                              property cfnProperties

                              readonly cfnProperties: { [key: string]: any };

                                property logDeliveryBucket

                                logDeliveryBucket: string;
                                • 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* .

                                  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publictypeversion.html#cfn-cloudformation-publictypeversion-logdeliverybucket

                                property publicVersionNumber

                                publicVersionNumber: string;
                                • 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 .

                                  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publictypeversion.html#cfn-cloudformation-publictypeversion-publicversionnumber

                                property type

                                type: string;
                                • The type of the extension to test.

                                  Conditional: You must specify Arn , or TypeName and Type .

                                  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publictypeversion.html#cfn-cloudformation-publictypeversion-type

                                property typeName

                                typeName: string;
                                • The name of the extension to test.

                                  Conditional: You must specify Arn , or TypeName and Type .

                                  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publictypeversion.html#cfn-cloudformation-publictypeversion-typename

                                method inspect

                                inspect: (inspector: cdk.TreeInspector) => void;
                                • Examines the CloudFormation resource and discloses attributes.

                                  Parameter inspector

                                  tree inspector to collect and process attributes

                                method renderProperties

                                protected renderProperties: (props: { [key: string]: any }) => {
                                [key: string]: any;
                                };

                                  class CfnPublisher

                                  class CfnPublisher extends cdk.CfnResource implements cdk.IInspectable {}
                                  • 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* .

                                    AWS::CloudFormation::Publisher external

                                    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publisher.html

                                  constructor

                                  constructor(scope: cdk.Construct, id: string, props: CfnPublisherProps);
                                  • Create a new AWS::CloudFormation::Publisher.

                                    Parameter scope

                                    scope in which this resource is defined

                                    Parameter id

                                    scoped id of the resource

                                    Parameter props

                                    resource properties

                                  property acceptTermsAndConditions

                                  acceptTermsAndConditions: any;
                                  • 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 .

                                    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publisher.html#cfn-cloudformation-publisher-accepttermsandconditions

                                  property attrIdentityProvider

                                  readonly attrIdentityProvider: string;
                                  • The type of account used as the identity provider when registering this publisher with CloudFormation .

                                    Values include: AWS_Marketplace | Bitbucket | GitHub . IdentityProvider

                                  property attrPublisherId

                                  readonly attrPublisherId: string;
                                  • The ID of the extension publisher. This publisher ID applies to your account in all AWS Regions . PublisherId

                                  property attrPublisherProfile

                                  readonly attrPublisherProfile: string;
                                  • The URL to the publisher's profile with the identity provider. PublisherProfile

                                  property attrPublisherStatus

                                  readonly attrPublisherStatus: string;
                                  • Whether the publisher is verified. PublisherStatus

                                  property CFN_RESOURCE_TYPE_NAME

                                  static readonly CFN_RESOURCE_TYPE_NAME: string;
                                  • The CloudFormation resource type name for this resource class.

                                  property cfnProperties

                                  readonly cfnProperties: { [key: string]: any };

                                    property connectionArn

                                    connectionArn: string;
                                    • 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* .

                                      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publisher.html#cfn-cloudformation-publisher-connectionarn

                                    method inspect

                                    inspect: (inspector: cdk.TreeInspector) => void;
                                    • Examines the CloudFormation resource and discloses attributes.

                                      Parameter inspector

                                      tree inspector to collect and process attributes

                                    method renderProperties

                                    protected renderProperties: (props: { [key: string]: any }) => {
                                    [key: string]: any;
                                    };

                                      class CfnResourceDefaultVersion

                                      class CfnResourceDefaultVersion
                                      extends cdk.CfnResource
                                      implements cdk.IInspectable {}
                                      • A CloudFormation AWS::CloudFormation::ResourceDefaultVersion

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

                                        AWS::CloudFormation::ResourceDefaultVersion external

                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourcedefaultversion.html

                                      constructor

                                      constructor(
                                      scope: cdk.Construct,
                                      id: string,
                                      props?: CfnResourceDefaultVersionProps
                                      );
                                      • Create a new AWS::CloudFormation::ResourceDefaultVersion.

                                        Parameter scope

                                        scope in which this resource is defined

                                        Parameter id

                                        scoped id of the resource

                                        Parameter props

                                        resource properties

                                      property attrArn

                                      readonly attrArn: string;
                                      • The Amazon Resource Name (ARN) of the resource. Arn

                                      property CFN_RESOURCE_TYPE_NAME

                                      static readonly CFN_RESOURCE_TYPE_NAME: string;
                                      • The CloudFormation resource type name for this resource class.

                                      property cfnProperties

                                      readonly cfnProperties: { [key: string]: any };

                                        property typeName

                                        typeName: string;
                                        • The name of the resource.

                                          Conditional: You must specify either TypeVersionArn , or TypeName and VersionId .

                                          http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourcedefaultversion.html#cfn-cloudformation-resourcedefaultversion-typename

                                        property typeVersionArn

                                        typeVersionArn: string;
                                        • The Amazon Resource Name (ARN) of the resource version.

                                          Conditional: You must specify either TypeVersionArn , or TypeName and VersionId .

                                          http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourcedefaultversion.html#cfn-cloudformation-resourcedefaultversion-typeversionarn

                                        property versionId

                                        versionId: string;
                                        • 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 .

                                          http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourcedefaultversion.html#cfn-cloudformation-resourcedefaultversion-versionid

                                        method inspect

                                        inspect: (inspector: cdk.TreeInspector) => void;
                                        • Examines the CloudFormation resource and discloses attributes.

                                          Parameter inspector

                                          tree inspector to collect and process attributes

                                        method renderProperties

                                        protected renderProperties: (props: { [key: string]: any }) => {
                                        [key: string]: any;
                                        };

                                          class CfnResourceVersion

                                          class CfnResourceVersion extends cdk.CfnResource implements cdk.IInspectable {}
                                          • 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.

                                            AWS::CloudFormation::ResourceVersion external

                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourceversion.html

                                          constructor

                                          constructor(scope: cdk.Construct, id: string, props: CfnResourceVersionProps);
                                          • Create a new AWS::CloudFormation::ResourceVersion.

                                            Parameter scope

                                            scope in which this resource is defined

                                            Parameter id

                                            scoped id of the resource

                                            Parameter props

                                            resource properties

                                          property attrArn

                                          readonly attrArn: string;
                                          • The Amazon Resource Name (ARN) of the resource version. Arn

                                          property attrIsDefaultVersion

                                          readonly attrIsDefaultVersion: cdk.IResolvable;
                                          • Whether the resource version is set as the default version. IsDefaultVersion

                                          property attrProvisioningType

                                          readonly attrProvisioningType: string;
                                          • The provisioning behavior of the resource type. CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.

                                            Valid values include:

                                            - FULLY_MUTABLE : The resource type includes an update handler to process updates to the type during stack update operations. - IMMUTABLE : The resource type doesn't include an update handler, so the type can't be updated and must instead be replaced during stack update operations. - NON_PROVISIONABLE : The resource type doesn't include all the following handlers, and therefore can't actually be provisioned.

                                            - create - read - delete ProvisioningType

                                          property attrTypeArn

                                          readonly attrTypeArn: string;
                                          • The Amazon Resource Name (ARN) of the resource. TypeArn

                                          property attrVersionId

                                          readonly attrVersionId: string;
                                          • 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 is registered. VersionId

                                          property attrVisibility

                                          readonly attrVisibility: string;
                                          • The scope at which the resource is visible and usable in CloudFormation operations.

                                            Valid values include:

                                            - PRIVATE : The resource is only visible and usable within the account in which it's registered. CloudFormation marks any resources you register as PRIVATE . - PUBLIC : The resource is publicly visible and usable within any Amazon account. Visibility

                                          property CFN_RESOURCE_TYPE_NAME

                                          static readonly CFN_RESOURCE_TYPE_NAME: string;
                                          • The CloudFormation resource type name for this resource class.

                                          property cfnProperties

                                          readonly cfnProperties: { [key: string]: any };

                                            property executionRoleArn

                                            executionRoleArn: string;
                                            • 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.

                                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourceversion.html#cfn-cloudformation-resourceversion-executionrolearn

                                            property loggingConfig

                                            loggingConfig: any;
                                            • Logging configuration information for a resource.

                                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourceversion.html#cfn-cloudformation-resourceversion-loggingconfig

                                            property schemaHandlerPackage

                                            schemaHandlerPackage: string;
                                            • 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* .

                                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourceversion.html#cfn-cloudformation-resourceversion-schemahandlerpackage

                                            property typeName

                                            typeName: string;
                                            • 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

                                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourceversion.html#cfn-cloudformation-resourceversion-typename

                                            method inspect

                                            inspect: (inspector: cdk.TreeInspector) => void;
                                            • Examines the CloudFormation resource and discloses attributes.

                                              Parameter inspector

                                              tree inspector to collect and process attributes

                                            method renderProperties

                                            protected renderProperties: (props: { [key: string]: any }) => {
                                            [key: string]: any;
                                            };

                                              class CfnStack

                                              class CfnStack extends cdk.CfnResource implements cdk.IInspectable {}
                                              • 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) .

                                                AWS::CloudFormation::Stack external

                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html

                                              constructor

                                              constructor(scope: cdk.Construct, id: string, props: CfnStackProps);
                                              • Create a new AWS::CloudFormation::Stack.

                                                Parameter scope

                                                scope in which this resource is defined

                                                Parameter id

                                                scoped id of the resource

                                                Parameter props

                                                resource properties

                                              property CFN_RESOURCE_TYPE_NAME

                                              static readonly CFN_RESOURCE_TYPE_NAME: string;
                                              • The CloudFormation resource type name for this resource class.

                                              property cfnProperties

                                              readonly cfnProperties: { [key: string]: any };

                                                property notificationArns

                                                notificationArns: string[];
                                                • 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).

                                                  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html#cfn-cloudformation-stack-notificationarns

                                                property parameters

                                                parameters: any;
                                                • 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.

                                                  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html#cfn-cloudformation-stack-parameters

                                                property tags

                                                readonly tags: cdk.TagManager;
                                                • 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.

                                                  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html#cfn-cloudformation-stack-tags

                                                property templateUrl

                                                templateUrl: string;
                                                • 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.

                                                  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html#cfn-cloudformation-stack-templateurl

                                                property timeoutInMinutes

                                                timeoutInMinutes: number;
                                                • 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.

                                                  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html#cfn-cloudformation-stack-timeoutinminutes

                                                method inspect

                                                inspect: (inspector: cdk.TreeInspector) => void;
                                                • Examines the CloudFormation resource and discloses attributes.

                                                  Parameter inspector

                                                  tree inspector to collect and process attributes

                                                method renderProperties

                                                protected renderProperties: (props: { [key: string]: any }) => {
                                                [key: string]: any;
                                                };

                                                  class CfnStackSet

                                                  class CfnStackSet extends cdk.CfnResource implements cdk.IInspectable {}
                                                  • 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.

                                                    AWS::CloudFormation::StackSet external

                                                    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html

                                                  constructor

                                                  constructor(scope: cdk.Construct, id: string, props: CfnStackSetProps);
                                                  • Create a new AWS::CloudFormation::StackSet.

                                                    Parameter scope

                                                    scope in which this resource is defined

                                                    Parameter id

                                                    scoped id of the resource

                                                    Parameter props

                                                    resource properties

                                                  property administrationRoleArn

                                                  administrationRoleArn: string;
                                                  • 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

                                                    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-administrationrolearn

                                                  property attrStackSetId

                                                  readonly attrStackSetId: string;
                                                  • The ID of the stack that you're creating. StackSetId

                                                  property autoDeployment

                                                  autoDeployment: any;
                                                  • [ Service-managed permissions] Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU).

                                                    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-autodeployment

                                                  property callAs

                                                  callAs: string;
                                                  • [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

                                                    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-callas

                                                  property capabilities

                                                  capabilities: string[];
                                                  • 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) .

                                                    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-capabilities

                                                  property CFN_RESOURCE_TYPE_NAME

                                                  static readonly CFN_RESOURCE_TYPE_NAME: string;
                                                  • The CloudFormation resource type name for this resource class.

                                                  property cfnProperties

                                                  readonly cfnProperties: { [key: string]: any };

                                                    property description

                                                    description: string;
                                                    • A description of the stack set.

                                                      *Minimum* : 1

                                                      *Maximum* : 1024

                                                      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-description

                                                    property executionRoleName

                                                    executionRoleName: string;
                                                    • 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+=,.@-]+

                                                      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-executionrolename

                                                    property managedExecution

                                                    managedExecution: any;
                                                    • 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.

                                                      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-managedexecution

                                                    property operationPreferences

                                                    operationPreferences: any;
                                                    • The user-specified preferences for how AWS CloudFormation performs a stack set operation.

                                                      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-operationpreferences

                                                    property parameters

                                                    parameters: any;
                                                    • The input parameters for the stack set template.

                                                      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-parameters

                                                    property permissionModel

                                                    permissionModel: string;
                                                    • 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.

                                                      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-permissionmodel

                                                    property stackInstancesGroup

                                                    stackInstancesGroup: any;
                                                    • A group of stack instances with parameters in some specific accounts and Regions.

                                                      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-stackinstancesgroup

                                                    property stackSetName

                                                    stackSetName: string;
                                                    • 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.

                                                      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-stacksetname

                                                    property tags

                                                    readonly tags: cdk.TagManager;
                                                    • 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.

                                                      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-tags

                                                    property templateBody

                                                    templateBody: string;
                                                    • 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

                                                      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-templatebody

                                                    property templateUrl

                                                    templateUrl: string;
                                                    • 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

                                                      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-templateurl

                                                    method inspect

                                                    inspect: (inspector: cdk.TreeInspector) => void;
                                                    • Examines the CloudFormation resource and discloses attributes.

                                                      Parameter inspector

                                                      tree inspector to collect and process attributes

                                                    method renderProperties

                                                    protected renderProperties: (props: { [key: string]: any }) => {
                                                    [key: string]: any;
                                                    };

                                                      class CfnTypeActivation

                                                      class CfnTypeActivation extends cdk.CfnResource implements cdk.IInspectable {}
                                                      • 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* .

                                                        AWS::CloudFormation::TypeActivation external

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html

                                                      constructor

                                                      constructor(scope: cdk.Construct, id: string, props?: CfnTypeActivationProps);
                                                      • Create a new AWS::CloudFormation::TypeActivation.

                                                        Parameter scope

                                                        scope in which this resource is defined

                                                        Parameter id

                                                        scoped id of the resource

                                                        Parameter props

                                                        resource properties

                                                      property attrArn

                                                      readonly attrArn: string;
                                                      • The Amazon Resource Number (ARN) of the activated extension, in this account and Region. Arn

                                                      property autoUpdate

                                                      autoUpdate: any;
                                                      • 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 .

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-autoupdate

                                                      property CFN_RESOURCE_TYPE_NAME

                                                      static readonly CFN_RESOURCE_TYPE_NAME: string;
                                                      • The CloudFormation resource type name for this resource class.

                                                      property cfnProperties

                                                      readonly cfnProperties: { [key: string]: any };

                                                        property executionRoleArn

                                                        executionRoleArn: string;
                                                        • The name of the IAM execution role to use to activate the extension.

                                                          http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-executionrolearn

                                                        property loggingConfig

                                                        loggingConfig: any;
                                                        • Specifies logging configuration information for an extension.

                                                          http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-loggingconfig

                                                        property majorVersion

                                                        majorVersion: string;
                                                        • 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.

                                                          http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-majorversion

                                                        property publicTypeArn

                                                        publicTypeArn: string;
                                                        • The Amazon Resource Number (ARN) of the public extension.

                                                          Conditional: You must specify PublicTypeArn , or TypeName , Type , and PublisherId .

                                                          http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-publictypearn

                                                        property publisherId

                                                        publisherId: string;
                                                        • The ID of the extension publisher.

                                                          Conditional: You must specify PublicTypeArn , or TypeName , Type , and PublisherId .

                                                          http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-publisherid

                                                        property type

                                                        type: string;
                                                        • The extension type.

                                                          Conditional: You must specify PublicTypeArn , or TypeName , Type , and PublisherId .

                                                          http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-type

                                                        property typeName

                                                        typeName: string;
                                                        • The name of the extension.

                                                          Conditional: You must specify PublicTypeArn , or TypeName , Type , and PublisherId .

                                                          http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-typename

                                                        property typeNameAlias

                                                        typeNameAlias: string;
                                                        • 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.

                                                          http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-typenamealias

                                                        property versionBump

                                                        versionBump: string;
                                                        • 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.

                                                          http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-versionbump

                                                        method inspect

                                                        inspect: (inspector: cdk.TreeInspector) => void;
                                                        • Examines the CloudFormation resource and discloses attributes.

                                                          Parameter inspector

                                                          tree inspector to collect and process attributes

                                                        method renderProperties

                                                        protected renderProperties: (props: { [key: string]: any }) => {
                                                        [key: string]: any;
                                                        };

                                                          class CfnWaitCondition

                                                          class CfnWaitCondition extends cdk.CfnResource implements cdk.IInspectable {}
                                                          • 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) .

                                                            AWS::CloudFormation::WaitCondition external

                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waitcondition.html

                                                          constructor

                                                          constructor(scope: cdk.Construct, id: string, props?: CfnWaitConditionProps);
                                                          • Create a new AWS::CloudFormation::WaitCondition.

                                                            Parameter scope

                                                            scope in which this resource is defined

                                                            Parameter id

                                                            scoped id of the resource

                                                            Parameter props

                                                            resource properties

                                                          property attrData

                                                          readonly attrData: cdk.IResolvable;
                                                          • A JSON object that contains the UniqueId and Data values from the wait condition signal(s) for the specified wait condition. For more information about wait condition signals, see [Wait condition signal JSON format](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-waitcondition.html#using-cfn-waitcondition-signaljson) .

                                                            Example return value for a wait condition with 2 signals:

                                                            { "Signal1" : "Step 1 complete." , "Signal2" : "Step 2 complete." } Data

                                                          property CFN_RESOURCE_TYPE_NAME

                                                          static readonly CFN_RESOURCE_TYPE_NAME: string;
                                                          • The CloudFormation resource type name for this resource class.

                                                          property cfnProperties

                                                          readonly cfnProperties: { [key: string]: any };

                                                            property count

                                                            count: number;
                                                            • 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.

                                                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waitcondition.html#cfn-waitcondition-count

                                                            property handle

                                                            handle: string;
                                                            • 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.

                                                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waitcondition.html#cfn-waitcondition-handle

                                                            property timeout

                                                            timeout: string;
                                                            • 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.

                                                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waitcondition.html#cfn-waitcondition-timeout

                                                            method inspect

                                                            inspect: (inspector: cdk.TreeInspector) => void;
                                                            • Examines the CloudFormation resource and discloses attributes.

                                                              Parameter inspector

                                                              tree inspector to collect and process attributes

                                                            method renderProperties

                                                            protected renderProperties: (props: { [key: string]: any }) => {
                                                            [key: string]: any;
                                                            };

                                                              class CfnWaitConditionHandle

                                                              class CfnWaitConditionHandle extends cdk.CfnResource implements cdk.IInspectable {}
                                                              • 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.

                                                                AWS::CloudFormation::WaitConditionHandle external

                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waitconditionhandle.html

                                                              constructor

                                                              constructor(scope: cdk.Construct, id: string);
                                                              • Create a new AWS::CloudFormation::WaitConditionHandle.

                                                                Parameter scope

                                                                scope in which this resource is defined

                                                                Parameter id

                                                                scoped id of the resource

                                                                Parameter props

                                                                resource properties

                                                              property CFN_RESOURCE_TYPE_NAME

                                                              static readonly CFN_RESOURCE_TYPE_NAME: string;
                                                              • The CloudFormation resource type name for this resource class.

                                                              method inspect

                                                              inspect: (inspector: cdk.TreeInspector) => void;
                                                              • Examines the CloudFormation resource and discloses attributes.

                                                                Parameter inspector

                                                                tree inspector to collect and process attributes

                                                              class CustomResource

                                                              class CustomResource extends core.CustomResource {}
                                                              • Deprecated.

                                                                Deprecated

                                                                use core.CustomResource

                                                              constructor

                                                              constructor(scope: Construct, id: string, props: CustomResourceProps);

                                                                class CustomResourceProvider

                                                                class CustomResourceProvider implements ICustomResourceProvider {}
                                                                • Represents a provider for an AWS CloudFormation custom resources.

                                                                  Deprecated

                                                                  use core.CustomResource instead

                                                                property serviceToken

                                                                readonly serviceToken: string;

                                                                  method bind

                                                                  bind: (_: Construct) => CustomResourceProviderConfig;

                                                                    method fromLambda

                                                                    static fromLambda: (handler: lambda.IFunction) => CustomResourceProvider;
                                                                    • The Lambda provider that implements this custom resource.

                                                                      We recommend using a lambda.SingletonFunction for this.

                                                                    method fromTopic

                                                                    static fromTopic: (topic: sns.ITopic) => CustomResourceProvider;
                                                                    • The SNS Topic for the provider that implements this custom resource.

                                                                    method lambda

                                                                    static lambda: (handler: lambda.IFunction) => CustomResourceProvider;
                                                                    • Use AWS Lambda as a provider.

                                                                      Deprecated

                                                                      use fromLambda

                                                                    method topic

                                                                    static topic: (topic: sns.ITopic) => CustomResourceProvider;
                                                                    • Use an SNS topic as the provider.

                                                                      Deprecated

                                                                      use fromTopic

                                                                    class NestedStack

                                                                    class NestedStack extends core.NestedStack {}
                                                                    • 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.

                                                                      Deprecated

                                                                      use core.NestedStack instead

                                                                    constructor

                                                                    constructor(scope: Construct, id: string, props?: NestedStackProps);

                                                                      Interfaces

                                                                      interface CfnCustomResourceProps

                                                                      interface CfnCustomResourceProps {}
                                                                      • Properties for defining a CfnCustomResource

                                                                        external

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cfn-customresource.html

                                                                      property serviceToken

                                                                      readonly serviceToken: string;
                                                                      • > 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.

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cfn-customresource.html#cfn-customresource-servicetoken

                                                                      interface CfnHookDefaultVersionProps

                                                                      interface CfnHookDefaultVersionProps {}
                                                                      • Properties for defining a CfnHookDefaultVersion

                                                                        external

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookdefaultversion.html

                                                                      property typeName

                                                                      readonly typeName?: string;
                                                                      • The name of the hook.

                                                                        You must specify either TypeVersionArn , or TypeName and VersionId .

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookdefaultversion.html#cfn-cloudformation-hookdefaultversion-typename

                                                                      property typeVersionArn

                                                                      readonly typeVersionArn?: string;
                                                                      • The version ID of the type configuration.

                                                                        You must specify either TypeVersionArn , or TypeName and VersionId .

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookdefaultversion.html#cfn-cloudformation-hookdefaultversion-typeversionarn

                                                                      property versionId

                                                                      readonly versionId?: string;
                                                                      • The version ID of the type specified.

                                                                        You must specify either TypeVersionArn , or TypeName and VersionId .

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookdefaultversion.html#cfn-cloudformation-hookdefaultversion-versionid

                                                                      interface CfnHookTypeConfigProps

                                                                      interface CfnHookTypeConfigProps {}
                                                                      • Properties for defining a CfnHookTypeConfig

                                                                        external

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hooktypeconfig.html

                                                                      property configuration

                                                                      readonly configuration: string;
                                                                      • Specifies the activated hook type configuration, in this AWS account and AWS Region .

                                                                        You must specify either TypeName and Configuration or TypeARN and Configuration .

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hooktypeconfig.html#cfn-cloudformation-hooktypeconfig-configuration

                                                                      property configurationAlias

                                                                      readonly configurationAlias?: string;
                                                                      • Specifies the activated hook type configuration, in this AWS account and AWS Region .

                                                                        Defaults to default alias. Hook types currently support default configuration alias.

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hooktypeconfig.html#cfn-cloudformation-hooktypeconfig-configurationalias

                                                                      property typeArn

                                                                      readonly typeArn?: string;
                                                                      • The Amazon Resource Number (ARN) for the hook to set Configuration for.

                                                                        You must specify either TypeName and Configuration or TypeARN and Configuration .

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hooktypeconfig.html#cfn-cloudformation-hooktypeconfig-typearn

                                                                      property typeName

                                                                      readonly typeName?: string;
                                                                      • 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 .

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hooktypeconfig.html#cfn-cloudformation-hooktypeconfig-typename

                                                                      interface CfnHookVersionProps

                                                                      interface CfnHookVersionProps {}
                                                                      • Properties for defining a CfnHookVersion

                                                                        external

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookversion.html

                                                                      property executionRoleArn

                                                                      readonly executionRoleArn?: string;
                                                                      • The Amazon Resource Name (ARN) of the task execution role that grants the hook permission.

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookversion.html#cfn-cloudformation-hookversion-executionrolearn

                                                                      property loggingConfig

                                                                      readonly loggingConfig?: CfnHookVersion.LoggingConfigProperty | cdk.IResolvable;
                                                                      • Contains logging configuration information for an extension.

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookversion.html#cfn-cloudformation-hookversion-loggingconfig

                                                                      property schemaHandlerPackage

                                                                      readonly schemaHandlerPackage: string;
                                                                      • 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* .

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookversion.html#cfn-cloudformation-hookversion-schemahandlerpackage

                                                                      property typeName

                                                                      readonly typeName: string;
                                                                      • 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

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookversion.html#cfn-cloudformation-hookversion-typename

                                                                      interface CfnMacroProps

                                                                      interface CfnMacroProps {}
                                                                      • Properties for defining a CfnMacro

                                                                        external

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html

                                                                      property description

                                                                      readonly description?: string;
                                                                      • A description of the macro.

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html#cfn-cloudformation-macro-description

                                                                      property functionName

                                                                      readonly functionName: string;
                                                                      • The Amazon Resource Name (ARN) of the underlying AWS Lambda function that you want AWS CloudFormation to invoke when the macro is run.

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html#cfn-cloudformation-macro-functionname

                                                                      property logGroupName

                                                                      readonly logGroupName?: string;
                                                                      • The CloudWatch Logs group to which AWS CloudFormation sends error logging information when invoking the macro's underlying AWS Lambda function.

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html#cfn-cloudformation-macro-loggroupname

                                                                      property logRoleArn

                                                                      readonly logRoleArn?: string;
                                                                      • The ARN of the role AWS CloudFormation should assume when sending log entries to CloudWatch Logs .

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html#cfn-cloudformation-macro-logrolearn

                                                                      property name

                                                                      readonly name: string;
                                                                      • The name of the macro. The name of the macro must be unique across all macros in the account.

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html#cfn-cloudformation-macro-name

                                                                      interface CfnModuleDefaultVersionProps

                                                                      interface CfnModuleDefaultVersionProps {}
                                                                      • Properties for defining a CfnModuleDefaultVersion

                                                                        external

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduledefaultversion.html

                                                                      property arn

                                                                      readonly arn?: string;
                                                                      • 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 .

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduledefaultversion.html#cfn-cloudformation-moduledefaultversion-arn

                                                                      property moduleName

                                                                      readonly moduleName?: string;
                                                                      • The name of the module.

                                                                        Conditional: You must specify either Arn , or ModuleName and VersionId .

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduledefaultversion.html#cfn-cloudformation-moduledefaultversion-modulename

                                                                      property versionId

                                                                      readonly versionId?: string;
                                                                      • The ID for the specific version of the module.

                                                                        Conditional: You must specify either Arn , or ModuleName and VersionId .

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduledefaultversion.html#cfn-cloudformation-moduledefaultversion-versionid

                                                                      interface CfnModuleVersionProps

                                                                      interface CfnModuleVersionProps {}
                                                                      • Properties for defining a CfnModuleVersion

                                                                        external

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduleversion.html

                                                                      property moduleName

                                                                      readonly moduleName: string;
                                                                      • The name of the module being registered.

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduleversion.html#cfn-cloudformation-moduleversion-modulename

                                                                      property modulePackage

                                                                      readonly modulePackage: string;
                                                                      • 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* .

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduleversion.html#cfn-cloudformation-moduleversion-modulepackage

                                                                      interface CfnPublicTypeVersionProps

                                                                      interface CfnPublicTypeVersionProps {}
                                                                      • Properties for defining a CfnPublicTypeVersion

                                                                        external

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publictypeversion.html

                                                                      property arn

                                                                      readonly arn?: string;
                                                                      • The Amazon Resource Number (ARN) of the extension.

                                                                        Conditional: You must specify Arn , or TypeName and Type .

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publictypeversion.html#cfn-cloudformation-publictypeversion-arn

                                                                      property logDeliveryBucket

                                                                      readonly logDeliveryBucket?: string;
                                                                      • 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* .

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publictypeversion.html#cfn-cloudformation-publictypeversion-logdeliverybucket

                                                                      property publicVersionNumber

                                                                      readonly publicVersionNumber?: string;
                                                                      • 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 .

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publictypeversion.html#cfn-cloudformation-publictypeversion-publicversionnumber

                                                                      property type

                                                                      readonly type?: string;
                                                                      • The type of the extension to test.

                                                                        Conditional: You must specify Arn , or TypeName and Type .

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publictypeversion.html#cfn-cloudformation-publictypeversion-type

                                                                      property typeName

                                                                      readonly typeName?: string;
                                                                      • The name of the extension to test.

                                                                        Conditional: You must specify Arn , or TypeName and Type .

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publictypeversion.html#cfn-cloudformation-publictypeversion-typename

                                                                      interface CfnPublisherProps

                                                                      interface CfnPublisherProps {}
                                                                      • Properties for defining a CfnPublisher

                                                                        external

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publisher.html

                                                                      property acceptTermsAndConditions

                                                                      readonly acceptTermsAndConditions: boolean | cdk.IResolvable;
                                                                      • 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 .

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publisher.html#cfn-cloudformation-publisher-accepttermsandconditions

                                                                      property connectionArn

                                                                      readonly connectionArn?: string;
                                                                      • 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* .

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publisher.html#cfn-cloudformation-publisher-connectionarn

                                                                      interface CfnResourceDefaultVersionProps

                                                                      interface CfnResourceDefaultVersionProps {}
                                                                      • Properties for defining a CfnResourceDefaultVersion

                                                                        external

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourcedefaultversion.html

                                                                      property typeName

                                                                      readonly typeName?: string;
                                                                      • The name of the resource.

                                                                        Conditional: You must specify either TypeVersionArn , or TypeName and VersionId .

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourcedefaultversion.html#cfn-cloudformation-resourcedefaultversion-typename

                                                                      property typeVersionArn

                                                                      readonly typeVersionArn?: string;
                                                                      • The Amazon Resource Name (ARN) of the resource version.

                                                                        Conditional: You must specify either TypeVersionArn , or TypeName and VersionId .

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourcedefaultversion.html#cfn-cloudformation-resourcedefaultversion-typeversionarn

                                                                      property versionId

                                                                      readonly versionId?: string;
                                                                      • 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 .

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourcedefaultversion.html#cfn-cloudformation-resourcedefaultversion-versionid

                                                                      interface CfnResourceVersionProps

                                                                      interface CfnResourceVersionProps {}
                                                                      • Properties for defining a CfnResourceVersion

                                                                        external

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourceversion.html

                                                                      property executionRoleArn

                                                                      readonly executionRoleArn?: string;
                                                                      • 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.

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourceversion.html#cfn-cloudformation-resourceversion-executionrolearn

                                                                      property loggingConfig

                                                                      readonly loggingConfig?:
                                                                      | CfnResourceVersion.LoggingConfigProperty
                                                                      | cdk.IResolvable;
                                                                      • Logging configuration information for a resource.

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourceversion.html#cfn-cloudformation-resourceversion-loggingconfig

                                                                      property schemaHandlerPackage

                                                                      readonly schemaHandlerPackage: string;
                                                                      • 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* .

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourceversion.html#cfn-cloudformation-resourceversion-schemahandlerpackage

                                                                      property typeName

                                                                      readonly typeName: string;
                                                                      • 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

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourceversion.html#cfn-cloudformation-resourceversion-typename

                                                                      interface CfnStackProps

                                                                      interface CfnStackProps {}
                                                                      • Properties for defining a CfnStack

                                                                        external

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html

                                                                      property notificationArns

                                                                      readonly notificationArns?: string[];
                                                                      • 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).

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html#cfn-cloudformation-stack-notificationarns

                                                                      property parameters

                                                                      readonly parameters?:
                                                                      | {
                                                                      [key: string]: string;
                                                                      }
                                                                      | cdk.IResolvable;
                                                                      • 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.

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html#cfn-cloudformation-stack-parameters

                                                                      property tags

                                                                      readonly tags?: cdk.CfnTag[];
                                                                      • 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.

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html#cfn-cloudformation-stack-tags

                                                                      property templateUrl

                                                                      readonly templateUrl: string;
                                                                      • 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.

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html#cfn-cloudformation-stack-templateurl

                                                                      property timeoutInMinutes

                                                                      readonly timeoutInMinutes?: number;
                                                                      • 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.

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html#cfn-cloudformation-stack-timeoutinminutes

                                                                      interface CfnStackSetProps

                                                                      interface CfnStackSetProps {}
                                                                      • Properties for defining a CfnStackSet

                                                                        external

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html

                                                                      property administrationRoleArn

                                                                      readonly administrationRoleArn?: string;
                                                                      • 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

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-administrationrolearn

                                                                      property autoDeployment

                                                                      readonly autoDeployment?: CfnStackSet.AutoDeploymentProperty | cdk.IResolvable;
                                                                      • [ Service-managed permissions] Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU).

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-autodeployment

                                                                      property callAs

                                                                      readonly callAs?: string;
                                                                      • [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

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-callas

                                                                      property capabilities

                                                                      readonly capabilities?: string[];
                                                                      • 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) .

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-capabilities

                                                                      property description

                                                                      readonly description?: string;
                                                                      • A description of the stack set.

                                                                        *Minimum* : 1

                                                                        *Maximum* : 1024

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-description

                                                                      property executionRoleName

                                                                      readonly executionRoleName?: string;
                                                                      • 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+=,.@-]+

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-executionrolename

                                                                      property managedExecution

                                                                      readonly managedExecution?: any | cdk.IResolvable;
                                                                      • 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.

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-managedexecution

                                                                      property operationPreferences

                                                                      readonly operationPreferences?:
                                                                      | CfnStackSet.OperationPreferencesProperty
                                                                      | cdk.IResolvable;
                                                                      • The user-specified preferences for how AWS CloudFormation performs a stack set operation.

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-operationpreferences

                                                                      property parameters

                                                                      readonly parameters?:
                                                                      | Array<CfnStackSet.ParameterProperty | cdk.IResolvable>
                                                                      | cdk.IResolvable;
                                                                      • The input parameters for the stack set template.

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-parameters

                                                                      property permissionModel

                                                                      readonly permissionModel: string;
                                                                      • 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.

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-permissionmodel

                                                                      property stackInstancesGroup

                                                                      readonly stackInstancesGroup?:
                                                                      | Array<CfnStackSet.StackInstancesProperty | cdk.IResolvable>
                                                                      | cdk.IResolvable;
                                                                      • A group of stack instances with parameters in some specific accounts and Regions.

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-stackinstancesgroup

                                                                      property stackSetName

                                                                      readonly stackSetName: string;
                                                                      • 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.

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-stacksetname

                                                                      property tags

                                                                      readonly tags?: cdk.CfnTag[];
                                                                      • 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.

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-tags

                                                                      property templateBody

                                                                      readonly templateBody?: string;
                                                                      • 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

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-templatebody

                                                                      property templateUrl

                                                                      readonly templateUrl?: string;
                                                                      • 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

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-templateurl

                                                                      interface CfnTypeActivationProps

                                                                      interface CfnTypeActivationProps {}
                                                                      • Properties for defining a CfnTypeActivation

                                                                        external

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html

                                                                      property autoUpdate

                                                                      readonly autoUpdate?: boolean | cdk.IResolvable;
                                                                      • 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 .

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-autoupdate

                                                                      property executionRoleArn

                                                                      readonly executionRoleArn?: string;
                                                                      • The name of the IAM execution role to use to activate the extension.

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-executionrolearn

                                                                      property loggingConfig

                                                                      readonly loggingConfig?:
                                                                      | CfnTypeActivation.LoggingConfigProperty
                                                                      | cdk.IResolvable;
                                                                      • Specifies logging configuration information for an extension.

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-loggingconfig

                                                                      property majorVersion

                                                                      readonly majorVersion?: string;
                                                                      • 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.

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-majorversion

                                                                      property publicTypeArn

                                                                      readonly publicTypeArn?: string;
                                                                      • The Amazon Resource Number (ARN) of the public extension.

                                                                        Conditional: You must specify PublicTypeArn , or TypeName , Type , and PublisherId .

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-publictypearn

                                                                      property publisherId

                                                                      readonly publisherId?: string;
                                                                      • The ID of the extension publisher.

                                                                        Conditional: You must specify PublicTypeArn , or TypeName , Type , and PublisherId .

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-publisherid

                                                                      property type

                                                                      readonly type?: string;
                                                                      • The extension type.

                                                                        Conditional: You must specify PublicTypeArn , or TypeName , Type , and PublisherId .

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-type

                                                                      property typeName

                                                                      readonly typeName?: string;
                                                                      • The name of the extension.

                                                                        Conditional: You must specify PublicTypeArn , or TypeName , Type , and PublisherId .

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-typename

                                                                      property typeNameAlias

                                                                      readonly typeNameAlias?: string;
                                                                      • 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.

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-typenamealias

                                                                      property versionBump

                                                                      readonly versionBump?: string;
                                                                      • 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.

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-versionbump

                                                                      interface CfnWaitConditionProps

                                                                      interface CfnWaitConditionProps {}
                                                                      • Properties for defining a CfnWaitCondition

                                                                        external

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waitcondition.html

                                                                      property count

                                                                      readonly count?: number;
                                                                      • 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.

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waitcondition.html#cfn-waitcondition-count

                                                                      property handle

                                                                      readonly handle?: string;
                                                                      • 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.

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waitcondition.html#cfn-waitcondition-handle

                                                                      property timeout

                                                                      readonly timeout?: string;
                                                                      • 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.

                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waitcondition.html#cfn-waitcondition-timeout

                                                                      interface CustomResourceProps

                                                                      interface CustomResourceProps {}
                                                                      • Properties to provide a Lambda-backed custom resource

                                                                        Deprecated

                                                                        use core.CustomResourceProps

                                                                      property properties

                                                                      readonly properties?: Properties;
                                                                      • Properties to pass to the Lambda

                                                                        - No properties.

                                                                      property provider

                                                                      readonly provider: ICustomResourceProvider;
                                                                      • The provider which implements the custom resource.

                                                                        You can implement a provider by listening to raw AWS CloudFormation events through an SNS topic or an AWS Lambda function 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

                                                                        import * as custom_resources from '@aws-cdk/custom-resources';
                                                                        import * as lambda from '@aws-cdk/aws-lambda';
                                                                        import { Stack } from '@aws-cdk/core';
                                                                        declare const myOnEventLambda: lambda.Function;
                                                                        declare const myIsCompleteLambda: lambda.Function;
                                                                        const stack = new Stack();
                                                                        const provider = new custom_resources.Provider(stack, 'myProvider', {
                                                                        onEventHandler: myOnEventLambda,
                                                                        isCompleteHandler: myIsCompleteLambda, // optional
                                                                        });

                                                                        import * as cloudformation from '@aws-cdk/aws-cloudformation';
                                                                        import * as lambda from '@aws-cdk/aws-lambda';
                                                                        declare const myFunction: lambda.Function;
                                                                        // invoke an AWS Lambda function when a lifecycle event occurs:
                                                                        const provider = cloudformation.CustomResourceProvider.fromLambda(myFunction);

                                                                        import * as cloudformation from '@aws-cdk/aws-cloudformation';
                                                                        import * as sns from '@aws-cdk/aws-sns';
                                                                        declare const myTopic: sns.Topic;
                                                                        // publish lifecycle events to an SNS topic:
                                                                        const provider = cloudformation.CustomResourceProvider.fromTopic(myTopic);

                                                                      property removalPolicy

                                                                      readonly removalPolicy?: core.RemovalPolicy;
                                                                      • The policy to apply when this resource is removed from the application.

                                                                        cdk.RemovalPolicy.Destroy

                                                                      property resourceType

                                                                      readonly resourceType?: string;
                                                                      • 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 Also

                                                                        • https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cfn-customresource.html#aws-cfn-resource-type-name

                                                                          - AWS::CloudFormation::CustomResource

                                                                      interface CustomResourceProviderConfig

                                                                      interface CustomResourceProviderConfig {}
                                                                      • Configuration options for custom resource providers.

                                                                        Deprecated

                                                                        used in ICustomResourceProvider which is now deprecated

                                                                      property serviceToken

                                                                      readonly serviceToken: string;
                                                                      • The ARN of the SNS topic or the AWS Lambda function which implements this provider.

                                                                      interface ICustomResourceProvider

                                                                      interface ICustomResourceProvider {}
                                                                      • Represents a provider for an AWS CloudFormation custom resources.

                                                                        Deprecated

                                                                        use core.ICustomResourceProvider

                                                                      method bind

                                                                      bind: (scope: Construct) => CustomResourceProviderConfig;
                                                                      • Called when this provider is used by a CustomResource.

                                                                        Parameter scope

                                                                        The resource that uses this provider.

                                                                        Returns

                                                                        provider configuration

                                                                      interface NestedStackProps

                                                                      interface NestedStackProps {}
                                                                      • Initialization props for the NestedStack construct.

                                                                        Deprecated

                                                                        use core.NestedStackProps instead

                                                                      property notifications

                                                                      readonly notifications?: sns.ITopic[];
                                                                      • The Simple Notification Service (SNS) topics to publish stack related events.

                                                                        - notifications are not sent for this stack.

                                                                      property parameters

                                                                      readonly parameters?: {
                                                                      [key: string]: string;
                                                                      };
                                                                      • 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.

                                                                        - no user-defined parameters are passed to the nested stack

                                                                      property timeout

                                                                      readonly timeout?: core.Duration;
                                                                      • 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.

                                                                        - no timeout

                                                                      Enums

                                                                      enum CloudFormationCapabilities

                                                                      enum CloudFormationCapabilities {
                                                                      NONE = '',
                                                                      ANONYMOUS_IAM = 'CAPABILITY_IAM',
                                                                      NAMED_IAM = 'CAPABILITY_NAMED_IAM',
                                                                      AUTO_EXPAND = 'CAPABILITY_AUTO_EXPAND',
                                                                      }
                                                                      • Capabilities that affect whether CloudFormation is allowed to change IAM resources

                                                                        Deprecated

                                                                        use core.CfnCapabilities

                                                                      member ANONYMOUS_IAM

                                                                      ANONYMOUS_IAM = 'CAPABILITY_IAM'
                                                                      • Capability to create anonymous IAM resources

                                                                        Pass this capability if you're only creating anonymous resources. https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities

                                                                      member AUTO_EXPAND

                                                                      AUTO_EXPAND = 'CAPABILITY_AUTO_EXPAND'
                                                                      • Capability to run CloudFormation macros

                                                                        Pass this capability if your template includes macros, for example AWS::Include or AWS::Serverless.

                                                                        https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateStack.html

                                                                      member NAMED_IAM

                                                                      NAMED_IAM = 'CAPABILITY_NAMED_IAM'
                                                                      • Capability to create named IAM resources.

                                                                        Pass this capability if you're creating IAM resources that have physical names.

                                                                        CloudFormationCapabilities.NamedIAM implies CloudFormationCapabilities.IAM; you don't have to pass both. https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities

                                                                      member NONE

                                                                      NONE = ''
                                                                      • No IAM Capabilities

                                                                        Pass this capability if you wish to block the creation IAM resources. https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities

                                                                      Type Aliases

                                                                      type Properties

                                                                      type Properties = {
                                                                      [key: string]: any;
                                                                      };
                                                                      • Collection of arbitrary properties

                                                                        Deprecated

                                                                        this type has been deprecated in favor of using a key-value type directly

                                                                      Namespaces

                                                                      namespace CfnHookVersion

                                                                      namespace CfnHookVersion {}

                                                                        interface LoggingConfigProperty

                                                                        interface LoggingConfigProperty {}
                                                                        • The LoggingConfig property type specifies logging configuration information for an extension.

                                                                          external

                                                                          http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-hookversion-loggingconfig.html

                                                                        property logGroupName

                                                                        readonly logGroupName?: string;
                                                                        • The Amazon CloudWatch Logs group to which CloudFormation sends error logging information when invoking the extension's handlers.

                                                                          http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-hookversion-loggingconfig.html#cfn-cloudformation-hookversion-loggingconfig-loggroupname

                                                                        property logRoleArn

                                                                        readonly logRoleArn?: string;
                                                                        • The Amazon Resource Name (ARN) of the role that CloudFormation should assume when sending log entries to CloudWatch Logs.

                                                                          http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-hookversion-loggingconfig.html#cfn-cloudformation-hookversion-loggingconfig-logrolearn

                                                                        namespace CfnResourceVersion

                                                                        namespace CfnResourceVersion {}

                                                                          interface LoggingConfigProperty

                                                                          interface LoggingConfigProperty {}
                                                                          • Logging configuration information for a resource.

                                                                            external

                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-resourceversion-loggingconfig.html

                                                                          property logGroupName

                                                                          readonly logGroupName?: string;
                                                                          • The Amazon CloudWatch log group to which CloudFormation sends error logging information when invoking the type's handlers.

                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-resourceversion-loggingconfig.html#cfn-cloudformation-resourceversion-loggingconfig-loggroupname

                                                                          property logRoleArn

                                                                          readonly logRoleArn?: string;
                                                                          • The ARN of the role that CloudFormation should assume when sending log entries to CloudWatch logs.

                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-resourceversion-loggingconfig.html#cfn-cloudformation-resourceversion-loggingconfig-logrolearn

                                                                          namespace CfnStackSet

                                                                          namespace CfnStackSet {}

                                                                            interface AutoDeploymentProperty

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

                                                                              external

                                                                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-autodeployment.html

                                                                            property enabled

                                                                            readonly enabled?: boolean | cdk.IResolvable;
                                                                            • 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.

                                                                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-autodeployment.html#cfn-cloudformation-stackset-autodeployment-enabled

                                                                            property retainStacksOnAccountRemoval

                                                                            readonly retainStacksOnAccountRemoval?: boolean | cdk.IResolvable;
                                                                            • 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 .

                                                                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-autodeployment.html#cfn-cloudformation-stackset-autodeployment-retainstacksonaccountremoval

                                                                            interface DeploymentTargetsProperty

                                                                            interface DeploymentTargetsProperty {}
                                                                            • The AWS OrganizationalUnitIds or Accounts for which to create stack instances in the specified Regions.

                                                                              external

                                                                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-deploymenttargets.html

                                                                            property accountFilterType

                                                                            readonly accountFilterType?: string;
                                                                            • CfnStackSet.DeploymentTargetsProperty.AccountFilterType

                                                                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-deploymenttargets.html#cfn-cloudformation-stackset-deploymenttargets-accountfiltertype

                                                                            property accounts

                                                                            readonly accounts?: string[];
                                                                            • The names of one or more AWS accounts for which you want to deploy stack set updates.

                                                                              *Pattern* : ^[0-9]{12}$

                                                                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-deploymenttargets.html#cfn-cloudformation-stackset-deploymenttargets-accounts

                                                                            property organizationalUnitIds

                                                                            readonly organizationalUnitIds?: string[];
                                                                            • 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})$

                                                                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-deploymenttargets.html#cfn-cloudformation-stackset-deploymenttargets-organizationalunitids

                                                                            interface OperationPreferencesProperty

                                                                            interface OperationPreferencesProperty {}
                                                                            • 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) .

                                                                              external

                                                                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-operationpreferences.html

                                                                            property failureToleranceCount

                                                                            readonly failureToleranceCount?: number;
                                                                            • 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).

                                                                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-operationpreferences.html#cfn-cloudformation-stackset-operationpreferences-failuretolerancecount

                                                                            property failureTolerancePercentage

                                                                            readonly failureTolerancePercentage?: number;
                                                                            • 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.

                                                                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-operationpreferences.html#cfn-cloudformation-stackset-operationpreferences-failuretolerancepercentage

                                                                            property maxConcurrentCount

                                                                            readonly maxConcurrentCount?: number;
                                                                            • 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.

                                                                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-operationpreferences.html#cfn-cloudformation-stackset-operationpreferences-maxconcurrentcount

                                                                            property maxConcurrentPercentage

                                                                            readonly maxConcurrentPercentage?: number;
                                                                            • 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.

                                                                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-operationpreferences.html#cfn-cloudformation-stackset-operationpreferences-maxconcurrentpercentage

                                                                            property regionConcurrencyType

                                                                            readonly regionConcurrencyType?: string;
                                                                            • The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time.

                                                                              *Allowed values* : SEQUENTIAL | PARALLEL

                                                                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-operationpreferences.html#cfn-cloudformation-stackset-operationpreferences-regionconcurrencytype

                                                                            property regionOrder

                                                                            readonly regionOrder?: string[];
                                                                            • The order of the Regions where you want to perform the stack operation.

                                                                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-operationpreferences.html#cfn-cloudformation-stackset-operationpreferences-regionorder

                                                                            interface ParameterProperty

                                                                            interface ParameterProperty {}
                                                                            • The Parameter data type.

                                                                              external

                                                                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-parameter.html

                                                                            property parameterKey

                                                                            readonly parameterKey: string;
                                                                            • 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.

                                                                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-parameter.html#cfn-cloudformation-stackset-parameter-parameterkey

                                                                            property parameterValue

                                                                            readonly parameterValue: string;
                                                                            • The input value associated with the parameter.

                                                                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-parameter.html#cfn-cloudformation-stackset-parameter-parametervalue

                                                                            interface StackInstancesProperty

                                                                            interface StackInstancesProperty {}
                                                                            • Stack instances in some specific accounts and Regions.

                                                                              external

                                                                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-stackinstances.html

                                                                            property deploymentTargets

                                                                            readonly deploymentTargets:
                                                                            | CfnStackSet.DeploymentTargetsProperty
                                                                            | cdk.IResolvable;
                                                                            • The AWS OrganizationalUnitIds or Accounts for which to create stack instances in the specified Regions.

                                                                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-stackinstances.html#cfn-cloudformation-stackset-stackinstances-deploymenttargets

                                                                            property parameterOverrides

                                                                            readonly parameterOverrides?:
                                                                            | Array<CfnStackSet.ParameterProperty | cdk.IResolvable>
                                                                            | cdk.IResolvable;
                                                                            • A list of stack set parameters whose values you want to override in the selected stack instances.

                                                                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-stackinstances.html#cfn-cloudformation-stackset-stackinstances-parameteroverrides

                                                                            property regions

                                                                            readonly regions: string[];
                                                                            • The names of one or more Regions where you want to create stack instances using the specified AWS accounts .

                                                                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-stackinstances.html#cfn-cloudformation-stackset-stackinstances-regions

                                                                            namespace CfnTypeActivation

                                                                            namespace CfnTypeActivation {}

                                                                              interface LoggingConfigProperty

                                                                              interface LoggingConfigProperty {}
                                                                              • Contains logging configuration information for an extension.

                                                                                external

                                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-typeactivation-loggingconfig.html

                                                                              property logGroupName

                                                                              readonly logGroupName?: string;
                                                                              • The Amazon CloudWatch Logs group to which CloudFormation sends error logging information when invoking the extension's handlers.

                                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-typeactivation-loggingconfig.html#cfn-cloudformation-typeactivation-loggingconfig-loggroupname

                                                                              property logRoleArn

                                                                              readonly logRoleArn?: string;
                                                                              • The Amazon Resource Name (ARN) of the role that CloudFormation should assume when sending log entries to CloudWatch Logs.

                                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-typeactivation-loggingconfig.html#cfn-cloudformation-typeactivation-loggingconfig-logrolearn

                                                                              Package Files (5)

                                                                              Dependencies (7)

                                                                              Dev Dependencies (13)

                                                                              Peer Dependencies (7)

                                                                              Badge

                                                                              To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                                                              You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@aws-cdk/aws-cloudformation.

                                                                              • Markdown
                                                                                [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@aws-cdk/aws-cloudformation)
                                                                              • HTML
                                                                                <a href="https://www.jsdocs.io/package/@aws-cdk/aws-cloudformation"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>