@aws-cdk/aws-cloudformation

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;
};

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;
};

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;
};

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;
};

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;
};

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;
};

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;
};

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;
};

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;
};

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;
};

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;
};

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;
};

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) .

  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;
};

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;
};

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;
};

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

constructor

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

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

constructor

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

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

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

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

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