UNPKG

aws-cdk-lib

Version:

Version 2 of the AWS Cloud Development Kit library

1,106 lines 153 kB
import * as cdk from "../../core"; import * as constructs from "constructs"; import * as cfn_parse from "../../core/lib/helpers-internal"; /** * The `AWS::CloudFormation::CustomResource` resource creates a custom resource. * * Custom resources provide a way for you to write custom provisioning logic into your CloudFormation templates and have CloudFormation run it anytime you create, update (if you changed the custom resource), or delete a stack. * * For more information, see [Create custom provisioning logic with custom resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-custom-resources.html) in the *AWS CloudFormation User Guide* . * * > If you use AWS PrivateLink , custom resources in the VPC must have access to CloudFormation -specific 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 [Access CloudFormation using an interface endpoint ( AWS PrivateLink )](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/vpc-interface-endpoints.html) in the *AWS CloudFormation User Guide* . * * @cloudformationResource AWS::CloudFormation::CustomResource * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-customresource.html */ export declare class CfnCustomResource extends cdk.CfnResource implements cdk.IInspectable { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnCustomResource from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnCustomResource; /** * @cloudformationAttribute Id */ readonly attrId: string; /** * The maximum time, in seconds, that can elapse before a custom resource operation times out. */ serviceTimeout?: number; /** * The service token, such as an Amazon SNS topic ARN or Lambda function ARN. */ serviceToken: string; /** * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnCustomResourceProps); protected get cfnProperties(): Record<string, any>; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record<string, any>): Record<string, any>; } /** * Properties for defining a `CfnCustomResource` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-customresource.html */ export interface CfnCustomResourceProps { /** * The maximum time, in seconds, that can elapse before a custom resource operation times out. * * The value must be an integer from 1 to 3600. The default value is 3600 seconds (1 hour). * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-customresource.html#cfn-cloudformation-customresource-servicetimeout */ readonly serviceTimeout?: number; /** * The service token, such as an Amazon SNS topic ARN or Lambda function ARN. * * The service token must be from the same Region as the stack. * * Updates aren't supported. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-customresource.html#cfn-cloudformation-customresource-servicetoken */ readonly serviceToken: string; } /** * The `AWS::CloudFormation::HookDefaultVersion` resource specifies the default version of a Hook. * * The default version of the Hook is used in CloudFormation operations for this AWS account and AWS Region . * * For information about the CloudFormation registry, see [Managing extensions with the CloudFormation registry](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html) in the *AWS CloudFormation User Guide* . * * This resource type is not compatible with Guard and Lambda Hooks. * * @cloudformationResource AWS::CloudFormation::HookDefaultVersion * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookdefaultversion.html */ export declare class CfnHookDefaultVersion extends cdk.CfnResource implements cdk.IInspectable { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnHookDefaultVersion from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnHookDefaultVersion; /** * The Amazon Resource Number (ARN) of the activated Hook, in this account and Region. * * @cloudformationAttribute Arn */ readonly attrArn: string; /** * The name of the Hook. */ typeName?: string; /** * The version ID of the type configuration. */ typeVersionArn?: string; /** * The version ID of the type specified. */ versionId?: string; /** * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props?: CfnHookDefaultVersionProps); protected get cfnProperties(): Record<string, any>; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record<string, any>): Record<string, any>; } /** * Properties for defining a `CfnHookDefaultVersion` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookdefaultversion.html */ export interface CfnHookDefaultVersionProps { /** * The name of the Hook. * * You must specify either `TypeVersionArn` , or `TypeName` and `VersionId` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookdefaultversion.html#cfn-cloudformation-hookdefaultversion-typename */ readonly typeName?: string; /** * The version ID of the type configuration. * * You must specify either `TypeVersionArn` , or `TypeName` and `VersionId` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookdefaultversion.html#cfn-cloudformation-hookdefaultversion-typeversionarn */ readonly typeVersionArn?: string; /** * The version ID of the type specified. * * You must specify either `TypeVersionArn` , or `TypeName` and `VersionId` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookdefaultversion.html#cfn-cloudformation-hookdefaultversion-versionid */ readonly versionId?: string; } /** * The `AWS::CloudFormation::HookTypeConfig` resource specifies the configuration of an activated Hook. * * For information about the CloudFormation registry, see [Managing extensions with the CloudFormation registry](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html) in the *AWS CloudFormation User Guide* . * * @cloudformationResource AWS::CloudFormation::HookTypeConfig * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hooktypeconfig.html */ export declare class CfnHookTypeConfig extends cdk.CfnResource implements cdk.IInspectable { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnHookTypeConfig from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnHookTypeConfig; /** * The Amazon Resource Number (ARN) of the activated Hook type configuration, in this account and Region. * * @cloudformationAttribute ConfigurationArn */ readonly attrConfigurationArn: string; /** * Specifies the activated Hook type configuration, in this AWS account and AWS Region . */ configuration: string; /** * An alias by which to refer to this configuration data. */ configurationAlias?: string; /** * The Amazon Resource Number (ARN) for the Hook to set `Configuration` for. */ typeArn?: string; /** * The unique name for your Hook. */ typeName?: string; /** * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnHookTypeConfigProps); protected get cfnProperties(): Record<string, any>; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record<string, any>): Record<string, any>; } /** * Properties for defining a `CfnHookTypeConfig` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hooktypeconfig.html */ export interface CfnHookTypeConfigProps { /** * Specifies the activated Hook type configuration, in this AWS account and AWS Region . * * You must specify either `TypeName` and `Configuration` or `TypeArn` and `Configuration` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hooktypeconfig.html#cfn-cloudformation-hooktypeconfig-configuration */ readonly configuration: string; /** * An alias by which to refer to this configuration data. * * Defaults to `default` alias. Hook types currently support default configuration alias. * * @default - "default" * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hooktypeconfig.html#cfn-cloudformation-hooktypeconfig-configurationalias */ readonly configurationAlias?: string; /** * The Amazon Resource Number (ARN) for the Hook to set `Configuration` for. * * You must specify either `TypeName` and `Configuration` or `TypeArn` and `Configuration` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hooktypeconfig.html#cfn-cloudformation-hooktypeconfig-typearn */ readonly typeArn?: 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` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hooktypeconfig.html#cfn-cloudformation-hooktypeconfig-typename */ readonly typeName?: string; } /** * The `AWS::CloudFormation::HookVersion` resource publishes new or first version of a Hook to the CloudFormation registry. * * For information about the CloudFormation registry, see [Managing extensions with the CloudFormation registry](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html) in the *AWS CloudFormation User Guide* . * * This resource type is not compatible with Guard and Lambda Hooks. * * @cloudformationResource AWS::CloudFormation::HookVersion * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookversion.html */ export declare class CfnHookVersion extends cdk.CfnResource implements cdk.IInspectable { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnHookVersion from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnHookVersion; /** * The Amazon Resource Name (ARN) of the Hook. * * @cloudformationAttribute Arn */ readonly attrArn: string; /** * Whether the specified Hook version is set as the default version. * * @cloudformationAttribute IsDefaultVersion */ readonly attrIsDefaultVersion: cdk.IResolvable; /** * The Amazon Resource Number (ARN) assigned to this version of the Hook. * * @cloudformationAttribute TypeArn */ readonly attrTypeArn: string; /** * The ID of this version of the Hook. * * @cloudformationAttribute VersionId */ readonly attrVersionId: string; /** * The visibility level that determines who can see and use this Hook in CloudFormation operations: * * - `PRIVATE` : The Hook is only visible and usable within the account where it was registered. CloudFormation automatically marks any Hooks you register as `PRIVATE` . * - `PUBLIC` : The Hook is publicly visible and usable within any AWS account. * * @cloudformationAttribute Visibility */ readonly attrVisibility: string; /** * The Amazon Resource Name (ARN) of the task execution role that grants the Hook permission. */ executionRoleArn?: string; /** * Contains logging configuration information for an extension. */ loggingConfig?: cdk.IResolvable | CfnHookVersion.LoggingConfigProperty; /** * A URL to the Amazon S3 bucket containing the Hook project package that contains the necessary files for the Hook you want to register. */ schemaHandlerPackage: string; /** * The unique name for your hook. */ typeName: string; /** * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnHookVersionProps); protected get cfnProperties(): Record<string, any>; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record<string, any>): Record<string, any>; } export declare namespace CfnHookVersion { /** * The `LoggingConfig` property type specifies logging configuration information for an extension. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-hookversion-loggingconfig.html */ interface LoggingConfigProperty { /** * The Amazon CloudWatch Logs group to which CloudFormation sends error logging information when invoking the extension's handlers. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-hookversion-loggingconfig.html#cfn-cloudformation-hookversion-loggingconfig-loggroupname */ readonly logGroupName?: string; /** * The Amazon Resource Name (ARN) of the role that CloudFormation should assume when sending log entries to CloudWatch Logs. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-hookversion-loggingconfig.html#cfn-cloudformation-hookversion-loggingconfig-logrolearn */ readonly logRoleArn?: string; } } /** * Properties for defining a `CfnHookVersion` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookversion.html */ export interface CfnHookVersionProps { /** * The Amazon Resource Name (ARN) of the task execution role that grants the Hook permission. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookversion.html#cfn-cloudformation-hookversion-executionrolearn */ readonly executionRoleArn?: string; /** * Contains logging configuration information for an extension. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookversion.html#cfn-cloudformation-hookversion-loggingconfig */ readonly loggingConfig?: cdk.IResolvable | CfnHookVersion.LoggingConfigProperty; /** * 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, see [Modeling custom CloudFormation Hooks](https://docs.aws.amazon.com/cloudformation-cli/latest/hooks-userguide/hooks-model.html) in the *AWS CloudFormation Hooks User Guide* . * * > To register the Hook, you must have `s3:GetObject` permissions to access the S3 objects. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookversion.html#cfn-cloudformation-hookversion-schemahandlerpackage */ readonly schemaHandlerPackage: 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` * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookversion.html#cfn-cloudformation-hookversion-typename */ readonly typeName: string; } /** * 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 [Perform custom processing on CloudFormation templates with template macros](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html) in the *AWS CloudFormation User Guide* . * * @cloudformationResource AWS::CloudFormation::Macro * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html */ export declare class CfnMacro extends cdk.CfnResource implements cdk.IInspectable { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnMacro from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnMacro; /** * @cloudformationAttribute Id */ readonly attrId: string; /** * A description of the macro. */ description?: string; /** * The Amazon Resource Name (ARN) of the underlying Lambda function that you want CloudFormation to invoke when the macro is run. */ functionName: string; /** * The CloudWatch Logs group to which CloudFormation sends error logging information when invoking the macro's underlying Lambda function. */ logGroupName?: string; /** * The ARN of the role CloudFormation should assume when sending log entries to CloudWatch Logs . */ logRoleArn?: string; /** * The name of the macro. */ name: string; /** * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnMacroProps); protected get cfnProperties(): Record<string, any>; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record<string, any>): Record<string, any>; } /** * Properties for defining a `CfnMacro` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html */ export interface CfnMacroProps { /** * A description of the macro. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html#cfn-cloudformation-macro-description */ readonly description?: string; /** * The Amazon Resource Name (ARN) of the underlying Lambda function that you want CloudFormation to invoke when the macro is run. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html#cfn-cloudformation-macro-functionname */ readonly functionName: string; /** * The CloudWatch Logs group to which CloudFormation sends error logging information when invoking the macro's underlying Lambda function. * * This will be an existing CloudWatch Logs LogGroup. Neither CloudFormation or Lambda will create the group. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html#cfn-cloudformation-macro-loggroupname */ readonly logGroupName?: string; /** * The ARN of the role CloudFormation should assume when sending log entries to CloudWatch Logs . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html#cfn-cloudformation-macro-logrolearn */ readonly logRoleArn?: string; /** * The name of the macro. * * The name of the macro must be unique across all macros in the account. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html#cfn-cloudformation-macro-name */ readonly name: string; } /** * Specifies the default version of a module. * * The default version of the module will be used in CloudFormation operations for this account and Region. * * For more information, see [Create reusable resource configurations that can be included across templates with CloudFormation modules](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/modules.html) in the *AWS CloudFormation User Guide* . * * For information about the CloudFormation registry, see [Managing extensions with the CloudFormation registry](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html) in the *AWS CloudFormation User Guide* . * * @cloudformationResource AWS::CloudFormation::ModuleDefaultVersion * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduledefaultversion.html */ export declare class CfnModuleDefaultVersion extends cdk.CfnResource implements cdk.IInspectable { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnModuleDefaultVersion from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnModuleDefaultVersion; /** * The Amazon Resource Name (ARN) of the module version to set as the default version. */ arn?: string; /** * The name of the module. */ moduleName?: string; /** * The ID for the specific version of the module. */ versionId?: string; /** * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props?: CfnModuleDefaultVersionProps); protected get cfnProperties(): Record<string, any>; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record<string, any>): Record<string, any>; } /** * Properties for defining a `CfnModuleDefaultVersion` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduledefaultversion.html */ export interface CfnModuleDefaultVersionProps { /** * 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` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduledefaultversion.html#cfn-cloudformation-moduledefaultversion-arn */ readonly arn?: string; /** * The name of the module. * * Conditional: You must specify either `Arn` , or `ModuleName` and `VersionId` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduledefaultversion.html#cfn-cloudformation-moduledefaultversion-modulename */ readonly moduleName?: string; /** * The ID for the specific version of the module. * * Conditional: You must specify either `Arn` , or `ModuleName` and `VersionId` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduledefaultversion.html#cfn-cloudformation-moduledefaultversion-versionid */ readonly versionId?: string; } /** * The `AWS::CloudFormation::ModuleVersion` resource registers the specified version of the module with the CloudFormation registry. * * Registering a module makes it available for use in CloudFormation templates in your AWS account and Region. * * For more information, see [Create reusable resource configurations that can be included across templates with CloudFormation modules](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/modules.html) in the *CloudFormation User Guide* . * * For information about the CloudFormation registry, see [Managing extensions with the CloudFormation registry](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html) in the *AWS CloudFormation User Guide* . * * @cloudformationResource AWS::CloudFormation::ModuleVersion * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduleversion.html */ export declare class CfnModuleVersion extends cdk.CfnResource implements cdk.IInspectable { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnModuleVersion from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnModuleVersion; /** * The Amazon Resource Name (ARN) of the module. * * @cloudformationAttribute Arn */ readonly attrArn: string; /** * The description of the module. * * @cloudformationAttribute Description */ readonly attrDescription: string; /** * The URL of a page providing detailed documentation for this module. * * @cloudformationAttribute DocumentationUrl */ readonly attrDocumentationUrl: string; /** * Whether the specified module version is set as the default version. * * This applies only to private extensions you have registered in your account, and extensions published by AWS . For public third-party extensions, whether they are activated in your account, CloudFormation returns `null` . * * @cloudformationAttribute IsDefaultVersion */ readonly attrIsDefaultVersion: cdk.IResolvable; /** * The schema that defines the module. * * @cloudformationAttribute Schema */ readonly attrSchema: string; /** * When the specified private module version was registered or activated in your account. * * @cloudformationAttribute TimeCreated */ readonly attrTimeCreated: string; /** * The ID of this version of the module. * * @cloudformationAttribute VersionId */ readonly attrVersionId: string; /** * The visibility level that determines who can see and use this module in CloudFormation operations: * * - `PRIVATE` : The module is only visible and usable within the account where it was registered. CloudFormation automatically marks any modules you register as `PRIVATE` . * - `PUBLIC` : The module is publicly visible and usable within any AWS account. * * @cloudformationAttribute Visibility */ readonly attrVisibility: string; /** * The name of the module being registered. */ moduleName: string; /** * A URL to the S3 bucket containing the package that contains the template fragment and schema files for the module version to register. */ modulePackage: string; /** * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnModuleVersionProps); protected get cfnProperties(): Record<string, any>; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record<string, any>): Record<string, any>; } /** * Properties for defining a `CfnModuleVersion` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduleversion.html */ export interface CfnModuleVersionProps { /** * The name of the module being registered. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduleversion.html#cfn-cloudformation-moduleversion-modulename */ readonly moduleName: string; /** * A URL to the S3 bucket containing the package that contains the template fragment and schema files for the module version to register. * * For more information, see [Module structure and requirements](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/modules-structure.html) in the *AWS CloudFormation Command Line Interface (CLI) User Guide* . * * > To register the module version, you must have `s3:GetObject` permissions to access the S3 objects. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduleversion.html#cfn-cloudformation-moduleversion-modulepackage */ readonly modulePackage: string; } /** * The `AWS::CloudFormation::PublicTypeVersion` resource 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 *AWS CloudFormation Command Line Interface (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/publish-extension.html) in the *AWS CloudFormation Command Line Interface (CLI) User Guide* . * * @cloudformationResource AWS::CloudFormation::PublicTypeVersion * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publictypeversion.html */ export declare class CfnPublicTypeVersion extends cdk.CfnResource implements cdk.IInspectable { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnPublicTypeVersion from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnPublicTypeVersion; /** * The Amazon Resource Number (ARN) assigned to the public extension upon publication. * * @cloudformationAttribute PublicTypeArn */ readonly attrPublicTypeArn: string; /** * The publisher ID of the extension publisher. * * This applies only to public third-party extensions. For private registered extensions, and extensions provided by AWS , CloudFormation returns `null` . * * @cloudformationAttribute PublisherId */ readonly attrPublisherId: string; /** * The Amazon Resource Number (ARN) assigned to this version of the extension. * * @cloudformationAttribute TypeVersionArn */ readonly attrTypeVersionArn: string; /** * The Amazon Resource Number (ARN) of the extension. */ arn?: string; /** * The S3 bucket to which CloudFormation delivers the contract test execution logs. */ logDeliveryBucket?: string; /** * The version number to assign to this version of the extension. */ publicVersionNumber?: string; /** * The type of the extension to test. */ type?: string; /** * The name of the extension to test. */ typeName?: string; /** * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props?: CfnPublicTypeVersionProps); protected get cfnProperties(): Record<string, any>; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record<string, any>): Record<string, any>; } /** * Properties for defining a `CfnPublicTypeVersion` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publictypeversion.html */ export interface CfnPublicTypeVersionProps { /** * The Amazon Resource Number (ARN) of the extension. * * Conditional: You must specify `Arn` , or `TypeName` and `Type` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publictypeversion.html#cfn-cloudformation-publictypeversion-arn */ readonly arn?: 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: * * - s3:GetObject * - s3:PutObject * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publictypeversion.html#cfn-cloudformation-publictypeversion-logdeliverybucket */ readonly logDeliveryBucket?: 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. CloudFormation automatically sets the first version number to be `1.0.0` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publictypeversion.html#cfn-cloudformation-publictypeversion-publicversionnumber */ readonly publicVersionNumber?: string; /** * The type of the extension to test. * * Conditional: You must specify `Arn` , or `TypeName` and `Type` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publictypeversion.html#cfn-cloudformation-publictypeversion-type */ readonly type?: string; /** * The name of the extension to test. * * Conditional: You must specify `Arn` , or `TypeName` and `Type` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publictypeversion.html#cfn-cloudformation-publictypeversion-typename */ readonly typeName?: string; } /** * The `AWS::CloudFormation::Publisher` resource 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 [Publishing extensions to make them available for public use](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.htm) in the *AWS CloudFormation Command Line Interface (CLI) User Guide* . * * @cloudformationResource AWS::CloudFormation::Publisher * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publisher.html */ export declare class CfnPublisher extends cdk.CfnResource implements cdk.IInspectable { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnPublisher from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnPublisher; /** * The type of account used as the identity provider when registering this publisher with CloudFormation. * * @cloudformationAttribute IdentityProvider */ readonly attrIdentityProvider: string; /** * The ID of the extension publisher. * * @cloudformationAttribute PublisherId */ readonly attrPublisherId: string; /** * The URL to the publisher's profile with the identity provider. * * @cloudformationAttribute PublisherProfile */ readonly attrPublisherProfile: string; /** * Whether the publisher is verified. Currently, all registered publishers are verified. * * @cloudformationAttribute PublisherStatus */ readonly attrPublisherStatus: string; /** * 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. */ acceptTermsAndConditions: boolean | cdk.IResolvable; /** * If you are using a Bitbucket or GitHub account for identity verification, the Amazon Resource Name (ARN) for your connection to that account. */ connectionArn?: string; /** * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnPublisherProps); protected get cfnProperties(): Record<string, any>; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record<string, any>): Record<string, any>; } /** * Properties for defining a `CfnPublisher` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publisher.html */ export interface CfnPublisherProps { /** * 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` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publisher.html#cfn-cloudformation-publisher-accepttermsandconditions */ readonly acceptTermsAndConditions: boolean | cdk.IResolvable; /** * 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 [Prerequisite: Registering your account to publish CloudFormation extensions](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html#publish-extension-prereqs) in the *AWS CloudFormation Command Line Interface (CLI) User Guide* . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publisher.html#cfn-cloudformation-publisher-connectionarn */ readonly connectionArn?: string; } /** * The `AWS::CloudFormation::ResourceDefaultVersion` resource specifies the default version of a resource. * * The default version of a resource will be used in CloudFormation operations. * * For information about the CloudFormation registry, see [Managing extensions with the CloudFormation registry](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html) in the *AWS CloudFormation User Guide* . * * @cloudformationResource AWS::CloudFormation::ResourceDefaultVersion * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourcedefaultversion.html */ export declare class CfnResourceDefaultVersion extends cdk.CfnResource implements cdk.IInspectable { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnResourceDefaultVersion from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnResourceDefaultVersion; /** * The Amazon Resource Name (ARN) of the resource. * * @cloudformationAttribute Arn */ readonly attrArn: string; /** * The name of the resource. */ typeName?: string; /** * The Amazon Resource Name (ARN) of the resource version. */ typeVersionArn?: string; /** * The ID of a specific version of the resource. */ versionId?: string; /** * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props?: CfnResourceDefaultVersionProps); protected get cfnProperties(): Record<string, any>; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record<string, any>): Record<string, any>; } /** * Properties for defining a `CfnResourceDefaultVersion` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourcedefaultversion.html */ export interface CfnResourceDefaultVersionProps { /** * The name of the resource. * * Conditional: You must specify either `TypeVersionArn` , or `TypeName` and `VersionId` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourcedefaultversion.html#cfn-cloudformation-resourcedefaultversion-typename */ readonly typeName?: string; /** * The Amazon Resource Name (ARN) of the resource version. * * Conditional: You must specify either `TypeVersionArn` , or `TypeName` and `VersionId` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourcedefaultversion.html#cfn-cloudformation-resourcedefaultversion-typeversionarn */ readonly typeVersionArn?: 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