{ "author": { "name": "Amazon Web Services", "organization": true, "roles": [ "author" ], "url": "https://aws.amazon.com" }, "dependencies": { "@aws-cdk/aws-iam": "1.204.0", "@aws-cdk/aws-lambda": "1.204.0", "@aws-cdk/aws-s3": "1.204.0", "@aws-cdk/aws-sns": "1.204.0", "@aws-cdk/core": "1.204.0", "@aws-cdk/cx-api": "1.204.0", "constructs": "^3.3.69" }, "dependencyClosure": { "@aws-cdk/assets": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.Assets", "packageId": "Amazon.CDK.Assets" }, "java": { "maven": { "artifactId": "cdk-assets", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.assets" }, "js": { "npm": "@aws-cdk/assets" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.assets", "module": "aws_cdk.assets" } } }, "@aws-cdk/aws-applicationautoscaling": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.ApplicationAutoScaling", "packageId": "Amazon.CDK.AWS.ApplicationAutoScaling" }, "java": { "maven": { "artifactId": "applicationautoscaling", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.applicationautoscaling" }, "js": { "npm": "@aws-cdk/aws-applicationautoscaling" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-applicationautoscaling", "module": "aws_cdk.aws_applicationautoscaling" } } }, "@aws-cdk/aws-autoscaling-common": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.AutoScaling.Common", "packageId": "Amazon.CDK.AWS.AutoScaling.Common" }, "java": { "maven": { "artifactId": "autoscaling-common", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.autoscaling.common" }, "js": { "npm": "@aws-cdk/aws-autoscaling-common" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-autoscaling-common", "module": "aws_cdk.aws_autoscaling_common" } } }, "@aws-cdk/aws-cloudwatch": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.CloudWatch", "packageId": "Amazon.CDK.AWS.CloudWatch" }, "java": { "maven": { "artifactId": "cloudwatch", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.cloudwatch" }, "js": { "npm": "@aws-cdk/aws-cloudwatch" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-cloudwatch", "module": "aws_cdk.aws_cloudwatch" } } }, "@aws-cdk/aws-codeguruprofiler": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.CodeGuruProfiler", "packageId": "Amazon.CDK.AWS.CodeGuruProfiler" }, "java": { "maven": { "artifactId": "codeguruprofiler", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.codeguruprofiler" }, "js": { "npm": "@aws-cdk/aws-codeguruprofiler" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-codeguruprofiler", "module": "aws_cdk.aws_codeguruprofiler" } } }, "@aws-cdk/aws-codestarnotifications": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.CodeStarNotifications", "packageId": "Amazon.CDK.AWS.CodeStarNotifications" }, "java": { "maven": { "artifactId": "codestarnotifications", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.codestarnotifications" }, "js": { "npm": "@aws-cdk/aws-codestarnotifications" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-codestarnotifications", "module": "aws_cdk.aws_codestarnotifications" } } }, "@aws-cdk/aws-ec2": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.EC2", "packageId": "Amazon.CDK.AWS.EC2" }, "java": { "maven": { "artifactId": "ec2", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.ec2" }, "js": { "npm": "@aws-cdk/aws-ec2" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-ec2", "module": "aws_cdk.aws_ec2" } } }, "@aws-cdk/aws-ecr": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.ECR", "packageId": "Amazon.CDK.AWS.ECR" }, "java": { "maven": { "artifactId": "ecr", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.ecr" }, "js": { "npm": "@aws-cdk/aws-ecr" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-ecr", "module": "aws_cdk.aws_ecr" } } }, "@aws-cdk/aws-ecr-assets": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.Ecr.Assets", "packageId": "Amazon.CDK.ECR.Assets" }, "java": { "maven": { "artifactId": "ecr-assets", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.ecr.assets" }, "js": { "npm": "@aws-cdk/aws-ecr-assets" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-ecr-assets", "module": "aws_cdk.aws_ecr_assets" } } }, "@aws-cdk/aws-efs": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.EFS", "packageId": "Amazon.CDK.AWS.EFS" }, "java": { "maven": { "artifactId": "efs", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.efs" }, "js": { "npm": "@aws-cdk/aws-efs" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-efs", "module": "aws_cdk.aws_efs" } } }, "@aws-cdk/aws-events": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.Events", "packageId": "Amazon.CDK.AWS.Events" }, "java": { "maven": { "artifactId": "events", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.events" }, "js": { "npm": "@aws-cdk/aws-events" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-events", "module": "aws_cdk.aws_events" } } }, "@aws-cdk/aws-iam": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.IAM", "packageId": "Amazon.CDK.AWS.IAM" }, "java": { "maven": { "artifactId": "iam", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.iam" }, "js": { "npm": "@aws-cdk/aws-iam" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-iam", "module": "aws_cdk.aws_iam" } } }, "@aws-cdk/aws-kms": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.KMS", "packageId": "Amazon.CDK.AWS.KMS" }, "java": { "maven": { "artifactId": "kms", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.kms" }, "js": { "npm": "@aws-cdk/aws-kms" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-kms", "module": "aws_cdk.aws_kms" } } }, "@aws-cdk/aws-lambda": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.Lambda", "packageId": "Amazon.CDK.AWS.Lambda" }, "java": { "maven": { "artifactId": "lambda", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.lambda" }, "js": { "npm": "@aws-cdk/aws-lambda" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-lambda", "module": "aws_cdk.aws_lambda" } } }, "@aws-cdk/aws-logs": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.Logs", "packageId": "Amazon.CDK.AWS.Logs" }, "java": { "maven": { "artifactId": "logs", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.logs" }, "js": { "npm": "@aws-cdk/aws-logs" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-logs", "module": "aws_cdk.aws_logs" } } }, "@aws-cdk/aws-s3": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.S3", "packageId": "Amazon.CDK.AWS.S3" }, "java": { "maven": { "artifactId": "s3", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.s3" }, "js": { "npm": "@aws-cdk/aws-s3" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-s3", "module": "aws_cdk.aws_s3" } } }, "@aws-cdk/aws-s3-assets": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.S3.Assets", "packageId": "Amazon.CDK.AWS.S3.Assets" }, "java": { "maven": { "artifactId": "s3-assets", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.s3.assets" }, "js": { "npm": "@aws-cdk/aws-s3-assets" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-s3-assets", "module": "aws_cdk.aws_s3_assets" } } }, "@aws-cdk/aws-signer": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.Signer", "packageId": "Amazon.CDK.AWS.Signer" }, "java": { "maven": { "artifactId": "signer", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.signer" }, "js": { "npm": "@aws-cdk/aws-signer" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-signer", "module": "aws_cdk.aws_signer" } } }, "@aws-cdk/aws-sns": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.SNS", "packageId": "Amazon.CDK.AWS.SNS" }, "java": { "maven": { "artifactId": "sns", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.sns" }, "js": { "npm": "@aws-cdk/aws-sns" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-sns", "module": "aws_cdk.aws_sns" } } }, "@aws-cdk/aws-sqs": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.SQS", "packageId": "Amazon.CDK.AWS.SQS" }, "java": { "maven": { "artifactId": "sqs", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.sqs" }, "js": { "npm": "@aws-cdk/aws-sqs" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-sqs", "module": "aws_cdk.aws_sqs" } } }, "@aws-cdk/aws-ssm": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.SSM", "packageId": "Amazon.CDK.AWS.SSM" }, "java": { "maven": { "artifactId": "ssm", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.ssm" }, "js": { "npm": "@aws-cdk/aws-ssm" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-ssm", "module": "aws_cdk.aws_ssm" } } }, "@aws-cdk/cloud-assembly-schema": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.CloudAssembly.Schema", "packageId": "Amazon.CDK.CloudAssembly.Schema" }, "java": { "maven": { "artifactId": "cdk-cloud-assembly-schema", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.cloudassembly.schema" }, "js": { "npm": "@aws-cdk/cloud-assembly-schema" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.cloud-assembly-schema", "module": "aws_cdk.cloud_assembly_schema" } } }, "@aws-cdk/core": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK", "packageId": "Amazon.CDK" }, "java": { "maven": { "artifactId": "core", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.core" }, "js": { "npm": "@aws-cdk/core" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.core", "module": "aws_cdk.core" } } }, "@aws-cdk/cx-api": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.CXAPI", "packageId": "Amazon.CDK.CXAPI" }, "java": { "maven": { "artifactId": "cdk-cx-api", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.cxapi" }, "js": { "npm": "@aws-cdk/cx-api" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.cx-api", "module": "aws_cdk.cx_api" } } }, "@aws-cdk/region-info": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.RegionInfo", "packageId": "Amazon.CDK.RegionInfo" }, "java": { "maven": { "artifactId": "cdk-region-info", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.regioninfo" }, "js": { "npm": "@aws-cdk/region-info" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.region-info", "module": "aws_cdk.region_info" } } }, "constructs": { "targets": { "dotnet": { "namespace": "Constructs", "packageId": "Constructs" }, "go": { "moduleName": "github.com/aws/constructs-go" }, "java": { "maven": { "artifactId": "constructs", "groupId": "software.constructs" }, "package": "software.constructs" }, "js": { "npm": "constructs" }, "python": { "distName": "constructs", "module": "constructs" } } } }, "description": "The CDK Construct Library for AWS::CloudFormation", "docs": { "deprecated": "AWS CDK v1 has reached End-of-Support on 2023-06-01.\nThis package is no longer being updated, and users should migrate to AWS CDK v2.\n\nFor more information on how to migrate, see https://docs.aws.amazon.com/cdk/v2/guide/migrating-v2.html", "stability": "deprecated" }, "homepage": "https://github.com/aws/aws-cdk", "jsiiVersion": "1.84.0 (build 5404dcf)", "keywords": [ "aws", "cdk", "constructs", "cloudformation" ], "license": "Apache-2.0", "metadata": { "jsii": { "compiledWithDeprecationWarnings": true, "pacmak": { "hasDefaultInterfaces": true }, "rosetta": { "strict": true } } }, "name": "@aws-cdk/aws-cloudformation", "readme": { "markdown": "# AWS CloudFormation Construct Library\n\n\n---\n\n![Deprecated](https://img.shields.io/badge/deprecated-critical.svg?style=for-the-badge)\n\n> This API may emit warnings. Backward compatibility is not guaranteed.\n\n---\n\n\n\nThis module is part of the [AWS Cloud Development Kit](https://github.com/aws/aws-cdk) project.\n" }, "repository": { "directory": "packages/@aws-cdk/aws-cloudformation", "type": "git", "url": "https://github.com/aws/aws-cdk.git" }, "schema": "jsii/0.10.0", "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.CloudFormation", "packageId": "Amazon.CDK.AWS.CloudFormation" }, "java": { "maven": { "artifactId": "cloudformation", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.cloudformation" }, "js": { "npm": "@aws-cdk/aws-cloudformation" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-cloudformation", "module": "aws_cdk.aws_cloudformation" } }, "types": { "@aws-cdk/aws-cloudformation.CfnCustomResource": { "assembly": "@aws-cdk/aws-cloudformation", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::CloudFormation::CustomResource", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cfn-customresource.html", "exampleMetadata": "fixture=_generated" }, "remarks": "In a CloudFormation template, you use the `AWS::CloudFormation::CustomResource` or `Custom:: *String*` resource type to specify custom resources.\n\nCustom resources provide a way for you to write custom provisioning logic in CloudFormation template and have CloudFormation run it during a stack operation, such as when you create, update or delete a stack. For more information, see [Custom resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-custom-resources.html) .\n\n> If you use the [VPC endpoints](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-endpoints.html) feature, custom resources in the VPC must have access to CloudFormation -specific Amazon Simple Storage Service ( Amazon S3 ) buckets. Custom resources must send responses to a presigned Amazon S3 URL. If they can't send responses to Amazon S3 , CloudFormation won't receive a response and the stack operation fails. For more information, see [Setting up VPC endpoints for AWS CloudFormation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-vpce-bucketnames.html) .", "stability": "external", "summary": "A CloudFormation `AWS::CloudFormation::CustomResource`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst cfnCustomResource = new cloudformation.CfnCustomResource(this, 'MyCfnCustomResource', {\n serviceToken: 'serviceToken',\n});" }, "fqn": "@aws-cdk/aws-cloudformation.CfnCustomResource", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::CloudFormation::CustomResource`." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 136 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-cloudformation.CfnCustomResourceProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 93 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 149 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 160 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnCustomResource", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 97 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 154 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cfn-customresource.html#cfn-customresource-servicetoken" }, "remarks": "All other properties are defined by the service provider.\n\nThe 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.\n\nUpdates aren't supported.", "stability": "external", "summary": "> Only one property is defined by AWS for a custom resource: `ServiceToken` ." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 127 }, "name": "serviceToken", "type": { "primitive": "string" } } ], "symbolId": "lib/cloudformation.generated:CfnCustomResource" }, "@aws-cdk/aws-cloudformation.CfnCustomResourceProps": { "assembly": "@aws-cdk/aws-cloudformation", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cfn-customresource.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnCustomResource`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst cfnCustomResourceProps: cloudformation.CfnCustomResourceProps = {\n serviceToken: 'serviceToken',\n};" }, "fqn": "@aws-cdk/aws-cloudformation.CfnCustomResourceProps", "kind": "interface", "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 19 }, "name": "CfnCustomResourceProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cfn-customresource.html#cfn-customresource-servicetoken" }, "remarks": "All other properties are defined by the service provider.\n\nThe 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.\n\nUpdates aren't supported.", "stability": "external", "summary": "> Only one property is defined by AWS for a custom resource: `ServiceToken` ." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 30 }, "name": "serviceToken", "type": { "primitive": "string" } } ], "symbolId": "lib/cloudformation.generated:CfnCustomResourceProps" }, "@aws-cdk/aws-cloudformation.CfnHookDefaultVersion": { "assembly": "@aws-cdk/aws-cloudformation", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::CloudFormation::HookDefaultVersion", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookdefaultversion.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The `HookDefaultVersion` resource specifies the default version of the hook. The default version of the hook is used in CloudFormation operations for this AWS account and AWS Region .", "stability": "external", "summary": "A CloudFormation `AWS::CloudFormation::HookDefaultVersion`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst cfnHookDefaultVersion = new cloudformation.CfnHookDefaultVersion(this, 'MyCfnHookDefaultVersion', /* all optional props */ {\n typeName: 'typeName',\n typeVersionArn: 'typeVersionArn',\n versionId: 'versionId',\n});" }, "fqn": "@aws-cdk/aws-cloudformation.CfnHookDefaultVersion", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::CloudFormation::HookDefaultVersion`." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 329 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudformation.CfnHookDefaultVersionProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 264 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 344 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 357 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnHookDefaultVersion", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 268 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Arn" }, "stability": "external", "summary": "The Amazon Resource Number (ARN) of the activated extension, in this account and Region." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 293 }, "name": "attrArn", "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 349 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookdefaultversion.html#cfn-cloudformation-hookdefaultversion-typename" }, "remarks": "You must specify either `TypeVersionArn` , or `TypeName` and `VersionId` .", "stability": "external", "summary": "The name of the hook." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 302 }, "name": "typeName", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookdefaultversion.html#cfn-cloudformation-hookdefaultversion-typeversionarn" }, "remarks": "You must specify either `TypeVersionArn` , or `TypeName` and `VersionId` .", "stability": "external", "summary": "The version ID of the type configuration." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 311 }, "name": "typeVersionArn", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookdefaultversion.html#cfn-cloudformation-hookdefaultversion-versionid" }, "remarks": "You must specify either `TypeVersionArn` , or `TypeName` and `VersionId` .", "stability": "external", "summary": "The version ID of the type specified." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 320 }, "name": "versionId", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/cloudformation.generated:CfnHookDefaultVersion" }, "@aws-cdk/aws-cloudformation.CfnHookDefaultVersionProps": { "assembly": "@aws-cdk/aws-cloudformation", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookdefaultversion.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnHookDefaultVersion`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst cfnHookDefaultVersionProps: cloudformation.CfnHookDefaultVersionProps = {\n typeName: 'typeName',\n typeVersionArn: 'typeVersionArn',\n versionId: 'versionId',\n};" }, "fqn": "@aws-cdk/aws-cloudformation.CfnHookDefaultVersionProps", "kind": "interface", "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 173 }, "name": "CfnHookDefaultVersionProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookdefaultversion.html#cfn-cloudformation-hookdefaultversion-typename" }, "remarks": "You must specify either `TypeVersionArn` , or `TypeName` and `VersionId` .", "stability": "external", "summary": "The name of the hook." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 182 }, "name": "typeName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookdefaultversion.html#cfn-cloudformation-hookdefaultversion-typeversionarn" }, "remarks": "You must specify either `TypeVersionArn` , or `TypeName` and `VersionId` .", "stability": "external", "summary": "The version ID of the type configuration." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 191 }, "name": "typeVersionArn", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookdefaultversion.html#cfn-cloudformation-hookdefaultversion-versionid" }, "remarks": "You must specify either `TypeVersionArn` , or `TypeName` and `VersionId` .", "stability": "external", "summary": "The version ID of the type specified." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 200 }, "name": "versionId", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/cloudformation.generated:CfnHookDefaultVersionProps" }, "@aws-cdk/aws-cloudformation.CfnHookTypeConfig": { "assembly": "@aws-cdk/aws-cloudformation", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::CloudFormation::HookTypeConfig", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hooktypeconfig.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The `HookTypeConfig` resource specifies the configuration of a hook.", "stability": "external", "summary": "A CloudFormation `AWS::CloudFormation::HookTypeConfig`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst cfnHookTypeConfig = new cloudformation.CfnHookTypeConfig(this, 'MyCfnHookTypeConfig', {\n configuration: 'configuration',\n\n // the properties below are optional\n configurationAlias: 'configurationAlias',\n typeArn: 'typeArn',\n typeName: 'typeName',\n});" }, "fqn": "@aws-cdk/aws-cloudformation.CfnHookTypeConfig", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::CloudFormation::HookTypeConfig`." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 548 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-cloudformation.CfnHookTypeConfigProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 474 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 565 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 579 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnHookTypeConfig", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 478 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "ConfigurationArn" }, "stability": "external", "summary": "The Amazon Resource Number (ARN) of the activated hook type configuration, in this account and Region." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 503 }, "name": "attrConfigurationArn", "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 570 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hooktypeconfig.html#cfn-cloudformation-hooktypeconfig-configuration" }, "remarks": "You must specify either `TypeName` and `Configuration` or `TypeARN` and `Configuration` .", "stability": "external", "summary": "Specifies the activated hook type configuration, in this AWS account and AWS Region ." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 512 }, "name": "configuration", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hooktypeconfig.html#cfn-cloudformation-hooktypeconfig-configurationalias" }, "remarks": "Defaults to `default` alias. Hook types currently support default configuration alias.", "stability": "external", "summary": "Specifies the activated hook type configuration, in this AWS account and AWS Region ." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 521 }, "name": "configurationAlias", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hooktypeconfig.html#cfn-cloudformation-hooktypeconfig-typearn" }, "remarks": "You must specify either `TypeName` and `Configuration` or `TypeARN` and `Configuration` .", "stability": "external", "summary": "The Amazon Resource Number (ARN) for the hook to set `Configuration` for." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 530 }, "name": "typeArn", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hooktypeconfig.html#cfn-cloudformation-hooktypeconfig-typename" }, "remarks": "Specifies a three-part namespace for your hook, with a recommended pattern of `Organization::Service::Hook` .\n\nYou must specify either `TypeName` and `Configuration` or `TypeARN` and `Configuration` .", "stability": "external", "summary": "The unique name for your hook." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 539 }, "name": "typeName", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/cloudformation.generated:CfnHookTypeConfig" }, "@aws-cdk/aws-cloudformation.CfnHookTypeConfigProps": { "assembly": "@aws-cdk/aws-cloudformation", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hooktypeconfig.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnHookTypeConfig`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst cfnHookTypeConfigProps: cloudformation.CfnHookTypeConfigProps = {\n configuration: 'configuration',\n\n // the properties below are optional\n configurationAlias: 'configurationAlias',\n typeArn: 'typeArn',\n typeName: 'typeName',\n};" }, "fqn": "@aws-cdk/aws-cloudformation.CfnHookTypeConfigProps", "kind": "interface", "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 370 }, "name": "CfnHookTypeConfigProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hooktypeconfig.html#cfn-cloudformation-hooktypeconfig-configuration" }, "remarks": "You must specify either `TypeName` and `Configuration` or `TypeARN` and `Configuration` .", "stability": "external", "summary": "Specifies the activated hook type configuration, in this AWS account and AWS Region ." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 379 }, "name": "configuration", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hooktypeconfig.html#cfn-cloudformation-hooktypeconfig-configurationalias" }, "remarks": "Defaults to `default` alias. Hook types currently support default configuration alias.", "stability": "external", "summary": "Specifies the activated hook type configuration, in this AWS account and AWS Region ." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 388 }, "name": "configurationAlias", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hooktypeconfig.html#cfn-cloudformation-hooktypeconfig-typearn" }, "remarks": "You must specify either `TypeName` and `Configuration` or `TypeARN` and `Configuration` .", "stability": "external", "summary": "The Amazon Resource Number (ARN) for the hook to set `Configuration` for." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 397 }, "name": "typeArn", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hooktypeconfig.html#cfn-cloudformation-hooktypeconfig-typename" }, "remarks": "Specifies a three-part namespace for your hook, with a recommended pattern of `Organization::Service::Hook` .\n\nYou must specify either `TypeName` and `Configuration` or `TypeARN` and `Configuration` .", "stability": "external", "summary": "The unique name for your hook." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 406 }, "name": "typeName", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/cloudformation.generated:CfnHookTypeConfigProps" }, "@aws-cdk/aws-cloudformation.CfnHookVersion": { "assembly": "@aws-cdk/aws-cloudformation", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::CloudFormation::HookVersion", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookversion.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The `HookVersion` resource publishes new or first hook version to the AWS CloudFormation registry.", "stability": "external", "summary": "A CloudFormation `AWS::CloudFormation::HookVersion`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst cfnHookVersion = new cloudformation.CfnHookVersion(this, 'MyCfnHookVersion', {\n schemaHandlerPackage: 'schemaHandlerPackage',\n typeName: 'typeName',\n\n // the properties below are optional\n executionRoleArn: 'executionRoleArn',\n loggingConfig: {\n logGroupName: 'logGroupName',\n logRoleArn: 'logRoleArn',\n },\n});" }, "fqn": "@aws-cdk/aws-cloudformation.CfnHookVersion", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::CloudFormation::HookVersion`." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 812 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-cloudformation.CfnHookVersionProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 703 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 834 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 848 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnHookVersion", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 707 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Arn" }, "stability": "external", "summary": "The Amazon Resource Name (ARN) of the hook." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 732 }, "name": "attrArn", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "IsDefaultVersion" }, "stability": "external", "summary": "Whether the specified hook version is set as the default version." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 738 }, "name": "attrIsDefaultVersion", "type": { "fqn": "@aws-cdk/core.IResolvable" } }, { "docs": { "custom": { "cloudformationAttribute": "TypeArn" }, "stability": "external", "summary": "The Amazon Resource Number (ARN) assigned to this version of the hook." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 744 }, "name": "attrTypeArn", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "VersionId" }, "stability": "external", "summary": "The ID of this version of the hook." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 750 }, "name": "attrVersionId", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Visibility" }, "remarks": "Valid values include:\n\n- `PRIVATE` : The resource is only visible and usable within the account in which it's registered. CloudFormation marks any resources you register as `PRIVATE` .\n- `PUBLIC` : The resource is publicly visible and usable within any Amazon account.", "stability": "external", "summary": "The scope at which the resource is visible and usable in CloudFormation operations." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 761 }, "name": "attrVisibility", "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 839 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookversion.html#cfn-cloudformation-hookversion-schemahandlerpackage" }, "remarks": "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* .\n\n> 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* .", "stability": "external", "summary": "A URL to the Amazon S3 bucket containing the hook project package that contains the necessary files for the hook you want to register." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 772 }, "name": "schemaHandlerPackage", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookversion.html#cfn-cloudformation-hookversion-typename" }, "remarks": "Specifies a three-part namespace for your hook, with a recommended pattern of `Organization::Service::Hook` .\n\n> The following organization namespaces are reserved and can't be used in your hook type names:\n>\n> - `Alexa`\n> - `AMZN`\n> - `Amazon`\n> - `ASK`\n> - `AWS`\n> - `Custom`\n> - `Dev`", "stability": "external", "summary": "The unique name for your hook." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 789 }, "name": "typeName", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookversion.html#cfn-cloudformation-hookversion-executionrolearn" }, "stability": "external", "summary": "The Amazon Resource Name (ARN) of the task execution role that grants the hook permission." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 796 }, "name": "executionRoleArn", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookversion.html#cfn-cloudformation-hookversion-loggingconfig" }, "stability": "external", "summary": "Contains logging configuration information for an extension." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 803 }, "name": "loggingConfig", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/aws-cloudformation.CfnHookVersion.LoggingConfigProperty" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } } ], "symbolId": "lib/cloudformation.generated:CfnHookVersion" }, "@aws-cdk/aws-cloudformation.CfnHookVersion.LoggingConfigProperty": { "assembly": "@aws-cdk/aws-cloudformation", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-hookversion-loggingconfig.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "The `LoggingConfig` property type specifies logging configuration information for an extension.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst loggingConfigProperty: cloudformation.CfnHookVersion.LoggingConfigProperty = {\n logGroupName: 'logGroupName',\n logRoleArn: 'logRoleArn',\n};" }, "fqn": "@aws-cdk/aws-cloudformation.CfnHookVersion.LoggingConfigProperty", "kind": "interface", "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 862 }, "name": "LoggingConfigProperty", "namespace": "CfnHookVersion", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-hookversion-loggingconfig.html#cfn-cloudformation-hookversion-loggingconfig-loggroupname" }, "stability": "external", "summary": "The Amazon CloudWatch Logs group to which CloudFormation sends error logging information when invoking the extension's handlers." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 868 }, "name": "logGroupName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-hookversion-loggingconfig.html#cfn-cloudformation-hookversion-loggingconfig-logrolearn" }, "stability": "external", "summary": "The Amazon Resource Name (ARN) of the role that CloudFormation should assume when sending log entries to CloudWatch Logs." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 874 }, "name": "logRoleArn", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/cloudformation.generated:CfnHookVersion.LoggingConfigProperty" }, "@aws-cdk/aws-cloudformation.CfnHookVersionProps": { "assembly": "@aws-cdk/aws-cloudformation", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookversion.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnHookVersion`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst cfnHookVersionProps: cloudformation.CfnHookVersionProps = {\n schemaHandlerPackage: 'schemaHandlerPackage',\n typeName: 'typeName',\n\n // the properties below are optional\n executionRoleArn: 'executionRoleArn',\n loggingConfig: {\n logGroupName: 'logGroupName',\n logRoleArn: 'logRoleArn',\n },\n};" }, "fqn": "@aws-cdk/aws-cloudformation.CfnHookVersionProps", "kind": "interface", "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 592 }, "name": "CfnHookVersionProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookversion.html#cfn-cloudformation-hookversion-schemahandlerpackage" }, "remarks": "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* .\n\n> 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* .", "stability": "external", "summary": "A URL to the Amazon S3 bucket containing the hook project package that contains the necessary files for the hook you want to register." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 603 }, "name": "schemaHandlerPackage", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookversion.html#cfn-cloudformation-hookversion-typename" }, "remarks": "Specifies a three-part namespace for your hook, with a recommended pattern of `Organization::Service::Hook` .\n\n> The following organization namespaces are reserved and can't be used in your hook type names:\n>\n> - `Alexa`\n> - `AMZN`\n> - `Amazon`\n> - `ASK`\n> - `AWS`\n> - `Custom`\n> - `Dev`", "stability": "external", "summary": "The unique name for your hook." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 620 }, "name": "typeName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookversion.html#cfn-cloudformation-hookversion-executionrolearn" }, "stability": "external", "summary": "The Amazon Resource Name (ARN) of the task execution role that grants the hook permission." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 627 }, "name": "executionRoleArn", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookversion.html#cfn-cloudformation-hookversion-loggingconfig" }, "stability": "external", "summary": "Contains logging configuration information for an extension." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 634 }, "name": "loggingConfig", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/aws-cloudformation.CfnHookVersion.LoggingConfigProperty" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } } ], "symbolId": "lib/cloudformation.generated:CfnHookVersionProps" }, "@aws-cdk/aws-cloudformation.CfnMacro": { "assembly": "@aws-cdk/aws-cloudformation", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::CloudFormation::Macro", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The `AWS::CloudFormation::Macro` resource is a CloudFormation resource type that creates a CloudFormation macro to perform custom processing on CloudFormation templates. For more information, see [Using AWS CloudFormation macros to perform custom processing on templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html) .", "stability": "external", "summary": "A CloudFormation `AWS::CloudFormation::Macro`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst cfnMacro = new cloudformation.CfnMacro(this, 'MyCfnMacro', {\n functionName: 'functionName',\n name: 'name',\n\n // the properties below are optional\n description: 'description',\n logGroupName: 'logGroupName',\n logRoleArn: 'logRoleArn',\n});" }, "fqn": "@aws-cdk/aws-cloudformation.CfnMacro", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::CloudFormation::Macro`." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 1111 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-cloudformation.CfnMacroProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 1044 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 1129 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 1144 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnMacro", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 1048 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 1134 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html#cfn-cloudformation-macro-functionname" }, "stability": "external", "summary": "The Amazon Resource Name (ARN) of the underlying AWS Lambda function that you want AWS CloudFormation to invoke when the macro is run." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 1074 }, "name": "functionName", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html#cfn-cloudformation-macro-name" }, "remarks": "The name of the macro must be unique across all macros in the account.", "stability": "external", "summary": "The name of the macro." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 1081 }, "name": "name", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html#cfn-cloudformation-macro-description" }, "stability": "external", "summary": "A description of the macro." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 1088 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html#cfn-cloudformation-macro-loggroupname" }, "stability": "external", "summary": "The CloudWatch Logs group to which AWS CloudFormation sends error logging information when invoking the macro's underlying AWS Lambda function." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 1095 }, "name": "logGroupName", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html#cfn-cloudformation-macro-logrolearn" }, "stability": "external", "summary": "The ARN of the role AWS CloudFormation should assume when sending log entries to CloudWatch Logs ." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 1102 }, "name": "logRoleArn", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/cloudformation.generated:CfnMacro" }, "@aws-cdk/aws-cloudformation.CfnMacroProps": { "assembly": "@aws-cdk/aws-cloudformation", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnMacro`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst cfnMacroProps: cloudformation.CfnMacroProps = {\n functionName: 'functionName',\n name: 'name',\n\n // the properties below are optional\n description: 'description',\n logGroupName: 'logGroupName',\n logRoleArn: 'logRoleArn',\n};" }, "fqn": "@aws-cdk/aws-cloudformation.CfnMacroProps", "kind": "interface", "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 937 }, "name": "CfnMacroProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html#cfn-cloudformation-macro-functionname" }, "stability": "external", "summary": "The Amazon Resource Name (ARN) of the underlying AWS Lambda function that you want AWS CloudFormation to invoke when the macro is run." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 944 }, "name": "functionName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html#cfn-cloudformation-macro-name" }, "remarks": "The name of the macro must be unique across all macros in the account.", "stability": "external", "summary": "The name of the macro." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 951 }, "name": "name", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html#cfn-cloudformation-macro-description" }, "stability": "external", "summary": "A description of the macro." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 958 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html#cfn-cloudformation-macro-loggroupname" }, "stability": "external", "summary": "The CloudWatch Logs group to which AWS CloudFormation sends error logging information when invoking the macro's underlying AWS Lambda function." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 965 }, "name": "logGroupName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html#cfn-cloudformation-macro-logrolearn" }, "stability": "external", "summary": "The ARN of the role AWS CloudFormation should assume when sending log entries to CloudWatch Logs ." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 972 }, "name": "logRoleArn", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/cloudformation.generated:CfnMacroProps" }, "@aws-cdk/aws-cloudformation.CfnModuleDefaultVersion": { "assembly": "@aws-cdk/aws-cloudformation", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::CloudFormation::ModuleDefaultVersion", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduledefaultversion.html", "exampleMetadata": "fixture=_generated" }, "remarks": "Specifies the default version of a module. The default version of the module will be used in CloudFormation operations for this account and Region.\n\nTo register a module version, use the `[AWS::CloudFormation::ModuleVersion](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduleversion.html)` resource.\n\nFor more information using modules, see [Using modules to encapsulate and reuse resource configurations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/modules.html) and [Registering extensions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html#registry-register) in the *AWS CloudFormation User Guide* . For information on developing modules, see [Developing modules](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/modules.html) in the *AWS CloudFormation CLI User Guide* .", "stability": "external", "summary": "A CloudFormation `AWS::CloudFormation::ModuleDefaultVersion`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst cfnModuleDefaultVersion = new cloudformation.CfnModuleDefaultVersion(this, 'MyCfnModuleDefaultVersion', /* all optional props */ {\n arn: 'arn',\n moduleName: 'moduleName',\n versionId: 'versionId',\n});" }, "fqn": "@aws-cdk/aws-cloudformation.CfnModuleDefaultVersion", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::CloudFormation::ModuleDefaultVersion`." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 1311 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudformation.CfnModuleDefaultVersionProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 1252 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 1325 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 1338 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnModuleDefaultVersion", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 1256 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 1330 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduledefaultversion.html#cfn-cloudformation-moduledefaultversion-arn" }, "remarks": "Conditional: You must specify either `Arn` , or `ModuleName` and `VersionId` .", "stability": "external", "summary": "The Amazon Resource Name (ARN) of the module version to set as the default version." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 1284 }, "name": "arn", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduledefaultversion.html#cfn-cloudformation-moduledefaultversion-modulename" }, "remarks": "Conditional: You must specify either `Arn` , or `ModuleName` and `VersionId` .", "stability": "external", "summary": "The name of the module." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 1293 }, "name": "moduleName", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduledefaultversion.html#cfn-cloudformation-moduledefaultversion-versionid" }, "remarks": "Conditional: You must specify either `Arn` , or `ModuleName` and `VersionId` .", "stability": "external", "summary": "The ID for the specific version of the module." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 1302 }, "name": "versionId", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/cloudformation.generated:CfnModuleDefaultVersion" }, "@aws-cdk/aws-cloudformation.CfnModuleDefaultVersionProps": { "assembly": "@aws-cdk/aws-cloudformation", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduledefaultversion.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnModuleDefaultVersion`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst cfnModuleDefaultVersionProps: cloudformation.CfnModuleDefaultVersionProps = {\n arn: 'arn',\n moduleName: 'moduleName',\n versionId: 'versionId',\n};" }, "fqn": "@aws-cdk/aws-cloudformation.CfnModuleDefaultVersionProps", "kind": "interface", "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 1157 }, "name": "CfnModuleDefaultVersionProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduledefaultversion.html#cfn-cloudformation-moduledefaultversion-arn" }, "remarks": "Conditional: You must specify either `Arn` , or `ModuleName` and `VersionId` .", "stability": "external", "summary": "The Amazon Resource Name (ARN) of the module version to set as the default version." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 1166 }, "name": "arn", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduledefaultversion.html#cfn-cloudformation-moduledefaultversion-modulename" }, "remarks": "Conditional: You must specify either `Arn` , or `ModuleName` and `VersionId` .", "stability": "external", "summary": "The name of the module." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 1175 }, "name": "moduleName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduledefaultversion.html#cfn-cloudformation-moduledefaultversion-versionid" }, "remarks": "Conditional: You must specify either `Arn` , or `ModuleName` and `VersionId` .", "stability": "external", "summary": "The ID for the specific version of the module." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 1184 }, "name": "versionId", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/cloudformation.generated:CfnModuleDefaultVersionProps" }, "@aws-cdk/aws-cloudformation.CfnModuleVersion": { "assembly": "@aws-cdk/aws-cloudformation", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::CloudFormation::ModuleVersion", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduleversion.html", "exampleMetadata": "fixture=_generated" }, "remarks": "Registers the specified version of the module with the CloudFormation service. Registering a module makes it available for use in CloudFormation templates in your AWS account and Region.\n\nTo specify a module version as the default version, use the `[AWS::CloudFormation::ModuleDefaultVersion](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduledefaultversion.html)` resource.\n\nFor more information using modules, see [Using modules to encapsulate and reuse resource configurations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/modules.html) and [Registering extensions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html#registry-register) in the *CloudFormation User Guide* . For information on developing modules, see [Developing modules](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/modules.html) in the *CloudFormation CLI User Guide* .", "stability": "external", "summary": "A CloudFormation `AWS::CloudFormation::ModuleVersion`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst cfnModuleVersion = new cloudformation.CfnModuleVersion(this, 'MyCfnModuleVersion', {\n moduleName: 'moduleName',\n modulePackage: 'modulePackage',\n});" }, "fqn": "@aws-cdk/aws-cloudformation.CfnModuleVersion", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::CloudFormation::ModuleVersion`." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 1535 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-cloudformation.CfnModuleVersionProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 1434 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 1558 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 1570 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnModuleVersion", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 1438 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Arn" }, "stability": "external", "summary": "The Amazon Resource Name (ARN) of the module." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 1463 }, "name": "attrArn", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Description" }, "stability": "external", "summary": "The description of the module." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 1469 }, "name": "attrDescription", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "DocumentationUrl" }, "stability": "external", "summary": "The URL of a page providing detailed documentation for this module." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 1475 }, "name": "attrDocumentationUrl", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "IsDefaultVersion" }, "stability": "external", "summary": "Whether the specified module version is set as the default version." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 1481 }, "name": "attrIsDefaultVersion", "type": { "fqn": "@aws-cdk/core.IResolvable" } }, { "docs": { "custom": { "cloudformationAttribute": "Schema" }, "stability": "external", "summary": "The schema that defines the module." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 1487 }, "name": "attrSchema", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "TimeCreated" }, "stability": "external", "summary": "When the specified module version was registered." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 1493 }, "name": "attrTimeCreated", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "VersionId" }, "stability": "external", "summary": "The ID of this version of the module." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 1499 }, "name": "attrVersionId", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Visibility" }, "remarks": "Valid values include:\n\n- `PRIVATE` : The module is only visible and usable within the account in which it's registered.\n- `PUBLIC` : The module is publicly visible and usable within any Amazon account.", "stability": "external", "summary": "The scope at which the module is visible and usable in CloudFormation operations." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 1510 }, "name": "attrVisibility", "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 1563 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduleversion.html#cfn-cloudformation-moduleversion-modulename" }, "stability": "external", "summary": "The name of the module being registered." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 1517 }, "name": "moduleName", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduleversion.html#cfn-cloudformation-moduleversion-modulepackage" }, "remarks": "> 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* .", "stability": "external", "summary": "A URL to the S3 bucket containing the package that contains the template fragment and schema files for the module version to register." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 1526 }, "name": "modulePackage", "type": { "primitive": "string" } } ], "symbolId": "lib/cloudformation.generated:CfnModuleVersion" }, "@aws-cdk/aws-cloudformation.CfnModuleVersionProps": { "assembly": "@aws-cdk/aws-cloudformation", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduleversion.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnModuleVersion`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst cfnModuleVersionProps: cloudformation.CfnModuleVersionProps = {\n moduleName: 'moduleName',\n modulePackage: 'modulePackage',\n};" }, "fqn": "@aws-cdk/aws-cloudformation.CfnModuleVersionProps", "kind": "interface", "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 1351 }, "name": "CfnModuleVersionProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduleversion.html#cfn-cloudformation-moduleversion-modulename" }, "stability": "external", "summary": "The name of the module being registered." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 1358 }, "name": "moduleName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduleversion.html#cfn-cloudformation-moduleversion-modulepackage" }, "remarks": "> 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* .", "stability": "external", "summary": "A URL to the S3 bucket containing the package that contains the template fragment and schema files for the module version to register." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 1367 }, "name": "modulePackage", "type": { "primitive": "string" } } ], "symbolId": "lib/cloudformation.generated:CfnModuleVersionProps" }, "@aws-cdk/aws-cloudformation.CfnPublicTypeVersion": { "assembly": "@aws-cdk/aws-cloudformation", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::CloudFormation::PublicTypeVersion", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publictypeversion.html", "exampleMetadata": "fixture=_generated" }, "remarks": "Tests and publishes a registered extension as a public, third-party extension.\n\nCloudFormation 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.\n\n- For resource types, testing includes passing all contracts tests defined for the type.\n- For modules, testing includes determining if the module's model meets all necessary requirements.\n\nFor more information, see [Testing your public extension prior to publishing](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html#publish-extension-testing) in the *CloudFormation CLI User Guide* .\n\nIf you don't specify a version, CloudFormation uses the default version of the extension in your account and Region for testing.\n\nTo perform testing, CloudFormation assumes the execution role specified when the type was registered.\n\nAn extension must have a test status of `PASSED` before it can be published. For more information, see [Publishing extensions to make them available for public use](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-publish.html) in the *CloudFormation CLI User Guide* .", "stability": "external", "summary": "A CloudFormation `AWS::CloudFormation::PublicTypeVersion`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst cfnPublicTypeVersion = new cloudformation.CfnPublicTypeVersion(this, 'MyCfnPublicTypeVersion', /* all optional props */ {\n arn: 'arn',\n logDeliveryBucket: 'logDeliveryBucket',\n publicVersionNumber: 'publicVersionNumber',\n type: 'type',\n typeName: 'typeName',\n});" }, "fqn": "@aws-cdk/aws-cloudformation.CfnPublicTypeVersion", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::CloudFormation::PublicTypeVersion`." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 1836 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudformation.CfnPublicTypeVersionProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 1726 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 1855 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 1870 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnPublicTypeVersion", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 1730 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "PublicTypeArn" }, "stability": "external", "summary": "The Amazon Resource Number (ARN) assigned to the public extension upon publication." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 1755 }, "name": "attrPublicTypeArn", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "PublisherId" }, "stability": "external", "summary": "The publisher ID of the extension publisher." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 1761 }, "name": "attrPublisherId", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "TypeVersionArn" }, "stability": "external", "summary": "The Amazon Resource Number (ARN) assigned to this version of the extension." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 1767 }, "name": "attrTypeVersionArn", "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 1860 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publictypeversion.html#cfn-cloudformation-publictypeversion-arn" }, "remarks": "Conditional: You must specify `Arn` , or `TypeName` and `Type` .", "stability": "external", "summary": "The Amazon Resource Number (ARN) of the extension." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 1776 }, "name": "arn", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publictypeversion.html#cfn-cloudformation-publictypeversion-logdeliverybucket" }, "remarks": "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` .\n\nThe user initiating the stack operation must be able to access items in the specified S3 bucket. Specifically, the user needs the following permissions:\n\n- GetObject\n- PutObject\n\nFor 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* .", "stability": "external", "summary": "The S3 bucket to which CloudFormation delivers the contract test execution logs." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 1792 }, "name": "logDeliveryBucket", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publictypeversion.html#cfn-cloudformation-publictypeversion-publicversionnumber" }, "remarks": "Use the following format, and adhere to semantic versioning when assigning a version number to your extension:\n\n`MAJOR.MINOR.PATCH`\n\nFor more information, see [Semantic Versioning 2.0.0](https://docs.aws.amazon.com/https://semver.org/) .\n\nIf you don't specify a version number, CloudFormation increments the version number by one minor version release.\n\nYou 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` .", "stability": "external", "summary": "The version number to assign to this version of the extension." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 1809 }, "name": "publicVersionNumber", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publictypeversion.html#cfn-cloudformation-publictypeversion-type" }, "remarks": "Conditional: You must specify `Arn` , or `TypeName` and `Type` .", "stability": "external", "summary": "The type of the extension to test." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 1818 }, "name": "type", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publictypeversion.html#cfn-cloudformation-publictypeversion-typename" }, "remarks": "Conditional: You must specify `Arn` , or `TypeName` and `Type` .", "stability": "external", "summary": "The name of the extension to test." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 1827 }, "name": "typeName", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/cloudformation.generated:CfnPublicTypeVersion" }, "@aws-cdk/aws-cloudformation.CfnPublicTypeVersionProps": { "assembly": "@aws-cdk/aws-cloudformation", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publictypeversion.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnPublicTypeVersion`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst cfnPublicTypeVersionProps: cloudformation.CfnPublicTypeVersionProps = {\n arn: 'arn',\n logDeliveryBucket: 'logDeliveryBucket',\n publicVersionNumber: 'publicVersionNumber',\n type: 'type',\n typeName: 'typeName',\n};" }, "fqn": "@aws-cdk/aws-cloudformation.CfnPublicTypeVersionProps", "kind": "interface", "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 1583 }, "name": "CfnPublicTypeVersionProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publictypeversion.html#cfn-cloudformation-publictypeversion-arn" }, "remarks": "Conditional: You must specify `Arn` , or `TypeName` and `Type` .", "stability": "external", "summary": "The Amazon Resource Number (ARN) of the extension." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 1592 }, "name": "arn", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publictypeversion.html#cfn-cloudformation-publictypeversion-logdeliverybucket" }, "remarks": "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` .\n\nThe user initiating the stack operation must be able to access items in the specified S3 bucket. Specifically, the user needs the following permissions:\n\n- GetObject\n- PutObject\n\nFor 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* .", "stability": "external", "summary": "The S3 bucket to which CloudFormation delivers the contract test execution logs." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 1608 }, "name": "logDeliveryBucket", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publictypeversion.html#cfn-cloudformation-publictypeversion-publicversionnumber" }, "remarks": "Use the following format, and adhere to semantic versioning when assigning a version number to your extension:\n\n`MAJOR.MINOR.PATCH`\n\nFor more information, see [Semantic Versioning 2.0.0](https://docs.aws.amazon.com/https://semver.org/) .\n\nIf you don't specify a version number, CloudFormation increments the version number by one minor version release.\n\nYou 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` .", "stability": "external", "summary": "The version number to assign to this version of the extension." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 1625 }, "name": "publicVersionNumber", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publictypeversion.html#cfn-cloudformation-publictypeversion-type" }, "remarks": "Conditional: You must specify `Arn` , or `TypeName` and `Type` .", "stability": "external", "summary": "The type of the extension to test." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 1634 }, "name": "type", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publictypeversion.html#cfn-cloudformation-publictypeversion-typename" }, "remarks": "Conditional: You must specify `Arn` , or `TypeName` and `Type` .", "stability": "external", "summary": "The name of the extension to test." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 1643 }, "name": "typeName", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/cloudformation.generated:CfnPublicTypeVersionProps" }, "@aws-cdk/aws-cloudformation.CfnPublisher": { "assembly": "@aws-cdk/aws-cloudformation", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::CloudFormation::Publisher", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publisher.html", "exampleMetadata": "fixture=_generated" }, "remarks": "Registers your account as a publisher of public extensions in the CloudFormation registry. Public extensions are available for use by all CloudFormation users.\n\nFor information on requirements for registering as a public extension publisher, see [Registering your account to publish CloudFormation extensions](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html#publish-extension-prereqs) in the *CloudFormation CLI User Guide* .", "stability": "external", "summary": "A CloudFormation `AWS::CloudFormation::Publisher`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst cfnPublisher = new cloudformation.CfnPublisher(this, 'MyCfnPublisher', {\n acceptTermsAndConditions: false,\n\n // the properties below are optional\n connectionArn: 'connectionArn',\n});" }, "fqn": "@aws-cdk/aws-cloudformation.CfnPublisher", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::CloudFormation::Publisher`." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 2041 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-cloudformation.CfnPublisherProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 1965 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 2059 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 2071 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnPublisher", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 1969 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "IdentityProvider" }, "remarks": "Values include: `AWS_Marketplace` | `Bitbucket` | `GitHub` .", "stability": "external", "summary": "The type of account used as the identity provider when registering this publisher with CloudFormation ." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 1996 }, "name": "attrIdentityProvider", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "PublisherId" }, "remarks": "This publisher ID applies to your account in all AWS Regions .", "stability": "external", "summary": "The ID of the extension publisher." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 2002 }, "name": "attrPublisherId", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "PublisherProfile" }, "stability": "external", "summary": "The URL to the publisher's profile with the identity provider." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 2008 }, "name": "attrPublisherProfile", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "PublisherStatus" }, "stability": "external", "summary": "Whether the publisher is verified." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 2014 }, "name": "attrPublisherStatus", "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 2064 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publisher.html#cfn-cloudformation-publisher-accepttermsandconditions" }, "remarks": "The default is `false` .", "stability": "external", "summary": "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." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 2023 }, "name": "acceptTermsAndConditions", "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publisher.html#cfn-cloudformation-publisher-connectionarn" }, "remarks": "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* .", "stability": "external", "summary": "If you are using a Bitbucket or GitHub account for identity verification, the Amazon Resource Name (ARN) for your connection to that account." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 2032 }, "name": "connectionArn", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/cloudformation.generated:CfnPublisher" }, "@aws-cdk/aws-cloudformation.CfnPublisherProps": { "assembly": "@aws-cdk/aws-cloudformation", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publisher.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnPublisher`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst cfnPublisherProps: cloudformation.CfnPublisherProps = {\n acceptTermsAndConditions: false,\n\n // the properties below are optional\n connectionArn: 'connectionArn',\n};" }, "fqn": "@aws-cdk/aws-cloudformation.CfnPublisherProps", "kind": "interface", "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 1883 }, "name": "CfnPublisherProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publisher.html#cfn-cloudformation-publisher-accepttermsandconditions" }, "remarks": "The default is `false` .", "stability": "external", "summary": "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." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 1892 }, "name": "acceptTermsAndConditions", "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publisher.html#cfn-cloudformation-publisher-connectionarn" }, "remarks": "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* .", "stability": "external", "summary": "If you are using a Bitbucket or GitHub account for identity verification, the Amazon Resource Name (ARN) for your connection to that account." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 1901 }, "name": "connectionArn", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/cloudformation.generated:CfnPublisherProps" }, "@aws-cdk/aws-cloudformation.CfnResourceDefaultVersion": { "assembly": "@aws-cdk/aws-cloudformation", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::CloudFormation::ResourceDefaultVersion", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourcedefaultversion.html", "exampleMetadata": "fixture=_generated" }, "remarks": "Specifies the default version of a resource. The default version of a resource will be used in CloudFormation operations.", "stability": "external", "summary": "A CloudFormation `AWS::CloudFormation::ResourceDefaultVersion`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst cfnResourceDefaultVersion = new cloudformation.CfnResourceDefaultVersion(this, 'MyCfnResourceDefaultVersion', /* all optional props */ {\n typeName: 'typeName',\n typeVersionArn: 'typeVersionArn',\n versionId: 'versionId',\n});" }, "fqn": "@aws-cdk/aws-cloudformation.CfnResourceDefaultVersion", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::CloudFormation::ResourceDefaultVersion`." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 2240 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudformation.CfnResourceDefaultVersionProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 2175 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 2255 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 2268 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnResourceDefaultVersion", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 2179 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Arn" }, "stability": "external", "summary": "The Amazon Resource Name (ARN) of the resource." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 2204 }, "name": "attrArn", "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 2260 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourcedefaultversion.html#cfn-cloudformation-resourcedefaultversion-typename" }, "remarks": "Conditional: You must specify either `TypeVersionArn` , or `TypeName` and `VersionId` .", "stability": "external", "summary": "The name of the resource." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 2213 }, "name": "typeName", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourcedefaultversion.html#cfn-cloudformation-resourcedefaultversion-typeversionarn" }, "remarks": "Conditional: You must specify either `TypeVersionArn` , or `TypeName` and `VersionId` .", "stability": "external", "summary": "The Amazon Resource Name (ARN) of the resource version." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 2222 }, "name": "typeVersionArn", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourcedefaultversion.html#cfn-cloudformation-resourcedefaultversion-versionid" }, "remarks": "The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the resource version when it's registered.\n\nConditional: You must specify either `TypeVersionArn` , or `TypeName` and `VersionId` .", "stability": "external", "summary": "The ID of a specific version of the resource." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 2231 }, "name": "versionId", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/cloudformation.generated:CfnResourceDefaultVersion" }, "@aws-cdk/aws-cloudformation.CfnResourceDefaultVersionProps": { "assembly": "@aws-cdk/aws-cloudformation", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourcedefaultversion.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnResourceDefaultVersion`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst cfnResourceDefaultVersionProps: cloudformation.CfnResourceDefaultVersionProps = {\n typeName: 'typeName',\n typeVersionArn: 'typeVersionArn',\n versionId: 'versionId',\n};" }, "fqn": "@aws-cdk/aws-cloudformation.CfnResourceDefaultVersionProps", "kind": "interface", "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 2084 }, "name": "CfnResourceDefaultVersionProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourcedefaultversion.html#cfn-cloudformation-resourcedefaultversion-typename" }, "remarks": "Conditional: You must specify either `TypeVersionArn` , or `TypeName` and `VersionId` .", "stability": "external", "summary": "The name of the resource." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 2093 }, "name": "typeName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourcedefaultversion.html#cfn-cloudformation-resourcedefaultversion-typeversionarn" }, "remarks": "Conditional: You must specify either `TypeVersionArn` , or `TypeName` and `VersionId` .", "stability": "external", "summary": "The Amazon Resource Name (ARN) of the resource version." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 2102 }, "name": "typeVersionArn", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourcedefaultversion.html#cfn-cloudformation-resourcedefaultversion-versionid" }, "remarks": "The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the resource version when it's registered.\n\nConditional: You must specify either `TypeVersionArn` , or `TypeName` and `VersionId` .", "stability": "external", "summary": "The ID of a specific version of the resource." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 2111 }, "name": "versionId", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/cloudformation.generated:CfnResourceDefaultVersionProps" }, "@aws-cdk/aws-cloudformation.CfnResourceVersion": { "assembly": "@aws-cdk/aws-cloudformation", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::CloudFormation::ResourceVersion", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourceversion.html", "exampleMetadata": "fixture=_generated" }, "remarks": "Registers a resource version with the CloudFormation service. Registering a resource version makes it available for use in CloudFormation templates in your AWS account , and includes:\n\n- Validating the resource schema.\n- Determining which handlers, if any, have been specified for the resource.\n- Making the resource available for use in your account.\n\nFor more information on how to develop resources and ready them for registration, see [Creating Resource Providers](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-types.html) in the *CloudFormation CLI User Guide* .\n\nYou can have a maximum of 50 resource versions registered at a time. This maximum is per account and per Region.", "stability": "external", "summary": "A CloudFormation `AWS::CloudFormation::ResourceVersion`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst cfnResourceVersion = new cloudformation.CfnResourceVersion(this, 'MyCfnResourceVersion', {\n schemaHandlerPackage: 'schemaHandlerPackage',\n typeName: 'typeName',\n\n // the properties below are optional\n executionRoleArn: 'executionRoleArn',\n loggingConfig: {\n logGroupName: 'logGroupName',\n logRoleArn: 'logRoleArn',\n },\n});" }, "fqn": "@aws-cdk/aws-cloudformation.CfnResourceVersion", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::CloudFormation::ResourceVersion`." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 2527 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-cloudformation.CfnResourceVersionProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 2401 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 2550 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 2564 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnResourceVersion", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 2405 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Arn" }, "stability": "external", "summary": "The Amazon Resource Name (ARN) of the resource version." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 2430 }, "name": "attrArn", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "IsDefaultVersion" }, "stability": "external", "summary": "Whether the resource version is set as the default version." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 2436 }, "name": "attrIsDefaultVersion", "type": { "fqn": "@aws-cdk/core.IResolvable" } }, { "docs": { "custom": { "cloudformationAttribute": "ProvisioningType" }, "remarks": "CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.\n\nValid values include:\n\n- `FULLY_MUTABLE` : The resource type includes an update handler to process updates to the type during stack update operations.\n- `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.\n- `NON_PROVISIONABLE` : The resource type doesn't include all the following handlers, and therefore can't actually be provisioned.\n\n- create\n- read\n- delete", "stability": "external", "summary": "The provisioning behavior of the resource type." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 2452 }, "name": "attrProvisioningType", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "TypeArn" }, "stability": "external", "summary": "The Amazon Resource Name (ARN) of the resource." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 2458 }, "name": "attrTypeArn", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "VersionId" }, "remarks": "The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the resource version when it is registered.", "stability": "external", "summary": "The ID of a specific version of the resource." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 2464 }, "name": "attrVersionId", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Visibility" }, "remarks": "Valid values include:\n\n- `PRIVATE` : The resource is only visible and usable within the account in which it's registered. CloudFormation marks any resources you register as `PRIVATE` .\n- `PUBLIC` : The resource is publicly visible and usable within any Amazon account.", "stability": "external", "summary": "The scope at which the resource is visible and usable in CloudFormation operations." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 2475 }, "name": "attrVisibility", "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 2555 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourceversion.html#cfn-cloudformation-resourceversion-schemahandlerpackage" }, "remarks": "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* .\n\n> 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* .", "stability": "external", "summary": "A URL to the S3 bucket containing the resource project package that contains the necessary files for the resource you want to register." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 2486 }, "name": "schemaHandlerPackage", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourceversion.html#cfn-cloudformation-resourceversion-typename" }, "remarks": "We recommend that resource names adhere to the following pattern: *company_or_organization* :: *service* :: *type* .\n\n> The following organization namespaces are reserved and can't be used in your resource names:\n>\n> - `Alexa`\n> - `AMZN`\n> - `Amazon`\n> - `AWS`\n> - `Custom`\n> - `Dev`", "stability": "external", "summary": "The name of the resource being registered." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 2504 }, "name": "typeName", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourceversion.html#cfn-cloudformation-resourceversion-executionrolearn" }, "remarks": "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.", "stability": "external", "summary": "The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the resource." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 2511 }, "name": "executionRoleArn", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourceversion.html#cfn-cloudformation-resourceversion-loggingconfig" }, "stability": "external", "summary": "Logging configuration information for a resource." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 2518 }, "name": "loggingConfig", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-cloudformation.CfnResourceVersion.LoggingConfigProperty" } ] } } } ], "symbolId": "lib/cloudformation.generated:CfnResourceVersion" }, "@aws-cdk/aws-cloudformation.CfnResourceVersion.LoggingConfigProperty": { "assembly": "@aws-cdk/aws-cloudformation", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-resourceversion-loggingconfig.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Logging configuration information for a resource.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst loggingConfigProperty: cloudformation.CfnResourceVersion.LoggingConfigProperty = {\n logGroupName: 'logGroupName',\n logRoleArn: 'logRoleArn',\n};" }, "fqn": "@aws-cdk/aws-cloudformation.CfnResourceVersion.LoggingConfigProperty", "kind": "interface", "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 2578 }, "name": "LoggingConfigProperty", "namespace": "CfnResourceVersion", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-resourceversion-loggingconfig.html#cfn-cloudformation-resourceversion-loggingconfig-loggroupname" }, "stability": "external", "summary": "The Amazon CloudWatch logs group to which CloudFormation sends error logging information when invoking the type's handlers." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 2584 }, "name": "logGroupName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-resourceversion-loggingconfig.html#cfn-cloudformation-resourceversion-loggingconfig-logrolearn" }, "stability": "external", "summary": "The ARN of the role that CloudFormation should assume when sending log entries to CloudWatch logs." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 2590 }, "name": "logRoleArn", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/cloudformation.generated:CfnResourceVersion.LoggingConfigProperty" }, "@aws-cdk/aws-cloudformation.CfnResourceVersionProps": { "assembly": "@aws-cdk/aws-cloudformation", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourceversion.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnResourceVersion`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst cfnResourceVersionProps: cloudformation.CfnResourceVersionProps = {\n schemaHandlerPackage: 'schemaHandlerPackage',\n typeName: 'typeName',\n\n // the properties below are optional\n executionRoleArn: 'executionRoleArn',\n loggingConfig: {\n logGroupName: 'logGroupName',\n logRoleArn: 'logRoleArn',\n },\n};" }, "fqn": "@aws-cdk/aws-cloudformation.CfnResourceVersionProps", "kind": "interface", "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 2281 }, "name": "CfnResourceVersionProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourceversion.html#cfn-cloudformation-resourceversion-schemahandlerpackage" }, "remarks": "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* .\n\n> 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* .", "stability": "external", "summary": "A URL to the S3 bucket containing the resource project package that contains the necessary files for the resource you want to register." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 2292 }, "name": "schemaHandlerPackage", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourceversion.html#cfn-cloudformation-resourceversion-typename" }, "remarks": "We recommend that resource names adhere to the following pattern: *company_or_organization* :: *service* :: *type* .\n\n> The following organization namespaces are reserved and can't be used in your resource names:\n>\n> - `Alexa`\n> - `AMZN`\n> - `Amazon`\n> - `AWS`\n> - `Custom`\n> - `Dev`", "stability": "external", "summary": "The name of the resource being registered." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 2310 }, "name": "typeName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourceversion.html#cfn-cloudformation-resourceversion-executionrolearn" }, "remarks": "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.", "stability": "external", "summary": "The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the resource." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 2317 }, "name": "executionRoleArn", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourceversion.html#cfn-cloudformation-resourceversion-loggingconfig" }, "stability": "external", "summary": "Logging configuration information for a resource." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 2324 }, "name": "loggingConfig", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-cloudformation.CfnResourceVersion.LoggingConfigProperty" } ] } } } ], "symbolId": "lib/cloudformation.generated:CfnResourceVersionProps" }, "@aws-cdk/aws-cloudformation.CfnStack": { "assembly": "@aws-cdk/aws-cloudformation", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::CloudFormation::Stack", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The `AWS::CloudFormation::Stack` resource nests a stack as a resource in a top-level template.\n\nYou can add output values from a nested stack within the containing template. You use the [GetAtt](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html) function with the nested stack's logical name and the name of the output value in the nested stack in the format `Outputs. *NestedStackOutputName*` .\n\n> We strongly recommend that updates to nested stacks are run from the parent stack.\n\nWhen you apply template changes to update a top-level stack, CloudFormation updates the top-level stack and initiates an update to its nested stacks. CloudFormation updates the resources of modified nested stacks, but doesn't update the resources of unmodified nested stacks. For more information, see [CloudFormation stack updates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html) .\n\n> You must acknowledge IAM capabilities for nested stacks that contain IAM resources. Also, verify that you have cancel update stack permissions, which is required if an update rolls back. For more information about IAM and CloudFormation , see [Controlling access with AWS Identity and Access Management](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html) .", "stability": "external", "summary": "A CloudFormation `AWS::CloudFormation::Stack`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst cfnStack = new cloudformation.CfnStack(this, 'MyCfnStack', {\n templateUrl: 'templateUrl',\n\n // the properties below are optional\n notificationArns: ['notificationArns'],\n parameters: {\n parametersKey: 'parameters',\n },\n tags: [{\n key: 'key',\n value: 'value',\n }],\n timeoutInMinutes: 123,\n});" }, "fqn": "@aws-cdk/aws-cloudformation.CfnStack", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::CloudFormation::Stack`." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 2854 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-cloudformation.CfnStackProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 2777 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 2876 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 2891 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnStack", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 2781 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 2881 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html#cfn-cloudformation-stack-tags" }, "remarks": "AWS CloudFormation also propagates these tags to the resources created in the stack. A maximum number of 50 tags can be specified.", "stability": "external", "summary": "Key-value pairs to associate with this stack." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 2836 }, "name": "tags", "type": { "fqn": "@aws-cdk/core.TagManager" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html#cfn-cloudformation-stack-templateurl" }, "remarks": "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) .\n\nWhether an update causes interruptions depends on the resources that are being updated. An update never causes a nested stack to be replaced.", "stability": "external", "summary": "Location of file containing the template body." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 2809 }, "name": "templateUrl", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html#cfn-cloudformation-stack-notificationarns" }, "remarks": "You can find your Amazon SNS topic ARNs using the Amazon SNS console or your Command Line Interface (CLI).", "stability": "external", "summary": "The Amazon Simple Notification Service (Amazon SNS) topic ARNs to publish stack related events." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 2816 }, "name": "notificationArns", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html#cfn-cloudformation-stack-parameters" }, "remarks": "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.\n\n> 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.\n\nConditional. Required if the nested stack requires input parameters.\n\nWhether an update causes interruptions depends on the resources that are being updated. An update never causes a nested stack to be replaced.", "stability": "external", "summary": "The set value pairs that represent the parameters passed to CloudFormation when this nested stack is created." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 2829 }, "name": "parameters", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html#cfn-cloudformation-stack-timeoutinminutes" }, "remarks": "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.\n\nUpdates aren't supported.", "stability": "external", "summary": "The length of time, in minutes, that CloudFormation waits for the nested stack to reach the `CREATE_COMPLETE` state." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 2845 }, "name": "timeoutInMinutes", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "lib/cloudformation.generated:CfnStack" }, "@aws-cdk/aws-cloudformation.CfnStackProps": { "assembly": "@aws-cdk/aws-cloudformation", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnStack`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst cfnStackProps: cloudformation.CfnStackProps = {\n templateUrl: 'templateUrl',\n\n // the properties below are optional\n notificationArns: ['notificationArns'],\n parameters: {\n parametersKey: 'parameters',\n },\n tags: [{\n key: 'key',\n value: 'value',\n }],\n timeoutInMinutes: 123,\n};" }, "fqn": "@aws-cdk/aws-cloudformation.CfnStackProps", "kind": "interface", "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 2653 }, "name": "CfnStackProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html#cfn-cloudformation-stack-templateurl" }, "remarks": "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) .\n\nWhether an update causes interruptions depends on the resources that are being updated. An update never causes a nested stack to be replaced.", "stability": "external", "summary": "Location of file containing the template body." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 2662 }, "name": "templateUrl", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html#cfn-cloudformation-stack-notificationarns" }, "remarks": "You can find your Amazon SNS topic ARNs using the Amazon SNS console or your Command Line Interface (CLI).", "stability": "external", "summary": "The Amazon Simple Notification Service (Amazon SNS) topic ARNs to publish stack related events." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 2669 }, "name": "notificationArns", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html#cfn-cloudformation-stack-parameters" }, "remarks": "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.\n\n> 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.\n\nConditional. Required if the nested stack requires input parameters.\n\nWhether an update causes interruptions depends on the resources that are being updated. An update never causes a nested stack to be replaced.", "stability": "external", "summary": "The set value pairs that represent the parameters passed to CloudFormation when this nested stack is created." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 2682 }, "name": "parameters", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html#cfn-cloudformation-stack-tags" }, "remarks": "AWS CloudFormation also propagates these tags to the resources created in the stack. A maximum number of 50 tags can be specified.", "stability": "external", "summary": "Key-value pairs to associate with this stack." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 2689 }, "name": "tags", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/core.CfnTag" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html#cfn-cloudformation-stack-timeoutinminutes" }, "remarks": "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.\n\nUpdates aren't supported.", "stability": "external", "summary": "The length of time, in minutes, that CloudFormation waits for the nested stack to reach the `CREATE_COMPLETE` state." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 2698 }, "name": "timeoutInMinutes", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "lib/cloudformation.generated:CfnStackProps" }, "@aws-cdk/aws-cloudformation.CfnStackSet": { "assembly": "@aws-cdk/aws-cloudformation", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::CloudFormation::StackSet", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The `AWS::CloudFormation::StackSet` enables you to provision stacks into AWS accounts and across Regions by using a single CloudFormation template. In the stack set, you specify the template to use, in addition to any parameters and capabilities that the template requires.", "stability": "external", "summary": "A CloudFormation `AWS::CloudFormation::StackSet`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\n\ndeclare const managedExecution: any;\nconst cfnStackSet = new cloudformation.CfnStackSet(this, 'MyCfnStackSet', {\n permissionModel: 'permissionModel',\n stackSetName: 'stackSetName',\n\n // the properties below are optional\n administrationRoleArn: 'administrationRoleArn',\n autoDeployment: {\n enabled: false,\n retainStacksOnAccountRemoval: false,\n },\n callAs: 'callAs',\n capabilities: ['capabilities'],\n description: 'description',\n executionRoleName: 'executionRoleName',\n managedExecution: managedExecution,\n operationPreferences: {\n failureToleranceCount: 123,\n failureTolerancePercentage: 123,\n maxConcurrentCount: 123,\n maxConcurrentPercentage: 123,\n regionConcurrencyType: 'regionConcurrencyType',\n regionOrder: ['regionOrder'],\n },\n parameters: [{\n parameterKey: 'parameterKey',\n parameterValue: 'parameterValue',\n }],\n stackInstancesGroup: [{\n deploymentTargets: {\n accountFilterType: 'accountFilterType',\n accounts: ['accounts'],\n organizationalUnitIds: ['organizationalUnitIds'],\n },\n regions: ['regions'],\n\n // the properties below are optional\n parameterOverrides: [{\n parameterKey: 'parameterKey',\n parameterValue: 'parameterValue',\n }],\n }],\n tags: [{\n key: 'key',\n value: 'value',\n }],\n templateBody: 'templateBody',\n templateUrl: 'templateUrl',\n});" }, "fqn": "@aws-cdk/aws-cloudformation.CfnStackSet", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::CloudFormation::StackSet`." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 3366 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-cloudformation.CfnStackSetProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 3167 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 3395 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 3420 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnStackSet", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 3171 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "StackSetId" }, "stability": "external", "summary": "The ID of the stack that you're creating." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 3196 }, "name": "attrStackSetId", "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 3400 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-tags" }, "remarks": "AWS CloudFormation also propagates these tags to supported resources that are created in the stacks. A maximum number of 50 tags can be specified.", "stability": "external", "summary": "The key-value pairs to associate with this stack set and the stacks created from it." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 3331 }, "name": "tags", "type": { "fqn": "@aws-cdk/core.TagManager" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-managedexecution" }, "remarks": "When active, StackSets performs non-conflicting operations concurrently and queues conflicting operations. After conflicting operations finish, StackSets starts queued operations in request order.\n\n> If there are already running or queued operations, StackSets queues all incoming operations even if they are non-conflicting.\n>\n> You can't modify your stack set's execution configuration while there are running or queued operations for that stack set.\n\nWhen inactive (default), StackSets performs one operation at a time in request order.", "stability": "external", "summary": "Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 3303 }, "name": "managedExecution", "type": { "primitive": "any" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-permissionmodel" }, "remarks": "- 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) .\n- 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) .", "stability": "external", "summary": "Describes how the IAM roles required for stack set operations are created." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 3206 }, "name": "permissionModel", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-stacksetname" }, "remarks": "The name must be unique in the Region where you create your stack set.\n\n*Maximum* : `128`\n\n*Pattern* : `^[a-zA-Z][a-zA-Z0-9-]{0,127}$`\n\n> The `StackSetName` property is required.", "stability": "external", "summary": "The name to associate with the stack set." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 3219 }, "name": "stackSetName", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-administrationrolearn" }, "remarks": "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.\n\nUse 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* .\n\n*Minimum* : `20`\n\n*Maximum* : `2048`", "stability": "external", "summary": "The Amazon Resource Number (ARN) of the IAM role to use to create this stack set." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 3232 }, "name": "administrationRoleArn", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-autodeployment" }, "stability": "external", "summary": "[ `Service-managed` permissions] Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU)." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 3239 }, "name": "autoDeployment", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-cloudformation.CfnStackSet.AutoDeploymentProperty" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-callas" }, "remarks": "By default, `SELF` is specified. Use `SELF` for stack sets with self-managed permissions.\n\n- To create a stack set with service-managed permissions while signed in to the management account, specify `SELF` .\n- To create a stack set with service-managed permissions while signed in to a delegated administrator account, specify `DELEGATED_ADMIN` .\n\nYour 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* .\n\nStack sets with service-managed permissions are created in the management account, including stack sets that are created by delegated administrators.\n\n*Valid Values* : `SELF` | `DELEGATED_ADMIN`", "stability": "external", "summary": "[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." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 3257 }, "name": "callAs", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-capabilities" }, "remarks": "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) .", "stability": "external", "summary": "The capabilities that are allowed in the stack set." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 3264 }, "name": "capabilities", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-description" }, "remarks": "*Minimum* : `1`\n\n*Maximum* : `1024`", "stability": "external", "summary": "A description of the stack set." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 3275 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-executionrolename" }, "remarks": "If you don't specify an execution role, AWS CloudFormation uses the `AWSCloudFormationStackSetExecutionRole` role for the stack set operation.\n\n*Minimum* : `1`\n\n*Maximum* : `64`\n\n*Pattern* : `[a-zA-Z_0-9+=,.@-]+`", "stability": "external", "summary": "The name of the IAM execution role to use to create the stack set." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 3288 }, "name": "executionRoleName", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-operationpreferences" }, "stability": "external", "summary": "The user-specified preferences for how AWS CloudFormation performs a stack set operation." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 3310 }, "name": "operationPreferences", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-cloudformation.CfnStackSet.OperationPreferencesProperty" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-parameters" }, "stability": "external", "summary": "The input parameters for the stack set template." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 3317 }, "name": "parameters", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-cloudformation.CfnStackSet.ParameterProperty" } ] } }, "kind": "array" } } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-stackinstancesgroup" }, "stability": "external", "summary": "A group of stack instances with parameters in some specific accounts and Regions." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 3324 }, "name": "stackInstancesGroup", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-cloudformation.CfnStackSet.StackInstancesProperty" } ] } }, "kind": "array" } } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-templatebody" }, "remarks": "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.\n\n*Minimum* : `1`\n\n*Maximum* : `51200`", "stability": "external", "summary": "The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 3344 }, "name": "templateBody", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-templateurl" }, "remarks": "The URL must point to a template (max size: 460,800 bytes) that's located in an Amazon S3 bucket.\n\nYou must include either `TemplateURL` or `TemplateBody` in a StackSet, but you can't use both.\n\n*Minimum* : `1`\n\n*Maximum* : `1024`", "stability": "external", "summary": "Location of file containing the template body." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 3357 }, "name": "templateUrl", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/cloudformation.generated:CfnStackSet" }, "@aws-cdk/aws-cloudformation.CfnStackSet.AutoDeploymentProperty": { "assembly": "@aws-cdk/aws-cloudformation", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-autodeployment.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "[ `Service-managed` permissions] Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organizational unit (OU).", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst autoDeploymentProperty: cloudformation.CfnStackSet.AutoDeploymentProperty = {\n enabled: false,\n retainStacksOnAccountRemoval: false,\n};" }, "fqn": "@aws-cdk/aws-cloudformation.CfnStackSet.AutoDeploymentProperty", "kind": "interface", "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 3434 }, "name": "AutoDeploymentProperty", "namespace": "CfnStackSet", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-autodeployment.html#cfn-cloudformation-stackset-autodeployment-enabled" }, "remarks": "If an account is removed from a target organization or OU, StackSets deletes stack instances from the account in the specified Regions.", "stability": "external", "summary": "If set to `true` , StackSets automatically deploys additional stack instances to AWS Organizations accounts that are added to a target organization or organizational unit (OU) in the specified Regions." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 3440 }, "name": "enabled", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-autodeployment.html#cfn-cloudformation-stackset-autodeployment-retainstacksonaccountremoval" }, "remarks": "If set to `false` , stack resources are deleted. Specify only if `Enabled` is set to `True` .", "stability": "external", "summary": "If set to `true` , stack resources are retained when an account is removed from a target organization or OU." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 3446 }, "name": "retainStacksOnAccountRemoval", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } } ], "symbolId": "lib/cloudformation.generated:CfnStackSet.AutoDeploymentProperty" }, "@aws-cdk/aws-cloudformation.CfnStackSet.DeploymentTargetsProperty": { "assembly": "@aws-cdk/aws-cloudformation", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-deploymenttargets.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "The AWS OrganizationalUnitIds or Accounts for which to create stack instances in the specified Regions.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst deploymentTargetsProperty: cloudformation.CfnStackSet.DeploymentTargetsProperty = {\n accountFilterType: 'accountFilterType',\n accounts: ['accounts'],\n organizationalUnitIds: ['organizationalUnitIds'],\n};" }, "fqn": "@aws-cdk/aws-cloudformation.CfnStackSet.DeploymentTargetsProperty", "kind": "interface", "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 3510 }, "name": "DeploymentTargetsProperty", "namespace": "CfnStackSet", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-deploymenttargets.html#cfn-cloudformation-stackset-deploymenttargets-accountfiltertype" }, "remarks": "The following is a list of possible values for the `AccountFilterType` operation.\n\n- `INTERSECTION` : StackSets deploys to the accounts specified in `Accounts` parameter.\n- `DIFFERENCE` : StackSets excludes the accounts specified in `Accounts` parameter. This enables user to avoid certain accounts within an OU such as suspended accounts.\n- `UNION` : StackSets includes additional accounts deployment targets.\n\nThis is the default value if `AccountFilterType` is not provided. This enables user to update an entire OU and individual accounts from a different OU in one request, which used to be two separate requests.\n- `NONE` : Deploys to all the accounts in specified organizational units (OU).", "stability": "external", "summary": "Limit deployment targets to individual accounts or include additional accounts with provided OUs." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 3525 }, "name": "accountFilterType", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-deploymenttargets.html#cfn-cloudformation-stackset-deploymenttargets-accounts" }, "remarks": "*Pattern* : `^[0-9]{12}$`", "stability": "external", "summary": "The names of one or more AWS accounts for which you want to deploy stack set updates." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 3533 }, "name": "accounts", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-deploymenttargets.html#cfn-cloudformation-stackset-deploymenttargets-organizationalunitids" }, "remarks": "*Pattern* : `^(ou-[a-z0-9]{4,32}-[a-z0-9]{8,32}|r-[a-z0-9]{4,32})$`", "stability": "external", "summary": "The organization root ID or organizational unit (OU) IDs to which StackSets deploys." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 3541 }, "name": "organizationalUnitIds", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "lib/cloudformation.generated:CfnStackSet.DeploymentTargetsProperty" }, "@aws-cdk/aws-cloudformation.CfnStackSet.ManagedExecutionProperty": { "assembly": "@aws-cdk/aws-cloudformation", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-managedexecution.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst managedExecutionProperty: cloudformation.CfnStackSet.ManagedExecutionProperty = {\n active: false,\n};" }, "fqn": "@aws-cdk/aws-cloudformation.CfnStackSet.ManagedExecutionProperty", "kind": "interface", "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 3608 }, "name": "ManagedExecutionProperty", "namespace": "CfnStackSet", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-managedexecution.html#cfn-cloudformation-stackset-managedexecution-active" }, "remarks": "After conflicting operations finish, StackSets starts queued operations in request order.\n\n> If there are already running or queued operations, StackSets queues all incoming operations even if they are non-conflicting.\n>\n> You can't modify your stack set's execution configuration while there are running or queued operations for that stack set.\n\nWhen `false` (default), StackSets performs one operation at a time in request order.", "stability": "external", "summary": "When `true` , StackSets performs non-conflicting operations concurrently and queues conflicting operations." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 3620 }, "name": "active", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } } ], "symbolId": "lib/cloudformation.generated:CfnStackSet.ManagedExecutionProperty" }, "@aws-cdk/aws-cloudformation.CfnStackSet.OperationPreferencesProperty": { "assembly": "@aws-cdk/aws-cloudformation", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-operationpreferences.html", "exampleMetadata": "fixture=_generated" }, "remarks": "For more information on maximum concurrent accounts and failure tolerance, see [Stack set operation options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options) .", "stability": "external", "summary": "The user-specified preferences for how AWS CloudFormation performs a stack set operation.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst operationPreferencesProperty: cloudformation.CfnStackSet.OperationPreferencesProperty = {\n failureToleranceCount: 123,\n failureTolerancePercentage: 123,\n maxConcurrentCount: 123,\n maxConcurrentPercentage: 123,\n regionConcurrencyType: 'regionConcurrencyType',\n regionOrder: ['regionOrder'],\n};" }, "fqn": "@aws-cdk/aws-cloudformation.CfnStackSet.OperationPreferencesProperty", "kind": "interface", "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 3681 }, "name": "OperationPreferencesProperty", "namespace": "CfnStackSet", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-operationpreferences.html#cfn-cloudformation-stackset-operationpreferences-failuretolerancecount" }, "remarks": "If the operation is stopped in a Region, AWS CloudFormation doesn't attempt the operation in any subsequent Regions.\n\nConditional: You must specify either `FailureToleranceCount` or `FailureTolerancePercentage` (but not both).", "stability": "external", "summary": "The number of accounts, per Region, for which this operation can fail before AWS CloudFormation stops the operation in that Region." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 3689 }, "name": "failureToleranceCount", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-operationpreferences.html#cfn-cloudformation-stackset-operationpreferences-failuretolerancepercentage" }, "remarks": "If the operation is stopped in a Region, AWS CloudFormation doesn't attempt the operation in any subsequent Regions.\n\nWhen calculating the number of accounts based on the specified percentage, AWS CloudFormation rounds *down* to the next whole number.\n\nConditional: You must specify either `FailureToleranceCount` or `FailureTolerancePercentage` , but not both.", "stability": "external", "summary": "The percentage of accounts, per Region, for which this stack operation can fail before AWS CloudFormation stops the operation in that Region." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 3699 }, "name": "failureTolerancePercentage", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-operationpreferences.html#cfn-cloudformation-stackset-operationpreferences-maxconcurrentcount" }, "remarks": "This is dependent on the value of `FailureToleranceCount` . `MaxConcurrentCount` is at most one more than the `FailureToleranceCount` .\n\nNote that this setting lets you specify the *maximum* for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.\n\nConditional: You must specify either `MaxConcurrentCount` or `MaxConcurrentPercentage` , but not both.", "stability": "external", "summary": "The maximum number of accounts in which to perform this operation at one time." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 3709 }, "name": "maxConcurrentCount", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-operationpreferences.html#cfn-cloudformation-stackset-operationpreferences-maxconcurrentpercentage" }, "remarks": "When calculating the number of accounts based on the specified percentage, AWS CloudFormation rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, CloudFormation sets the number as one instead.\n\nNote that this setting lets you specify the *maximum* for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.\n\nConditional: You must specify either `MaxConcurrentCount` or `MaxConcurrentPercentage` , but not both.", "stability": "external", "summary": "The maximum percentage of accounts in which to perform this operation at one time." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 3721 }, "name": "maxConcurrentPercentage", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-operationpreferences.html#cfn-cloudformation-stackset-operationpreferences-regionconcurrencytype" }, "stability": "external", "summary": "The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 3727 }, "name": "regionConcurrencyType", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-operationpreferences.html#cfn-cloudformation-stackset-operationpreferences-regionorder" }, "stability": "external", "summary": "The order of the Regions where you want to perform the stack operation." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 3733 }, "name": "regionOrder", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "lib/cloudformation.generated:CfnStackSet.OperationPreferencesProperty" }, "@aws-cdk/aws-cloudformation.CfnStackSet.ParameterProperty": { "assembly": "@aws-cdk/aws-cloudformation", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-parameter.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "The Parameter data type.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst parameterProperty: cloudformation.CfnStackSet.ParameterProperty = {\n parameterKey: 'parameterKey',\n parameterValue: 'parameterValue',\n};" }, "fqn": "@aws-cdk/aws-cloudformation.CfnStackSet.ParameterProperty", "kind": "interface", "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 3809 }, "name": "ParameterProperty", "namespace": "CfnStackSet", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-parameter.html#cfn-cloudformation-stackset-parameter-parameterkey" }, "remarks": "If you don't specify a key and value for a particular parameter, AWS CloudFormation uses the default value that's specified in your template.", "stability": "external", "summary": "The key associated with the parameter." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 3815 }, "name": "parameterKey", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-parameter.html#cfn-cloudformation-stackset-parameter-parametervalue" }, "stability": "external", "summary": "The input value associated with the parameter." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 3821 }, "name": "parameterValue", "type": { "primitive": "string" } } ], "symbolId": "lib/cloudformation.generated:CfnStackSet.ParameterProperty" }, "@aws-cdk/aws-cloudformation.CfnStackSet.StackInstancesProperty": { "assembly": "@aws-cdk/aws-cloudformation", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-stackinstances.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Stack instances in some specific accounts and Regions.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst stackInstancesProperty: cloudformation.CfnStackSet.StackInstancesProperty = {\n deploymentTargets: {\n accountFilterType: 'accountFilterType',\n accounts: ['accounts'],\n organizationalUnitIds: ['organizationalUnitIds'],\n },\n regions: ['regions'],\n\n // the properties below are optional\n parameterOverrides: [{\n parameterKey: 'parameterKey',\n parameterValue: 'parameterValue',\n }],\n};" }, "fqn": "@aws-cdk/aws-cloudformation.CfnStackSet.StackInstancesProperty", "kind": "interface", "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 3887 }, "name": "StackInstancesProperty", "namespace": "CfnStackSet", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-stackinstances.html#cfn-cloudformation-stackset-stackinstances-deploymenttargets" }, "stability": "external", "summary": "The AWS `OrganizationalUnitIds` or `Accounts` for which to create stack instances in the specified Regions." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 3893 }, "name": "deploymentTargets", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-cloudformation.CfnStackSet.DeploymentTargetsProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-stackinstances.html#cfn-cloudformation-stackset-stackinstances-regions" }, "stability": "external", "summary": "The names of one or more Regions where you want to create stack instances using the specified AWS accounts ." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 3905 }, "name": "regions", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-stackinstances.html#cfn-cloudformation-stackset-stackinstances-parameteroverrides" }, "stability": "external", "summary": "A list of stack set parameters whose values you want to override in the selected stack instances." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 3899 }, "name": "parameterOverrides", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-cloudformation.CfnStackSet.ParameterProperty" } ] } }, "kind": "array" } } ] } } } ], "symbolId": "lib/cloudformation.generated:CfnStackSet.StackInstancesProperty" }, "@aws-cdk/aws-cloudformation.CfnStackSetProps": { "assembly": "@aws-cdk/aws-cloudformation", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnStackSet`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\n\ndeclare const managedExecution: any;\nconst cfnStackSetProps: cloudformation.CfnStackSetProps = {\n permissionModel: 'permissionModel',\n stackSetName: 'stackSetName',\n\n // the properties below are optional\n administrationRoleArn: 'administrationRoleArn',\n autoDeployment: {\n enabled: false,\n retainStacksOnAccountRemoval: false,\n },\n callAs: 'callAs',\n capabilities: ['capabilities'],\n description: 'description',\n executionRoleName: 'executionRoleName',\n managedExecution: managedExecution,\n operationPreferences: {\n failureToleranceCount: 123,\n failureTolerancePercentage: 123,\n maxConcurrentCount: 123,\n maxConcurrentPercentage: 123,\n regionConcurrencyType: 'regionConcurrencyType',\n regionOrder: ['regionOrder'],\n },\n parameters: [{\n parameterKey: 'parameterKey',\n parameterValue: 'parameterValue',\n }],\n stackInstancesGroup: [{\n deploymentTargets: {\n accountFilterType: 'accountFilterType',\n accounts: ['accounts'],\n organizationalUnitIds: ['organizationalUnitIds'],\n },\n regions: ['regions'],\n\n // the properties below are optional\n parameterOverrides: [{\n parameterKey: 'parameterKey',\n parameterValue: 'parameterValue',\n }],\n }],\n tags: [{\n key: 'key',\n value: 'value',\n }],\n templateBody: 'templateBody',\n templateUrl: 'templateUrl',\n};" }, "fqn": "@aws-cdk/aws-cloudformation.CfnStackSetProps", "kind": "interface", "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 2904 }, "name": "CfnStackSetProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-permissionmodel" }, "remarks": "- 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) .\n- 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) .", "stability": "external", "summary": "Describes how the IAM roles required for stack set operations are created." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 2914 }, "name": "permissionModel", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-stacksetname" }, "remarks": "The name must be unique in the Region where you create your stack set.\n\n*Maximum* : `128`\n\n*Pattern* : `^[a-zA-Z][a-zA-Z0-9-]{0,127}$`\n\n> The `StackSetName` property is required.", "stability": "external", "summary": "The name to associate with the stack set." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 2927 }, "name": "stackSetName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-administrationrolearn" }, "remarks": "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.\n\nUse 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* .\n\n*Minimum* : `20`\n\n*Maximum* : `2048`", "stability": "external", "summary": "The Amazon Resource Number (ARN) of the IAM role to use to create this stack set." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 2940 }, "name": "administrationRoleArn", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-autodeployment" }, "stability": "external", "summary": "[ `Service-managed` permissions] Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU)." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 2947 }, "name": "autoDeployment", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-cloudformation.CfnStackSet.AutoDeploymentProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-callas" }, "remarks": "By default, `SELF` is specified. Use `SELF` for stack sets with self-managed permissions.\n\n- To create a stack set with service-managed permissions while signed in to the management account, specify `SELF` .\n- To create a stack set with service-managed permissions while signed in to a delegated administrator account, specify `DELEGATED_ADMIN` .\n\nYour 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* .\n\nStack sets with service-managed permissions are created in the management account, including stack sets that are created by delegated administrators.\n\n*Valid Values* : `SELF` | `DELEGATED_ADMIN`", "stability": "external", "summary": "[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." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 2965 }, "name": "callAs", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-capabilities" }, "remarks": "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) .", "stability": "external", "summary": "The capabilities that are allowed in the stack set." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 2972 }, "name": "capabilities", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-description" }, "remarks": "*Minimum* : `1`\n\n*Maximum* : `1024`", "stability": "external", "summary": "A description of the stack set." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 2983 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-executionrolename" }, "remarks": "If you don't specify an execution role, AWS CloudFormation uses the `AWSCloudFormationStackSetExecutionRole` role for the stack set operation.\n\n*Minimum* : `1`\n\n*Maximum* : `64`\n\n*Pattern* : `[a-zA-Z_0-9+=,.@-]+`", "stability": "external", "summary": "The name of the IAM execution role to use to create the stack set." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 2996 }, "name": "executionRoleName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-managedexecution" }, "remarks": "When active, StackSets performs non-conflicting operations concurrently and queues conflicting operations. After conflicting operations finish, StackSets starts queued operations in request order.\n\n> If there are already running or queued operations, StackSets queues all incoming operations even if they are non-conflicting.\n>\n> You can't modify your stack set's execution configuration while there are running or queued operations for that stack set.\n\nWhen inactive (default), StackSets performs one operation at a time in request order.", "stability": "external", "summary": "Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 3011 }, "name": "managedExecution", "optional": true, "type": { "primitive": "any" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-operationpreferences" }, "stability": "external", "summary": "The user-specified preferences for how AWS CloudFormation performs a stack set operation." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 3018 }, "name": "operationPreferences", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-cloudformation.CfnStackSet.OperationPreferencesProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-parameters" }, "stability": "external", "summary": "The input parameters for the stack set template." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 3025 }, "name": "parameters", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-cloudformation.CfnStackSet.ParameterProperty" } ] } }, "kind": "array" } } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-stackinstancesgroup" }, "stability": "external", "summary": "A group of stack instances with parameters in some specific accounts and Regions." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 3032 }, "name": "stackInstancesGroup", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-cloudformation.CfnStackSet.StackInstancesProperty" } ] } }, "kind": "array" } } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-tags" }, "remarks": "AWS CloudFormation also propagates these tags to supported resources that are created in the stacks. A maximum number of 50 tags can be specified.", "stability": "external", "summary": "The key-value pairs to associate with this stack set and the stacks created from it." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 3039 }, "name": "tags", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/core.CfnTag" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-templatebody" }, "remarks": "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.\n\n*Minimum* : `1`\n\n*Maximum* : `51200`", "stability": "external", "summary": "The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 3052 }, "name": "templateBody", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-templateurl" }, "remarks": "The URL must point to a template (max size: 460,800 bytes) that's located in an Amazon S3 bucket.\n\nYou must include either `TemplateURL` or `TemplateBody` in a StackSet, but you can't use both.\n\n*Minimum* : `1`\n\n*Maximum* : `1024`", "stability": "external", "summary": "Location of file containing the template body." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 3065 }, "name": "templateUrl", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/cloudformation.generated:CfnStackSetProps" }, "@aws-cdk/aws-cloudformation.CfnTypeActivation": { "assembly": "@aws-cdk/aws-cloudformation", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::CloudFormation::TypeActivation", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html", "exampleMetadata": "fixture=_generated" }, "remarks": "Activates a public third-party extension, making it available for use in stack templates. For more information, see [Using public extensions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html) in the *AWS CloudFormation User Guide* .\n\nOnce you have activated a public third-party extension in your account and Region, use [SetTypeConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html) to specify configuration properties for the extension. For more information, see [Configuring extensions at the account level](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration) in the *CloudFormation User Guide* .", "stability": "external", "summary": "A CloudFormation `AWS::CloudFormation::TypeActivation`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst cfnTypeActivation = new cloudformation.CfnTypeActivation(this, 'MyCfnTypeActivation', /* all optional props */ {\n autoUpdate: false,\n executionRoleArn: 'executionRoleArn',\n loggingConfig: {\n logGroupName: 'logGroupName',\n logRoleArn: 'logRoleArn',\n },\n majorVersion: 'majorVersion',\n publicTypeArn: 'publicTypeArn',\n publisherId: 'publisherId',\n type: 'type',\n typeName: 'typeName',\n typeNameAlias: 'typeNameAlias',\n versionBump: 'versionBump',\n});" }, "fqn": "@aws-cdk/aws-cloudformation.CfnTypeActivation", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::CloudFormation::TypeActivation`." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 4272 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudformation.CfnTypeActivationProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 4147 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 4294 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 4314 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnTypeActivation", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 4151 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Arn" }, "stability": "external", "summary": "The Amazon Resource Number (ARN) of the activated extension, in this account and Region." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 4176 }, "name": "attrArn", "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 4299 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-autoupdate" }, "remarks": "Major versions released by the publisher must be manually updated.\n\nThe default is `true` .", "stability": "external", "summary": "Whether to automatically update the extension in this account and Region when a new *minor* version is published by the extension publisher." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 4185 }, "name": "autoUpdate", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-executionrolearn" }, "stability": "external", "summary": "The name of the IAM execution role to use to activate the extension." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 4192 }, "name": "executionRoleArn", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-loggingconfig" }, "stability": "external", "summary": "Specifies logging configuration information for an extension." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 4199 }, "name": "loggingConfig", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-cloudformation.CfnTypeActivation.LoggingConfigProperty" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-majorversion" }, "remarks": "The default is the latest major version. CloudFormation uses the latest available *minor* version of the major version selected.\n\nYou can specify `MajorVersion` or `VersionBump` , but not both.", "stability": "external", "summary": "The major version of this extension you want to activate, if multiple major versions are available." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 4208 }, "name": "majorVersion", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-publictypearn" }, "remarks": "Conditional: You must specify `PublicTypeArn` , or `TypeName` , `Type` , and `PublisherId` .", "stability": "external", "summary": "The Amazon Resource Number (ARN) of the public extension." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 4217 }, "name": "publicTypeArn", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-publisherid" }, "remarks": "Conditional: You must specify `PublicTypeArn` , or `TypeName` , `Type` , and `PublisherId` .", "stability": "external", "summary": "The ID of the extension publisher." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 4226 }, "name": "publisherId", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-type" }, "remarks": "Conditional: You must specify `PublicTypeArn` , or `TypeName` , `Type` , and `PublisherId` .", "stability": "external", "summary": "The extension type." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 4235 }, "name": "type", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-typename" }, "remarks": "Conditional: You must specify `PublicTypeArn` , or `TypeName` , `Type` , and `PublisherId` .", "stability": "external", "summary": "The name of the extension." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 4244 }, "name": "typeName", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-typenamealias" }, "remarks": "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.\n\nAn 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.", "stability": "external", "summary": "An alias to assign to the public extension, in this account and Region." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 4253 }, "name": "typeNameAlias", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-versionbump" }, "remarks": "You can also use this parameter to update the value of `AutoUpdate` .\n\n- `MAJOR` : CloudFormation updates the extension to the newest major version, if one is available.\n- `MINOR` : CloudFormation updates the extension to the newest minor version, if one is available.", "stability": "external", "summary": "Manually updates a previously-activated type to a new major or minor version, if available." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 4263 }, "name": "versionBump", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/cloudformation.generated:CfnTypeActivation" }, "@aws-cdk/aws-cloudformation.CfnTypeActivation.LoggingConfigProperty": { "assembly": "@aws-cdk/aws-cloudformation", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-typeactivation-loggingconfig.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Contains logging configuration information for an extension.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst loggingConfigProperty: cloudformation.CfnTypeActivation.LoggingConfigProperty = {\n logGroupName: 'logGroupName',\n logRoleArn: 'logRoleArn',\n};" }, "fqn": "@aws-cdk/aws-cloudformation.CfnTypeActivation.LoggingConfigProperty", "kind": "interface", "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 4328 }, "name": "LoggingConfigProperty", "namespace": "CfnTypeActivation", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-typeactivation-loggingconfig.html#cfn-cloudformation-typeactivation-loggingconfig-loggroupname" }, "stability": "external", "summary": "The Amazon CloudWatch Logs group to which CloudFormation sends error logging information when invoking the extension's handlers." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 4334 }, "name": "logGroupName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-typeactivation-loggingconfig.html#cfn-cloudformation-typeactivation-loggingconfig-logrolearn" }, "stability": "external", "summary": "The Amazon Resource Name (ARN) of the role that CloudFormation should assume when sending log entries to CloudWatch Logs." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 4340 }, "name": "logRoleArn", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/cloudformation.generated:CfnTypeActivation.LoggingConfigProperty" }, "@aws-cdk/aws-cloudformation.CfnTypeActivationProps": { "assembly": "@aws-cdk/aws-cloudformation", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnTypeActivation`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst cfnTypeActivationProps: cloudformation.CfnTypeActivationProps = {\n autoUpdate: false,\n executionRoleArn: 'executionRoleArn',\n loggingConfig: {\n logGroupName: 'logGroupName',\n logRoleArn: 'logRoleArn',\n },\n majorVersion: 'majorVersion',\n publicTypeArn: 'publicTypeArn',\n publisherId: 'publisherId',\n type: 'type',\n typeName: 'typeName',\n typeNameAlias: 'typeNameAlias',\n versionBump: 'versionBump',\n};" }, "fqn": "@aws-cdk/aws-cloudformation.CfnTypeActivationProps", "kind": "interface", "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 3973 }, "name": "CfnTypeActivationProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-autoupdate" }, "remarks": "Major versions released by the publisher must be manually updated.\n\nThe default is `true` .", "stability": "external", "summary": "Whether to automatically update the extension in this account and Region when a new *minor* version is published by the extension publisher." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 3982 }, "name": "autoUpdate", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-executionrolearn" }, "stability": "external", "summary": "The name of the IAM execution role to use to activate the extension." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 3989 }, "name": "executionRoleArn", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-loggingconfig" }, "stability": "external", "summary": "Specifies logging configuration information for an extension." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 3996 }, "name": "loggingConfig", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-cloudformation.CfnTypeActivation.LoggingConfigProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-majorversion" }, "remarks": "The default is the latest major version. CloudFormation uses the latest available *minor* version of the major version selected.\n\nYou can specify `MajorVersion` or `VersionBump` , but not both.", "stability": "external", "summary": "The major version of this extension you want to activate, if multiple major versions are available." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 4005 }, "name": "majorVersion", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-publictypearn" }, "remarks": "Conditional: You must specify `PublicTypeArn` , or `TypeName` , `Type` , and `PublisherId` .", "stability": "external", "summary": "The Amazon Resource Number (ARN) of the public extension." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 4014 }, "name": "publicTypeArn", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-publisherid" }, "remarks": "Conditional: You must specify `PublicTypeArn` , or `TypeName` , `Type` , and `PublisherId` .", "stability": "external", "summary": "The ID of the extension publisher." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 4023 }, "name": "publisherId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-type" }, "remarks": "Conditional: You must specify `PublicTypeArn` , or `TypeName` , `Type` , and `PublisherId` .", "stability": "external", "summary": "The extension type." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 4032 }, "name": "type", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-typename" }, "remarks": "Conditional: You must specify `PublicTypeArn` , or `TypeName` , `Type` , and `PublisherId` .", "stability": "external", "summary": "The name of the extension." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 4041 }, "name": "typeName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-typenamealias" }, "remarks": "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.\n\nAn 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.", "stability": "external", "summary": "An alias to assign to the public extension, in this account and Region." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 4050 }, "name": "typeNameAlias", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-versionbump" }, "remarks": "You can also use this parameter to update the value of `AutoUpdate` .\n\n- `MAJOR` : CloudFormation updates the extension to the newest major version, if one is available.\n- `MINOR` : CloudFormation updates the extension to the newest minor version, if one is available.", "stability": "external", "summary": "Manually updates a previously-activated type to a new major or minor version, if available." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 4060 }, "name": "versionBump", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/cloudformation.generated:CfnTypeActivationProps" }, "@aws-cdk/aws-cloudformation.CfnWaitCondition": { "assembly": "@aws-cdk/aws-cloudformation", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::CloudFormation::WaitCondition", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waitcondition.html", "exampleMetadata": "fixture=_generated" }, "remarks": "> For Amazon EC2 and Auto Scaling resources, we recommend that you use a `CreationPolicy` attribute instead of wait conditions. Add a CreationPolicy attribute to those resources, and use the cfn-signal helper script to signal when an instance creation process has completed successfully.\n\nYou can use a wait condition for situations like the following:\n\n- To coordinate stack resource creation with configuration actions that are external to the stack creation.\n- To track the status of a configuration process.\n\nFor these situations, we recommend that you associate a [CreationPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-creationpolicy.html) attribute with the wait condition so that you don't have to use a wait condition handle. For more information and an example, see [Creating wait conditions in a template](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-waitcondition.html) . If you use a CreationPolicy with a wait condition, don't specify any of the wait condition's properties.\n\n> If you use the [VPC endpoints](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-endpoints.html) feature, resources in the VPC that respond to wait conditions must have access to CloudFormation , specific Amazon Simple Storage Service ( Amazon S3 ) buckets. Resources must send wait condition responses to a presigned Amazon S3 URL. If they can't send responses to Amazon S3 , CloudFormation won't receive a response and the stack operation fails. For more information, see [Setting up VPC endpoints for AWS CloudFormation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-vpce-bucketnames.html) .", "stability": "external", "summary": "A CloudFormation `AWS::CloudFormation::WaitCondition`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst cfnWaitCondition = new cloudformation.CfnWaitCondition(this, 'MyCfnWaitCondition', /* all optional props */ {\n count: 123,\n handle: 'handle',\n timeout: 'timeout',\n});" }, "fqn": "@aws-cdk/aws-cloudformation.CfnWaitCondition", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::CloudFormation::WaitCondition`." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 4576 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudformation.CfnWaitConditionProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 4505 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 4591 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 4604 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnWaitCondition", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 4509 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Data" }, "remarks": "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) .\n\nExample return value for a wait condition with 2 signals:\n\n`{ \"Signal1\" : \"Step 1 complete.\" , \"Signal2\" : \"Step 2 complete.\" }`", "stability": "external", "summary": "A JSON object that contains the `UniqueId` and `Data` values from the wait condition signal(s) for the specified wait condition." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 4538 }, "name": "attrData", "type": { "fqn": "@aws-cdk/core.IResolvable" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 4596 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waitcondition.html#cfn-waitcondition-count" }, "remarks": "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.\n\nUpdates aren't supported.", "stability": "external", "summary": "The number of success signals that CloudFormation must receive before it continues the stack creation process." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 4547 }, "name": "count", "optional": true, "type": { "primitive": "number" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waitcondition.html#cfn-waitcondition-handle" }, "remarks": "Use the `Ref` intrinsic function to specify an [`AWS::CloudFormation::WaitConditionHandle`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waitconditionhandle.html) resource.\n\nAnytime 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.\n\nUpdates aren't supported.", "stability": "external", "summary": "A reference to the wait condition handle used to signal this wait condition." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 4558 }, "name": "handle", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waitcondition.html#cfn-waitcondition-timeout" }, "remarks": "`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).\n\nUpdates aren't supported.", "stability": "external", "summary": "The length of time (in seconds) to wait for the number of signals that the `Count` property specifies." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 4567 }, "name": "timeout", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/cloudformation.generated:CfnWaitCondition" }, "@aws-cdk/aws-cloudformation.CfnWaitConditionHandle": { "assembly": "@aws-cdk/aws-cloudformation", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::CloudFormation::WaitConditionHandle", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waitconditionhandle.html", "exampleMetadata": "fixture=_generated" }, "remarks": "> For Amazon EC2 and Auto Scaling resources, we recommend that you use a `CreationPolicy` attribute instead of wait conditions. Add a `CreationPolicy` attribute to those resources, and use the cfn-signal helper script to signal when an instance creation process has completed successfully.\n>\n> For more information, see [Deploying applications on Amazon EC2 with AWS CloudFormation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/deploying.applications.html) .\n\nThe `AWS::CloudFormation::WaitConditionHandle` type has no properties. When you reference the `WaitConditionHandle` resource by using the `Ref` function, AWS CloudFormation returns a presigned URL. You pass this URL to applications or scripts that are running on your Amazon EC2 instances to send signals to that URL. An associated `AWS::CloudFormation::WaitCondition` resource checks the URL for the required number of success signals or for a failure signal.\n\n> Anytime you add a `WaitCondition` resource during a stack update or update a resource with a wait condition, you must associate the wait condition with a new `WaitConditionHandle` resource. Don't reuse an old wait condition handle that has already been defined in the template. If you reuse a wait condition handle, the wait condition might evaluate old signals from a previous create or update stack command. > Updates aren't supported for this resource.", "stability": "external", "summary": "A CloudFormation `AWS::CloudFormation::WaitConditionHandle`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst cfnWaitConditionHandle = new cloudformation.CfnWaitConditionHandle(this, 'MyCfnWaitConditionHandle');" }, "fqn": "@aws-cdk/aws-cloudformation.CfnWaitConditionHandle", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::CloudFormation::WaitConditionHandle`." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 4652 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 4625 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 4662 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] } ], "name": "CfnWaitConditionHandle", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 4629 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } } ], "symbolId": "lib/cloudformation.generated:CfnWaitConditionHandle" }, "@aws-cdk/aws-cloudformation.CfnWaitConditionProps": { "assembly": "@aws-cdk/aws-cloudformation", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waitcondition.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnWaitCondition`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst cfnWaitConditionProps: cloudformation.CfnWaitConditionProps = {\n count: 123,\n handle: 'handle',\n timeout: 'timeout',\n};" }, "fqn": "@aws-cdk/aws-cloudformation.CfnWaitConditionProps", "kind": "interface", "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 4403 }, "name": "CfnWaitConditionProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waitcondition.html#cfn-waitcondition-count" }, "remarks": "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.\n\nUpdates aren't supported.", "stability": "external", "summary": "The number of success signals that CloudFormation must receive before it continues the stack creation process." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 4412 }, "name": "count", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waitcondition.html#cfn-waitcondition-handle" }, "remarks": "Use the `Ref` intrinsic function to specify an [`AWS::CloudFormation::WaitConditionHandle`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waitconditionhandle.html) resource.\n\nAnytime 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.\n\nUpdates aren't supported.", "stability": "external", "summary": "A reference to the wait condition handle used to signal this wait condition." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 4423 }, "name": "handle", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waitcondition.html#cfn-waitcondition-timeout" }, "remarks": "`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).\n\nUpdates aren't supported.", "stability": "external", "summary": "The length of time (in seconds) to wait for the number of signals that the `Count` property specifies." }, "immutable": true, "locationInModule": { "filename": "lib/cloudformation.generated.ts", "line": 4432 }, "name": "timeout", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/cloudformation.generated:CfnWaitConditionProps" }, "@aws-cdk/aws-cloudformation.CloudFormationCapabilities": { "assembly": "@aws-cdk/aws-cloudformation", "docs": { "deprecated": "use `core.CfnCapabilities`", "stability": "deprecated", "summary": "Capabilities that affect whether CloudFormation is allowed to change IAM resources." }, "fqn": "@aws-cdk/aws-cloudformation.CloudFormationCapabilities", "kind": "enum", "locationInModule": { "filename": "lib/cloud-formation-capabilities.ts", "line": 5 }, "members": [ { "docs": { "custom": { "link": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities" }, "remarks": "Pass this capability if you wish to block the creation IAM resources.", "stability": "deprecated", "summary": "No IAM Capabilities." }, "name": "NONE" }, { "docs": { "custom": { "link": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities" }, "remarks": "Pass this capability if you're only creating anonymous resources.", "stability": "deprecated", "summary": "Capability to create anonymous IAM resources." }, "name": "ANONYMOUS_IAM" }, { "docs": { "custom": { "link": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities" }, "remarks": "Pass this capability if you're creating IAM resources that have physical\nnames.\n\n`CloudFormationCapabilities.NamedIAM` implies `CloudFormationCapabilities.IAM`; you don't have to pass both.", "stability": "deprecated", "summary": "Capability to create named IAM resources." }, "name": "NAMED_IAM" }, { "docs": { "custom": { "link": "https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateStack.html" }, "remarks": "Pass this capability if your template includes macros, for example AWS::Include or AWS::Serverless.", "stability": "deprecated", "summary": "Capability to run CloudFormation macros." }, "name": "AUTO_EXPAND" } ], "name": "CloudFormationCapabilities", "symbolId": "lib/cloud-formation-capabilities:CloudFormationCapabilities" }, "@aws-cdk/aws-cloudformation.CustomResource": { "assembly": "@aws-cdk/aws-cloudformation", "base": "@aws-cdk/core.CustomResource", "docs": { "deprecated": "use `core.CustomResource`", "stability": "deprecated", "summary": "Deprecated.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const customResourceProvider: cloudformation.CustomResourceProvider;\ndeclare const properties: any;\nconst customResource = new cloudformation.CustomResource(this, 'MyCustomResource', {\n provider: customResourceProvider,\n\n // the properties below are optional\n properties: {\n propertiesKey: properties,\n },\n removalPolicy: cdk.RemovalPolicy.DESTROY,\n resourceType: 'resourceType',\n});", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-cloudformation.CustomResource", "initializer": { "docs": { "stability": "deprecated" }, "locationInModule": { "filename": "lib/custom-resource.ts", "line": 178 }, "parameters": [ { "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-cloudformation.CustomResourceProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/custom-resource.ts", "line": 177 }, "name": "CustomResource", "symbolId": "lib/custom-resource:CustomResource" }, "@aws-cdk/aws-cloudformation.CustomResourceProps": { "assembly": "@aws-cdk/aws-cloudformation", "datatype": true, "docs": { "deprecated": "use `core.CustomResourceProps`", "stability": "deprecated", "summary": "Properties to provide a Lambda-backed custom resource.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const customResourceProvider: cloudformation.CustomResourceProvider;\ndeclare const properties: any;\nconst customResourceProps: cloudformation.CustomResourceProps = {\n provider: customResourceProvider,\n\n // the properties below are optional\n properties: {\n propertiesKey: properties,\n },\n removalPolicy: cdk.RemovalPolicy.DESTROY,\n resourceType: 'resourceType',\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-cloudformation.CustomResourceProps", "kind": "interface", "locationInModule": { "filename": "lib/custom-resource.ts", "line": 90 }, "name": "CustomResourceProps", "properties": [ { "abstract": true, "docs": { "remarks": "You can implement a provider by listening to raw AWS CloudFormation events\nthrough an SNS topic or an AWS Lambda function or use the CDK's custom\n[resource provider framework] which makes it easier to implement robust\nproviders.\n\n[resource provider framework]: https://docs.aws.amazon.com/cdk/api/latest/docs/custom-resources-readme.html\n\n```ts\nimport * as custom_resources from '@aws-cdk/custom-resources';\nimport * as lambda from '@aws-cdk/aws-lambda';\nimport { Stack } from '@aws-cdk/core';\ndeclare const myOnEventLambda: lambda.Function;\ndeclare const myIsCompleteLambda: lambda.Function;\nconst stack = new Stack();\n\nconst provider = new custom_resources.Provider(stack, 'myProvider', {\n onEventHandler: myOnEventLambda,\n isCompleteHandler: myIsCompleteLambda, // optional\n});\n```\n\n```ts\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nimport * as lambda from '@aws-cdk/aws-lambda';\ndeclare const myFunction: lambda.Function;\n\n// invoke an AWS Lambda function when a lifecycle event occurs:\nconst provider = cloudformation.CustomResourceProvider.fromLambda(myFunction);\n```\n\n```ts\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nimport * as sns from '@aws-cdk/aws-sns';\ndeclare const myTopic: sns.Topic;\n\n// publish lifecycle events to an SNS topic:\nconst provider = cloudformation.CustomResourceProvider.fromTopic(myTopic);\n```", "stability": "deprecated", "summary": "The provider which implements the custom resource." }, "immutable": true, "locationInModule": { "filename": "lib/custom-resource.ts", "line": 133 }, "name": "provider", "type": { "fqn": "@aws-cdk/aws-cloudformation.ICustomResourceProvider" } }, { "abstract": true, "docs": { "default": "- No properties.", "stability": "deprecated", "summary": "Properties to pass to the Lambda." }, "immutable": true, "locationInModule": { "filename": "lib/custom-resource.ts", "line": 140 }, "name": "properties", "optional": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "cdk.RemovalPolicy.Destroy", "stability": "deprecated", "summary": "The policy to apply when this resource is removed from the application." }, "immutable": true, "locationInModule": { "filename": "lib/custom-resource.ts", "line": 170 }, "name": "removalPolicy", "optional": true, "type": { "fqn": "@aws-cdk/core.RemovalPolicy" } }, { "abstract": true, "docs": { "default": "- AWS::CloudFormation::CustomResource", "remarks": "For example, you can use \"Custom::MyCustomResourceTypeName\".\n\nCustom resource type names must begin with \"Custom::\" and can include\nalphanumeric characters and the following characters: _@-. You can specify\na custom resource type name up to a maximum length of 60 characters. You\ncannot change the type during an update.\n\nUsing your own resource type names helps you quickly differentiate the\ntypes of custom resources in your stack. For example, if you had two custom\nresources that conduct two different ping tests, you could name their type\nas Custom::PingTester to make them easily identifiable as ping testers\n(instead of using AWS::CloudFormation::CustomResource).", "see": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cfn-customresource.html#aws-cfn-resource-type-name", "stability": "deprecated", "summary": "For custom resources, you can specify AWS::CloudFormation::CustomResource (the default) as the resource type, or you can specify your own resource type name." }, "immutable": true, "locationInModule": { "filename": "lib/custom-resource.ts", "line": 163 }, "name": "resourceType", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/custom-resource:CustomResourceProps" }, "@aws-cdk/aws-cloudformation.CustomResourceProvider": { "assembly": "@aws-cdk/aws-cloudformation", "docs": { "deprecated": "use core.CustomResource instead", "stability": "deprecated", "summary": "Represents a provider for an AWS CloudFormation custom resources.", "example": "import * as cloudformation from '@aws-cdk/aws-cloudformation';\nimport * as lambda from '@aws-cdk/aws-lambda';\ndeclare const myFunction: lambda.Function;\n\n// invoke an AWS Lambda function when a lifecycle event occurs:\nconst provider = cloudformation.CustomResourceProvider.fromLambda(myFunction);", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-cloudformation.CustomResourceProvider", "interfaces": [ "@aws-cdk/aws-cloudformation.ICustomResourceProvider" ], "kind": "class", "locationInModule": { "filename": "lib/custom-resource.ts", "line": 47 }, "methods": [ { "docs": { "remarks": "We recommend using a lambda.SingletonFunction for this.", "stability": "deprecated", "summary": "The Lambda provider that implements this custom resource." }, "locationInModule": { "filename": "lib/custom-resource.ts", "line": 53 }, "name": "fromLambda", "parameters": [ { "name": "handler", "type": { "fqn": "@aws-cdk/aws-lambda.IFunction" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudformation.CustomResourceProvider" } }, "static": true }, { "docs": { "stability": "deprecated", "summary": "The SNS Topic for the provider that implements this custom resource." }, "locationInModule": { "filename": "lib/custom-resource.ts", "line": 60 }, "name": "fromTopic", "parameters": [ { "name": "topic", "type": { "fqn": "@aws-cdk/aws-sns.ITopic" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudformation.CustomResourceProvider" } }, "static": true }, { "docs": { "deprecated": "use `fromLambda`", "stability": "deprecated", "summary": "Use AWS Lambda as a provider." }, "locationInModule": { "filename": "lib/custom-resource.ts", "line": 68 }, "name": "lambda", "parameters": [ { "name": "handler", "type": { "fqn": "@aws-cdk/aws-lambda.IFunction" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudformation.CustomResourceProvider" } }, "static": true }, { "docs": { "deprecated": "use `fromTopic`", "stability": "deprecated", "summary": "Use an SNS topic as the provider." }, "locationInModule": { "filename": "lib/custom-resource.ts", "line": 74 }, "name": "topic", "parameters": [ { "name": "topic", "type": { "fqn": "@aws-cdk/aws-sns.ITopic" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudformation.CustomResourceProvider" } }, "static": true }, { "docs": { "stability": "deprecated", "summary": "Called when this provider is used by a `CustomResource`." }, "locationInModule": { "filename": "lib/custom-resource.ts", "line": 81 }, "name": "bind", "overrides": "@aws-cdk/aws-cloudformation.ICustomResourceProvider", "parameters": [ { "name": "_", "type": { "fqn": "@aws-cdk/core.Construct" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudformation.CustomResourceProviderConfig" } } } ], "name": "CustomResourceProvider", "properties": [ { "docs": { "stability": "deprecated", "summary": "the ServiceToken which contains the ARN for this provider." }, "immutable": true, "locationInModule": { "filename": "lib/custom-resource.ts", "line": 79 }, "name": "serviceToken", "type": { "primitive": "string" } } ], "symbolId": "lib/custom-resource:CustomResourceProvider" }, "@aws-cdk/aws-cloudformation.CustomResourceProviderConfig": { "assembly": "@aws-cdk/aws-cloudformation", "datatype": true, "docs": { "deprecated": "used in {@link ICustomResourceProvider} which is now deprecated", "stability": "deprecated", "summary": "Configuration options for custom resource providers.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudformation from '@aws-cdk/aws-cloudformation';\nconst customResourceProviderConfig: cloudformation.CustomResourceProviderConfig = {\n serviceToken: 'serviceToken',\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-cloudformation.CustomResourceProviderConfig", "kind": "interface", "locationInModule": { "filename": "lib/custom-resource.ts", "line": 21 }, "name": "CustomResourceProviderConfig", "properties": [ { "abstract": true, "docs": { "stability": "deprecated", "summary": "The ARN of the SNS topic or the AWS Lambda function which implements this provider." }, "immutable": true, "locationInModule": { "filename": "lib/custom-resource.ts", "line": 26 }, "name": "serviceToken", "type": { "primitive": "string" } } ], "symbolId": "lib/custom-resource:CustomResourceProviderConfig" }, "@aws-cdk/aws-cloudformation.ICustomResourceProvider": { "assembly": "@aws-cdk/aws-cloudformation", "docs": { "deprecated": "use `core.ICustomResourceProvider`", "stability": "deprecated", "summary": "Represents a provider for an AWS CloudFormation custom resources." }, "fqn": "@aws-cdk/aws-cloudformation.ICustomResourceProvider", "kind": "interface", "locationInModule": { "filename": "lib/custom-resource.ts", "line": 33 }, "methods": [ { "abstract": true, "docs": { "returns": "provider configuration", "stability": "deprecated", "summary": "Called when this provider is used by a `CustomResource`." }, "locationInModule": { "filename": "lib/custom-resource.ts", "line": 39 }, "name": "bind", "parameters": [ { "docs": { "summary": "The resource that uses this provider." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudformation.CustomResourceProviderConfig" } } } ], "name": "ICustomResourceProvider", "symbolId": "lib/custom-resource:ICustomResourceProvider" }, "@aws-cdk/aws-cloudformation.NestedStack": { "assembly": "@aws-cdk/aws-cloudformation", "base": "@aws-cdk/core.NestedStack", "docs": { "deprecated": "use core.NestedStack instead", "remarks": "When you apply template changes to update a top-level stack, CloudFormation\nupdates the top-level stack and initiates an update to its nested stacks.\nCloudFormation updates the resources of modified nested stacks, but does not\nupdate the resources of unmodified nested stacks.\n\nFurthermore, this stack will not be treated as an independent deployment\nartifact (won't be listed in \"cdk list\" or deployable through \"cdk deploy\"),\nbut rather only synthesized as a template and uploaded as an asset to S3.\n\nCross references of resource attributes between the parent stack and the\nnested stack will automatically be translated to stack parameters and\noutputs.", "stability": "deprecated", "summary": "A CloudFormation nested stack.", "example": "class MyNestedStack extends cfn.NestedStack {\n constructor(scope: Construct, id: string, props?: cfn.NestedStackProps) {\n super(scope, id, props);\n\n new s3.Bucket(this, 'NestedBucket');\n }\n}\n\nclass MyParentStack extends Stack {\n constructor(scope: Construct, id: string, props?: StackProps) {\n super(scope, id, props);\n\n new MyNestedStack(this, 'Nested1');\n new MyNestedStack(this, 'Nested2');\n }\n}", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-cloudformation.NestedStack", "initializer": { "docs": { "stability": "deprecated" }, "locationInModule": { "filename": "lib/nested-stack.ts", "line": 70 }, "parameters": [ { "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudformation.NestedStackProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/nested-stack.ts", "line": 69 }, "name": "NestedStack", "symbolId": "lib/nested-stack:NestedStack" }, "@aws-cdk/aws-cloudformation.NestedStackProps": { "assembly": "@aws-cdk/aws-cloudformation", "datatype": true, "docs": { "deprecated": "use core.NestedStackProps instead", "stability": "deprecated", "summary": "Initialization props for the `NestedStack` construct.", "example": "class MyNestedStack extends cfn.NestedStack {\n constructor(scope: Construct, id: string, props?: cfn.NestedStackProps) {\n super(scope, id, props);\n\n new s3.Bucket(this, 'NestedBucket');\n }\n}\n\nclass MyParentStack extends Stack {\n constructor(scope: Construct, id: string, props?: StackProps) {\n super(scope, id, props);\n\n new MyNestedStack(this, 'Nested1');\n new MyNestedStack(this, 'Nested2');\n }\n}", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-cloudformation.NestedStackProps", "kind": "interface", "locationInModule": { "filename": "lib/nested-stack.ts", "line": 13 }, "name": "NestedStackProps", "properties": [ { "abstract": true, "docs": { "default": "- notifications are not sent for this stack.", "stability": "deprecated", "summary": "The Simple Notification Service (SNS) topics to publish stack related events." }, "immutable": true, "locationInModule": { "filename": "lib/nested-stack.ts", "line": 48 }, "name": "notifications", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-sns.ITopic" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- no user-defined parameters are passed to the nested stack", "remarks": "Each parameter has a name corresponding\nto a parameter defined in the embedded template and a value representing\nthe value that you want to set for the parameter.\n\nThe nested stack construct will automatically synthesize parameters in order\nto bind references from the parent stack(s) into the nested stack.", "stability": "deprecated", "summary": "The set value pairs that represent the parameters passed to CloudFormation when this nested stack is created." }, "immutable": true, "locationInModule": { "filename": "lib/nested-stack.ts", "line": 25 }, "name": "parameters", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "- no timeout", "remarks": "When CloudFormation detects that the nested stack has reached the\nCREATE_COMPLETE state, it marks the nested stack resource as\nCREATE_COMPLETE in the parent stack and resumes creating the parent stack.\nIf the timeout period expires before the nested stack reaches\nCREATE_COMPLETE, CloudFormation marks the nested stack as failed and rolls\nback both the nested stack and parent stack.", "stability": "deprecated", "summary": "The length of time that CloudFormation waits for the nested stack to reach the CREATE_COMPLETE state." }, "immutable": true, "locationInModule": { "filename": "lib/nested-stack.ts", "line": 40 }, "name": "timeout", "optional": true, "type": { "fqn": "@aws-cdk/core.Duration" } } ], "symbolId": "lib/nested-stack:NestedStackProps" } }, "version": "1.204.0", "fingerprint": "**********" }