{ "author": { "name": "Amazon Web Services", "organization": true, "roles": [ "author" ], "url": "https://aws.amazon.com" }, "bundled": { "@aws-cdk/cloud-assembly-api": "^2.2.0", "semver": "^7.7.4" }, "dependencies": { "@aws-cdk/cloud-assembly-schema": ">=53.0.0" }, "dependencyClosure": { "@aws-cdk/cloud-assembly-schema": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/main/logo/default-256-dark.png", "namespace": "Amazon.CDK.CloudAssembly.Schema", "packageId": "Amazon.CDK.CloudAssembly.Schema" }, "go": { "moduleName": "github.com/cdklabs/cloud-assembly-schema-go" }, "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 :: 2" ], "distName": "aws-cdk.cloud-assembly-schema", "module": "aws_cdk.cloud_assembly_schema" } } } }, "description": "Cloud executable protocol", "docs": { "stability": "stable" }, "homepage": "https://github.com/aws/aws-cdk", "jsiiVersion": "5.9.37 (build 5176c0d)", "keywords": [ "aws", "cdk" ], "license": "Apache-2.0", "metadata": { "jsii": { "compiledWithDeprecationWarnings": true, "pacmak": { "hasDefaultInterfaces": true }, "rosetta": { "strict": false } } }, "name": "@aws-cdk/cx-api", "readme": { "markdown": "# Cloud Executable API\n\nThis module is part of the [AWS Cloud Development Kit](https://github.com/aws/aws-cdk) project.\n\n## V2 Feature Flags\n\n* `@aws-cdk/aws-s3:createDefaultLoggingPolicy`\n\nEnable this feature flag to create an S3 bucket policy by default in cases where\nan AWS service would automatically create the Policy if one does not exist.\n\nFor example, in order to send VPC flow logs to an S3 bucket, there is a specific Bucket Policy\nthat needs to be attached to the bucket. If you create the bucket without a policy and then add the\nbucket as the flow log destination, the service will automatically create the bucket policy with the\nnecessary permissions. If you were to then try and add your own bucket policy CloudFormation will throw\nand error indicating that a bucket policy already exists.\n\nIn cases where we know what the required policy is we can go ahead and create the policy so we can\nremain in control of it.\n\n\n\n_cdk.json_\n\n```json\n{\n \"context\": {\n \"@aws-cdk/aws-s3:createDefaultLoggingPolicy\": true\n }\n}\n```\n\n* `@aws-cdk/aws-sns-subscriptions:restrictSqsDescryption`\n\nEnable this feature flag to restrict the decryption of a SQS queue, which is subscribed to a SNS topic, to\nonly the topic which it is subscribed to and not the whole SNS service of an account.\n\nPreviously the decryption was only restricted to the SNS service principal. To make the SQS subscription more\nsecure, it is a good practice to restrict the decryption further and only allow the connected SNS topic to decryption\nthe subscribed queue.\n\n_cdk.json_\n\n```json\n{\n \"context\": {\n \"@aws-cdk/aws-sns-subscriptions:restrictSqsDescryption\": true\n }\n}\n```\n\n* @aws-cdk/aws-apigateway:disableCloudWatchRole\n\nEnable this feature flag to change the default behavior for aws-apigateway.RestApi and aws-apigateway.SpecRestApi\nto _not_ create a CloudWatch role and Account. There is only a single ApiGateway account per AWS\nenvironment which means that each time you create a RestApi in your account the ApiGateway account\nis overwritten. If at some point the newest RestApi is deleted, the ApiGateway Account and CloudWatch\nrole will also be deleted, breaking any existing ApiGateways that were depending on them.\n\nWhen this flag is enabled you should either create the ApiGateway account and CloudWatch role\nseparately _or_ only enable the cloudWatchRole on a single RestApi.\n\n_cdk.json_\n\n```json\n{\n \"context\": {\n \"@aws-cdk/aws-apigateway:disableCloudWatchRole\": true\n }\n}\n```\n\n* `@aws-cdk/core:enablePartitionLiterals`\n\nEnable this feature flag to have `Stack.partition` return a literal string for a stack's partition\nwhen the stack has a known region configured. If the region is undefined, or set to an unknown value, the\n`Stack.partition` will be the CloudFormation intrinsic value `AWS::Partition`. Without this feature flag,\n`Stack.partition` always returns the CloudFormation intrinsic value `AWS::Partition`.\n\nThis feature will often simplify ARN strings in CDK generated templates, for example:\n\n```yaml\n Principal:\n AWS:\n Fn::Join:\n - \"\"\n - - \"arn:\"\n - Ref: AWS::Partition\n - :iam::123456789876:root\n```\n\nbecomes:\n\n```yaml\n Principal:\n AWS: \"arn:aws:iam::123456789876:root\"\n```\n\n* `@aws-cdk/aws-ecs:disableExplicitDeploymentControllerForCircuitBreaker`\n\nEnable this feature flag to avoid setting the \"ECS\" deployment controller when adding a circuit breaker to an\nECS Service, as this will trigger a full replacement which fails to deploy when using set service names.\nThis does not change any behaviour as the default deployment controller when it is not defined is ECS.\n\n_cdk.json_\n\n```json\n{\n \"context\": {\n \"@aws-cdk/aws-ecs:disableExplicitDeploymentControllerForCircuitBreaker\": true\n }\n}\n```\n\n* `@aws-cdk/aws-s3:serverAccessLogsUseBucketPolicy`\n\nEnable this feature flag to use S3 Bucket Policy for granting permission fo Server Access Logging\nrather than using the canned \\`LogDeliveryWrite\\` ACL. ACLs do not work when Object Ownership is\nenabled on the bucket.\n\nThis flag uses a Bucket Policy statement to allow Server Access Log delivery, following best\npractices for S3.\n\n\n\n```json\n{\n \"context\": {\n \"@aws-cdk/aws-s3:serverAccessLogsUseBucketPolicy\": true\n }\n}\n```\n\n* `@aws-cdk/aws-rds:databaseProxyUniqueResourceName`\n\nEnable this feature flag to use unique resource names for each `DatabaseProxy`.\n\nPreviously, the default behavior for `DatabaseProxy` was to use `id` of the constructor for `dbProxyName`.\nIn this case, users couldn't deploy `DatabaseProxy`s that have the same `id` in the same region.\n\nThis is a feature flag as the old behavior was technically incorrect, but users may have come to depend on it.\n\n```json\n{\n \"context\": {\n \"@aws-cdk/aws-rds:databaseProxyUniqueResourceName\": true\n }\n}\n```\n\n* `@aws-cdk/aws-redshift:columnId`\n\nEnable this feature flag to allow the CDK to track changes in Redshift columns through their `id` attribute. This is a breaking change, as the `name` attribute was currently being used to track changes to Redshift columns.\n\nEnabling this feature flag comes at a risk for existing Redshift columns, as the `name` attribute of a redshift column was currently being used. Therefore, to change a Redshift columns' `name` will essentially create a new column and delete the old one. This will cause data loss. If you choose to enable this flag, ensure that upon intial deployment (the first deployment after setting this feature flag), the `name` attribute of every column is not changed. After the intial deployment, you can freely change the `name` attribute of a column.\n\n_cdk.json_\n\n```json\n{\n \"context\": {\n \"@aws-cdk/aws-redshift:columnId\": true\n }\n}\n```\n\n* `@aws-cdk/aws-stepfunctions-tasks:enableEmrServicePolicyV2`\n\nEnable this feature flag to use the \\`AmazonEMRServicePolicy_v2\\` managed policies for the EMR service role.\n\nThis is a feature flag as the old behavior will be deprecated, but some resources may require manual\nintervention since they might not have the appropriate tags propagated automatically.\n\n\n\n_cdk.json_\n\n```json\n{\n \"context\": {\n \"@aws-cdk/aws-stepfunctions-tasks:enableEmrServicePolicyV2\": true\n }\n}\n```\n\n* `@aws-cdk/core:includePrefixInUniqueNameGeneration`\n\nEnable this feature flag to include the stack's prefixes to the name generation process.\n\nNot doing so can cause the name of stack to exceed 128 characters:\n\n* The name generation ensures it doesn't exceed 128 characters\n* Without this feature flag, the prefix is prepended to the generated name, which result can exceed 128 characters\n\nThis is a feature flag as it changes the name generated for stacks. Any CDK application deployed prior this fix will\nmost likely be generated with a new name, causing the stack to be recreated with the new name, and then deleting the old one.\nFor applications running on production environments this can be unmanageable.\n\n_cdk.json_\n\n```json\n{\n \"context\": {\n \"@aws-cdk/core:includePrefixInUniqueNameGeneration\": true\n }\n}\n```\n\n* `@aws-cdk/aws-lambda-nodejs:useLatestRuntimeVersion`\n\nEnable this feature flag to automatically use the latest available NodeJS version in the aws-lambda-nodejs.Function construct.\n\nThis allows creation of new functions using a version that will automatically stay up to date without breaking bundling of existing functions that externalize packages included in their environment such as `aws-sdk`.\n\nFunctions defined previously will continue to function correctly as long as they pass an explicit runtime version, or do not exclude packages during bundling.\n\n_cdk.json_\n\n```json\n{\n \"context\": {\n \"@aws-cdk/aws-lambda-nodejs:useLatestRuntimeVersion\": true\n }\n}\n```\n\n* `@aws-cdk/aws-codepipeline-actions:useNewDefaultBranchForCodeCommitSource`\n\nEnable this feature flag to update the default branch for CodeCommit source actions to `main`.\n\nPreviously, the default branch for CodeCommit source actions was set to `master`.\nHowever, this convention is no longer supported, and repositories created after March 2021 now have `main` as\ntheir default branch.\n\n_cdk.json_\n\n```json\n{\n \"context\": {\n \"@aws-cdk/aws-codepipeline-actions:useNewDefaultBranchForCodeCommitSource\": true\n }\n}\n```\n\n* `@aws-cdk/aws-cloudwatch-actions:changeLambdaPermissionLogicalIdForLambdaAction`\n\nEnable this feature flag to change the logical ID of the `LambdaPermission` for the `LambdaAction` to include an alarm ID.\n\nPreviously, only one alarm with the `LambdaAction` could be created per Lambda.\nThis flag allows multiple alarms with the `LambdaAction` for the same Lambda to be created.\n\n_cdk.json_\n\n```json\n{\n \"context\": {\n \"@aws-cdk/aws-cloudwatch-actions:changeLambdaPermissionLogicalIdForLambdaAction\": true\n }\n}\n```\n\n* `@aws-cdk/aws-codepipeline:crossAccountKeysDefaultValueToFalse`\n\nEnables Pipeline to set the default value for `crossAccountKeys` to false.\n\nWhen this feature flag is enabled, and the `crossAccountKeys` property is not provided in a `Pipeline`\nconstruct, the construct automatically defaults the value of this property to false.\n\n_cdk.json_\n\n```json\n{\n \"context\": {\n \"@aws-cdk/aws-codepipeline:crossAccountKeysDefaultValueToFalse\": true\n }\n}\n```\n\n* `@aws-cdk/aws-codepipeline:defaultPipelineTypeToV2`\n\nEnables Pipeline to set the default pipeline type to V2.\n\nWhen this feature flag is enabled, and the `pipelineType` property is not provided in a `Pipeline`\nconstruct, the construct automatically defaults the value of this property to `PipelineType.V2`.\n\n_cdk.json_\n\n```json\n{\n \"context\": {\n \"@aws-cdk/aws-codepipeline:defaultPipelineTypeToV2\": true\n }\n}\n```\n\n* `@aws-cdk/aws-kms:reduceCrossAccountRegionPolicyScope`\n\nReduce resource scope of the IAM Policy created from KMS key grant to granting key only.\n\nWhen this feature flag is enabled and calling KMS key grant method, the created IAM policy will reduce the resource scope from\n'*' to this specific granting KMS key.\n\n_cdk.json_\n\n```json\n{\n \"context\": {\n \"@aws-cdk/aws-kms:reduceCrossAccountRegionPolicyScope\": true\n }\n}\n```\n\n* `@aws-cdk/aws-kms:applyImportedAliasPermissionsToPrincipal`\n\nEnable grant methods on imported KMS Aliases to apply permissions scoped by the alias using the `kms:ResourceAliases` condition key. When this flag is disabled, grant* methods on `Alias.fromAliasName` remain no-ops to preserve existing behavior.\n\n_cdk.json_\n\n```json\n{\n \"context\": {\n \"@aws-cdk/aws-kms:applyImportedAliasPermissionsToPrincipal\": true\n }\n}\n```\n\n* `@aws-cdk/aws-eks:nodegroupNameAttribute`\n\nWhen enabled, nodegroupName attribute of the provisioned EKS NodeGroup will not have the cluster name prefix.\n\nWhen this feature flag is enabled, the nodegroupName attribute will be exactly the name of the nodegroup\nwithout any prefix.\n\n_cdk.json_\n\n```json\n{\n \"context\": {\n \"@aws-cdk/aws-eks:nodegroupNameAttribute\": true\n }\n}\n```\n\n* `@aws-cdk/aws-ec2:ebsDefaultGp3Volume`\n\nWhen enabled, the default volume type of the EBS volume will be GP3.\n\nWhen this featuer flag is enabled, the default volume type of the EBS volume will be `EbsDeviceVolumeType.GENERAL_PURPOSE_SSD_GP3`\n\n_cdk.json_\n\n```json\n{\n \"context\": {\n \"@aws-cdk/aws-ec2:ebsDefaultGp3Volume\": true\n }\n}\n```\n\n* `@aws-cdk/aws-ecs:removeDefaultDeploymentAlarm`\n\nWhen enabled, remove default deployment alarm settings.\n\nWhen this featuer flag is enabled, remove the default deployment alarm settings when creating a AWS ECS service.\n\n_cdk.json_\n\n```json\n{\n \"context\": {\n \"@aws-cdk/aws-ec2:ebsDefaultGp3Volume\": true\n }\n}\n```\n\n* `@aws-cdk/aws-stepfunctions-tasks:ecsReduceRunTaskPermissions`\n\nWhen enabled, IAM Policy created to run tasks won't include the task definition ARN, only the revision ARN.\n\nWhen this feature flag is enabled, the IAM Policy created to run tasks won't include the task definition ARN, only the revision ARN.\nThe revision ARN is more specific than the task definition ARN. See \nfor more details.\n\n_cdk.json_\n\n```json\n{\n \"context\": {\n \"@aws-cdk/aws-stepfunctions-tasks:ecsReduceRunTaskPermissions\": true\n }\n}\n```\n\n* `@aws-cdk/aws-stepfunctions-taks:useNewS3UriParametersForBedrockInvokeModelTask`\n\nWhen enabled, use new props for S3 URI under `input` and `output` fields in task definition of state machine for bedrock invoke model.\n\nWhen this feature flag is enabled, use newly introduced props `s3InputUri` and `s3OutputUri` to populate S3 uri under input and output fields in state machine task definition for Bedrock invoke model.\n\n_cdk.json_\n\n```json\n{\n \"context\": {\n \"@aws-cdk/aws-stepfunctions-tasks:useNewS3UriParametersForBedrockInvokeModelTask\": true\n }\n}\n```\n\n* `@aws-cdk/aws-ecs:reduceEc2FargateCloudWatchPermissions`\n\nCurrently, we will automatically add a number of cloudwatch permissions to the task role when no cloudwatch log group is\nspecified as logConfiguration and it will grant 'Resources': ['*'] to the task role.\n\nWhen this feature flag is enabled, we will only grant the necessary permissions when users specify cloudwatch log group.\n\n_cdk.json_\n\n```json\n{\n \"context\": {\n \"@aws-cdk/aws-ecs:reduceEc2FargateCloudWatchPermissions\": true\n }\n}\n```\n\n* `@aws-cdk/aws-ec2:ec2SumTImeoutEnabled`\n\nCurrently is both initOptions.timeout and resourceSignalTimeout are both specified in the options for creating an EC2 Instance, only the value from 'resourceSignalTimeout' will be used.\n\nWhen this feature flag is enabled, if both initOptions.timeout and resourceSignalTimeout are specified, the values will to be summed together.\n\n_cdk.json_\n\n```json\n{\n \"context\": {\n \"@aws-cdk/aws-ec2:ec2SumTImeoutEnabled\": true\n }\n}\n```\n\n* `@aws-cdk/aws-appsync:appSyncGraphQLAPIScopeLambdaPermission`\n\nCurrently, when using a Lambda authorizer with an AppSync GraphQL API, the AWS CDK automatically generates the necessary AWS::Lambda::Permission to allow the AppSync API to invoke the Lambda authorizer. This permission is overly permissive because it lacks a SourceArn, meaning it allows invocations from any source.\n\nWhen this feature flag is enabled, the AWS::Lambda::Permission will be properly scoped with the SourceArn corresponding to the specific AppSync GraphQL API.\n\n_cdk.json_\n\n```json\n{\n \"context\": {\n \"@aws-cdk/aws-ec2:appSyncGraphQLAPIScopeLambdaPermission\": true\n }\n}\n```\n\n* `@aws-cdk/aws-rds:setCorrectValueForDatabaseInstanceReadReplicaInstanceResourceId`\n\nWhen enabled, the value of property `instanceResourceId` in construct `DatabaseInstanceReadReplica` will be set to the correct value which is `DbiResourceId` instead of currently `DbInstanceArn`* (fix)\n\nWhen this feature flag is enabled, the value of that property will be as expected set to `DbiResourceId` attribute, and that will fix the grantConnect method.\n\n_cdk.json_\n\n```json\n{\n \"context\": {\n \"@aws-cdk/aws-rds:setCorrectValueForDatabaseInstanceReadReplicaInstanceResourceId\": true\n }\n}\n```\n\n* `@aws-cdk/aws-lambda-nodejs:sdkV3ExcludeSmithyPackages`\n\nCurrently, when bundling Lambda functions with the non-latest runtime that supports AWS SDK JavaScript (v3), only the `@aws-sdk/*` packages are excluded by default.\nHowever, this can cause version mismatches between the `@aws-sdk/*` and `@smithy/*` packages, as they are tightly coupled dependencies in AWS SDK v3.\n\nWhen this feature flag is enabled, both `@aws-sdk/*` and `@smithy/*` packages will be excluded during the bundling process. This ensures that no mismatches\noccur between these tightly coupled dependencies when using the AWS SDK v3 in Lambda functions.\n\n_cdk.json_\n\n```json\n{\n \"context\": {\n \"@aws-cdk/aws-lambda-nodejs:sdkV3ExcludeSmithyPackages\": true\n }\n}\n```\n\n* `@aws-cdk/aws-dynamodb:resourcePolicyPerReplica`\n\nIf this flag is not set, the default behavior for \\`TableV2\\` is to use a different \\`resourcePolicy\\` for each replica.\n\nIf this flag is set to false, the behavior is that each replica shares the same \\`resourcePolicy\\` as the source table.\nThis will prevent you from creating a new table which has an additional replica and a resource policy.\n\nThis is a feature flag as the old behavior was technically incorrect but users may have come to depend on it.\n\n_cdk.json_\n\n```json\n{\n \"context\": {\n \"@aws-cdk/aws-dynamodb:resourcePolicyPerReplica\": false,\n },\n}\n```\n\n* `@aws-cdk/aws-route53-targets:userPoolDomainNameMethodWithoutCustomResource`\n\nWhen enabled, use a new method for DNS Name of user pool domain target without creating a custom resource.\n\nWhen this feature flag is enabled, a new method will be used to get the DNS Name of the user pool domain target. The old method\ncreates a custom resource internally, but the new method doesn't need a custom resource.\n\nIf the flag is set to false then a custom resource will be created when using `UserPoolDomainTarget`.\n\n_cdk.json_\n\n```json\n{\n \"context\": {\n \"@aws-cdk/aws-route53-targets:userPoolDomainNameMethodWithoutCustomResource\": true\n }\n}\n```\n\n* `@aws-cdk/aws-elasticloadbalancingV2:albDualstackWithoutPublicIpv4SecurityGroupRulesDefault`\n\nWhen enabled, the default security group ingress rules will allow IPv6 ingress from anywhere,\nFor internet facing ALBs with `dualstack-without-public-ipv4` IP address type, the default security group rules\nwill allow IPv6 ingress from anywhere (::/0). Previously, the default security group rules would only allow IPv4 ingress.\n\nUsing a feature flag to make sure existing customers who might be relying\non the overly restrictive permissions are not broken.,\n\nIf the flag is set to false then the default security group rules will only allow IPv4 ingress.\n\n_cdk.json_\n\n```json\n{\n \"context\": {\n \"@aws-cdk/aws-elasticloadbalancingV2:albDualstackWithoutPublicIpv4SecurityGroupRulesDefault\": true\n }\n}\n```\n\n* `@aws-cdk/aws-iam:oidcRejectUnauthorizedConnections`\n\nWhen this feature flag is enabled, the default behaviour of OIDC Provider's custom resource handler will\ndefault to reject unauthorized connections when downloading CA Certificates.\n\nWhen this feature flag is disabled, the behaviour will be the same as current and will allow downloading\nthumbprints from insecure connections.\n\n_cdk.json_\n\n```json\n{\n \"context\": {\n \"@aws-cdk/aws-iam:oidcRejectUnauthorizedConnections\": true\n }\n}\n```\n\n* `@aws-cdk/core:enableAdditionalMetadataCollection`\n\nWhen this feature flag is enabled, CDK expands the scope of usage data collection to include the:\n\n* L2 construct property keys - Collect which property keys you use from the L2 constructs in your app. This includes property keys nested in dictionary objects.\n* L2 construct property values of BOOL and ENUM types - Collect property key values of only BOOL and ENUM types. All other types, such as string values or construct references will be redacted.\n* L2 construct method usage - Collection method name, parameter keys and parameter values of BOOL and ENUM type.\n\n_cdk.json_\n\n```json\n{\n \"context\": {\n \"@aws-cdk/core:enableAdditionalMetadataCollection\": true\n }\n}\n```\n\n* `@aws-cdk/aws-lambda:createNewPoliciesWithAddToRolePolicy`\n\n[Deprecated default feature] When this feature flag is enabled, Lambda will create new inline policies with AddToRolePolicy.\nThe purpose of this is to prevent lambda from creating a dependency on the Default Policy Statement.\nThis solves an issue where a circular dependency could occur if adding lambda to something like a Cognito Trigger, then adding the User Pool to the lambda execution role permissions.\nHowever in the current implementation, we have removed a dependency of the lambda function on the policy. In addition to this, a Role will be attached to the Policy instead of an inline policy being attached to the role.\nThis will create a data race condition in the CloudFormation template because the creation of the Lambda function no longer waits for the policy to be created. Having said that, we are not deprecating the feature (we are defaulting the feature flag to false for new stacks) since this feature can still be used to get around the circular dependency issue (issue-7016) particularly in cases where the lambda resource creation doesnt need to depend on the policy resource creation.\nWe recommend to unset the feature flag if already set which will restore the original behavior.\n\n_cdk.json_\n\n```json\n{\n \"context\": {\n \"@aws-cdk/aws-lambda:createNewPoliciesWithAddToRolePolicy\": false\n }\n}\n```\n\n* `@aws-cdk/aws-s3:setUniqueReplicationRoleName`\n\nWhen this feature flag is enabled, a unique role name is specified only when performing cross-account replication.\nWhen disabled, 'CDKReplicationRole' is always specified.\n\n_cdk.json_\n\n```json\n{\n \"context\": {\n \"@aws-cdk/aws-s3:setUniqueReplicationRoleName\": true\n }\n}\n```\n\n* `@aws-cdk/pipelines:reduceStageRoleTrustScope`\n\nWhen this feature flag is enabled, the root account principal will not be added to the trust policy of stage role.\nWhen this feature flag is disabled, it will keep the root account principal in the trust policy.\n\n_cdk.json_\n\n```json\n{\n \"context\": {\n \"@aws-cdk/pipelines:reduceStageRoleTrustScope\": true\n }\n}\n```\n\n* `@aws-cdk/aws-events:requireEventBusPolicySid`\n\nWhen this flag is enabled:\n- Resource policies will be created with Statement IDs for service principals\n- The operation will succeed as expected\n\nWhen this flag is disabled:\n- A warning will be emitted\n- The grant operation will be dropped\n- No permissions will be added\n\n_cdk.json_\n\n```json\n{\n \"context\": {\n \"@aws-cdk/aws-events:requireEventBusPolicySid\": true\n }\n}\n```\n\n* `@aws-cdk/aws-dynamodb:retainTableReplica`\n\nCurrently, table replica will always be deleted when stack deletes regardless of source table's deletion policy.\nWhen enabled, table replica will be default to the removal policy of source table unless specified otherwise.\n\n_cdk.json_\n\n```json\n{\n \"context\": {\n \"@aws-cdk/aws-dynamodb:retainTableReplica\": true\n }\n}\n```\n\n* `@aws-cdk/cognito:logUserPoolClientSecretValue`\n\nWhen this feature flag is enabled, the SDK API call response to desribe user pool client values will be logged in the custom\nresource lambda function logs.\n\nWhen this feature flag is disabled, the SDK API call response to describe user pool client values will not be logged in the custom\nresource lambda function logs.\n\n_cdk.json_\n\n```json\n{\n \"context\": {\n \"@aws-cdk/cognito:logUserPoolClientSecretValue\": true\n }\n}\n```\n\n* `@aws-cdk/aws-s3:publicAccessBlockedByDefault`\n\nWhen BlockPublicAccess is not set at all, s3's default behavior will be to set all options to true in aws console.\nThe previous behavior in cdk before this feature was; if only some of the BlockPublicAccessOptions were set (not all 4), then the ones undefined would default to false.\nThis is counter intuitive to the console behavior where the options would start in true state and a user would uncheck the boxes as needed.\nThe new behavior from this feature will allow a user, for example, to set 1 of the 4 BlockPublicAccessOpsions to false, and on deployment the other 3 will remain true.\n\n_cdk.json_\n\n```json\n{\n \"context\": {\n \"@aws-cdk/aws-s3:publicAccessBlockedByDefault\": true\n }\n}\n```\n\n* `@aws-cdk/aws-ec2:requirePrivateSubnetsForEgressOnlyInternetGateway`\n\nWhen this feature flag is enabled, EgressOnlyGateway is created only for dual-stack VPC with private subnets\n\nWhen this feature flag is disabled, EgressOnlyGateway resource is created for all dual-stack VPC regardless of subnet type\n\n_cdk.json_\n\n```json\n{\n \"context\": {\n \"@aws-cdk/aws-ec2:requirePrivateSubnetsForEgressOnlyInternetGateway\": true\n }\n}\n```\n\n* `@aws-cdk/aws-stepfunctions-tasks:httpInvokeDynamicJsonPathEndpoint`\n\nWhen this feature flag is enabled, the JSONPath apiEndpoint value will be resolved dynamically at runtime, while slightly increasing the size of the state machine definition.\nWhen disabled, the JSONPath apiEndpoint property will only support a static string value.\n\n_cdk.json\n\n```json\n{\n \"context\": {\n \"@aws-cdk/aws-stepfunctions-tasks:httpInvokeDynamicJsonPathEndpoint\": true\n }\n}\n```\n\n* `@aws-cdk/aws-signer:signingProfileNamePassedToCfn`\n\nWhen this feature flag is enabled, the `signingProfileName` property is passed to the L1 `CfnSigningProfile` construct,\nwhich ensures that the AWS Signer profile is created with the specified name.\n\nWhen this feature flag is disabled, the `signingProfileName` is not passed to CloudFormation, maintaining backward\ncompatibility with existing deployments where CloudFormation auto-generated profile names.\n\nThis feature flag is needed because enabling it can cause existing signing profiles to be\nreplaced during deployment if a `signingProfileName` was specified but not previously used\nin the CloudFormation template.\n\n_cdk.json_\n\n```json\n{\n \"context\": {\n \"@aws-cdk/aws-signer:signingProfileNamePassedToCfn\": true\n }\n}\n```\n\n* `@aws-cdk/aws-ecs-patterns:uniqueTargetGroupId`\n\nWhen enabled, ECS patterns will generate unique target group IDs that include the load balancer name and type (public/private). This prevents CloudFormation conflicts when switching between public and private load balancers.\n\nWithout this flag, switching an ApplicationLoadBalancedFargateService from public to private (or vice versa) fails with \"target group cannot be associated with more than one load balancer\" error.\n\n_cdk.json_\n\n```json\n{\n \"context\": {\n \"@aws-cdk/aws-ecs-patterns:uniqueTargetGroupId\": true\n }\n}\n```\n\n* `@aws-cdk/aws-batch:defaultToAL2023`\n\nWhen enabled, EC2 Batch compute environments (both ECS and EKS) that do not specify an `imageType`\nwill default to `ECS_AL2023` or `EKS_AL2023` instead of the deprecated `ECS_AL2` or `EKS_AL2`\n(Amazon Linux 2, reaching EOL June 2026 for ECS; already EOL for EKS).\n\nFor EKS compute environments with a launch template, `userdataType` will automatically be set\nto `EKS_NODEADM` when an AL2023 image type is used, as required by the AWS Batch API.\n\nWhen disabled, the default `imageType` remains `ECS_AL2` / `EKS_AL2` for backward compatibility.\n\n_cdk.json_\n\n```json\n{\n \"context\": {\n \"@aws-cdk/aws-batch:defaultToAL2023\": true\n }\n}\n```\n" }, "repository": { "directory": "packages/@aws-cdk/cx-api", "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/main/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 :: 2" ], "distName": "aws-cdk.cx-api", "module": "aws_cdk.cx_api" } }, "types": { "@aws-cdk/cx-api.AssemblyBuildOptions": { "assembly": "@aws-cdk/cx-api", "datatype": true, "docs": { "stability": "stable", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cx_api from '@aws-cdk/cx-api';\nconst assemblyBuildOptions: cx_api.AssemblyBuildOptions = {\n runtimeInfo: {\n libraries: {\n librariesKey: 'libraries',\n },\n },\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/cx-api.AssemblyBuildOptions", "kind": "interface", "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 708 }, "name": "AssemblyBuildOptions", "properties": [ { "abstract": true, "docs": { "default": "- if this option is not specified, runtime info will not be included", "deprecated": "All template modifications that should result from this should\nhave already been inserted into the template.", "stability": "deprecated", "summary": "Include the specified runtime information (module versions) in manifest." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 715 }, "name": "runtimeInfo", "optional": true, "type": { "fqn": "@aws-cdk/cx-api.RuntimeInfo" } } ], "symbolId": "lib/legacy-moved:AssemblyBuildOptions" }, "@aws-cdk/cx-api.AssetManifestArtifact": { "assembly": "@aws-cdk/cx-api", "base": "@aws-cdk/cx-api.CloudArtifact", "docs": { "stability": "stable", "summary": "Asset manifest is a description of a set of assets which need to be built and published.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nimport * as cx_api from '@aws-cdk/cx-api';\n\ndeclare const assumeRoleAdditionalOptions: any;\ndeclare const cloudAssembly: cx_api.CloudAssembly;\nconst assetManifestArtifact = new cx_api.AssetManifestArtifact(cloudAssembly, 'name', {\n type: cloud_assembly_schema.ArtifactType.NONE,\n\n // the properties below are optional\n additionalMetadataFile: 'additionalMetadataFile',\n dependencies: ['dependencies'],\n displayName: 'displayName',\n environment: 'environment',\n metadata: {\n metadataKey: [{\n type: 'type',\n\n // the properties below are optional\n data: 'data',\n trace: ['trace'],\n }],\n },\n properties: {\n templateFile: 'templateFile',\n\n // the properties below are optional\n assumeRoleAdditionalOptions: {\n assumeRoleAdditionalOptionsKey: assumeRoleAdditionalOptions,\n },\n assumeRoleArn: 'assumeRoleArn',\n assumeRoleExternalId: 'assumeRoleExternalId',\n bootstrapStackVersionSsmParameter: 'bootstrapStackVersionSsmParameter',\n cloudFormationExecutionRoleArn: 'cloudFormationExecutionRoleArn',\n lookupRole: {\n arn: 'arn',\n\n // the properties below are optional\n assumeRoleAdditionalOptions: {\n assumeRoleAdditionalOptionsKey: assumeRoleAdditionalOptions,\n },\n assumeRoleExternalId: 'assumeRoleExternalId',\n bootstrapStackVersionSsmParameter: 'bootstrapStackVersionSsmParameter',\n requiresBootstrapStackVersion: 123,\n },\n notificationArns: ['notificationArns'],\n parameters: {\n parametersKey: 'parameters',\n },\n requiresBootstrapStackVersion: 123,\n stackName: 'stackName',\n stackTemplateAssetObjectUrl: 'stackTemplateAssetObjectUrl',\n tags: {\n tagsKey: 'tags',\n },\n terminationProtection: false,\n validateOnSynth: false,\n },\n});", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/cx-api.AssetManifestArtifact", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 523 }, "parameters": [ { "name": "assembly", "type": { "fqn": "@aws-cdk/cx-api.CloudAssembly" } }, { "name": "name", "type": { "primitive": "string" } }, { "name": "artifact", "type": { "fqn": "@aws-cdk/cloud-assembly-schema.ArtifactManifest" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 489 }, "methods": [ { "docs": { "remarks": "Use this method instead of `instanceof` to properly detect `AssetManifestArtifact`\ninstances, even when the construct library is symlinked.\n\nExplanation: in JavaScript, multiple copies of the `cx-api` library on\ndisk are seen as independent, completely different libraries. As a\nconsequence, the class `AssetManifestArtifact` in each copy of the `cx-api` library\nis seen as a different class, and an instance of one class will not test as\n`instanceof` the other class. `npm install` will not create installations\nlike this, but users may manually symlink construct libraries together or\nuse a monorepo tool: in those cases, multiple copies of the `cx-api`\nlibrary can be accidentally installed, and `instanceof` will behave\nunpredictably. It is safest to avoid using `instanceof`, and using\nthis type-testing method instead.", "stability": "stable", "summary": "Checks if `art` is an instance of this class." }, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 507 }, "name": "isAssetManifestArtifact", "parameters": [ { "name": "art", "type": { "primitive": "any" } } ], "returns": { "type": { "primitive": "boolean" } }, "static": true } ], "name": "AssetManifestArtifact", "properties": [ { "docs": { "stability": "stable", "summary": "The Asset Manifest contents." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 527 }, "name": "contents", "type": { "fqn": "@aws-cdk/cloud-assembly-schema.AssetManifest" } }, { "docs": { "stability": "stable", "summary": "The file name of the asset manifest." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 511 }, "name": "file", "type": { "primitive": "string" } }, { "docs": { "default": "- Discover SSM parameter by reading stack", "stability": "stable", "summary": "Name of SSM parameter with bootstrap stack version." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 521 }, "name": "bootstrapStackVersionSsmParameter", "optional": true, "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "Version of bootstrap stack required to deploy this stack." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 515 }, "name": "requiresBootstrapStackVersion", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "lib/legacy-moved:AssetManifestArtifact" }, "@aws-cdk/cx-api.AwsCloudFormationStackProperties": { "assembly": "@aws-cdk/cx-api", "datatype": true, "docs": { "deprecated": "The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.", "stability": "deprecated", "summary": "Artifact properties for CloudFormation stacks.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cx_api from '@aws-cdk/cx-api';\nconst awsCloudFormationStackProperties: cx_api.AwsCloudFormationStackProperties = {\n templateFile: 'templateFile',\n\n // the properties below are optional\n parameters: {\n parametersKey: 'parameters',\n },\n stackName: 'stackName',\n terminationProtection: false,\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/cx-api.AwsCloudFormationStackProperties", "kind": "interface", "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 1117 }, "name": "AwsCloudFormationStackProperties", "properties": [ { "abstract": true, "docs": { "stability": "deprecated", "summary": "A file relative to the assembly root which contains the CloudFormation template for this stack." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 1121 }, "name": "templateFile", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "deprecated", "summary": "Values for CloudFormation stack parameters that should be passed when the stack is deployed." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 1125 }, "name": "parameters", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "- name derived from artifact ID", "stability": "deprecated", "summary": "The name to use for the CloudFormation stack." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 1132 }, "name": "stackName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "false", "stability": "deprecated", "summary": "Whether to enable termination protection for this stack." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 1138 }, "name": "terminationProtection", "optional": true, "type": { "primitive": "boolean" } } ], "symbolId": "lib/legacy-moved:AwsCloudFormationStackProperties" }, "@aws-cdk/cx-api.CloudArtifact": { "assembly": "@aws-cdk/cx-api", "docs": { "stability": "stable", "summary": "Represents an artifact within a cloud assembly.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nimport * as cx_api from '@aws-cdk/cx-api';\n\ndeclare const assumeRoleAdditionalOptions: any;\ndeclare const cloudAssembly: cx_api.CloudAssembly;\nconst cloudArtifact = cx_api.CloudArtifact.fromManifest(cloudAssembly, 'MyCloudArtifact', {\n type: cloud_assembly_schema.ArtifactType.NONE,\n\n // the properties below are optional\n additionalMetadataFile: 'additionalMetadataFile',\n dependencies: ['dependencies'],\n displayName: 'displayName',\n environment: 'environment',\n metadata: {\n metadataKey: [{\n type: 'type',\n\n // the properties below are optional\n data: 'data',\n trace: ['trace'],\n }],\n },\n properties: {\n templateFile: 'templateFile',\n\n // the properties below are optional\n assumeRoleAdditionalOptions: {\n assumeRoleAdditionalOptionsKey: assumeRoleAdditionalOptions,\n },\n assumeRoleArn: 'assumeRoleArn',\n assumeRoleExternalId: 'assumeRoleExternalId',\n bootstrapStackVersionSsmParameter: 'bootstrapStackVersionSsmParameter',\n cloudFormationExecutionRoleArn: 'cloudFormationExecutionRoleArn',\n lookupRole: {\n arn: 'arn',\n\n // the properties below are optional\n assumeRoleAdditionalOptions: {\n assumeRoleAdditionalOptionsKey: assumeRoleAdditionalOptions,\n },\n assumeRoleExternalId: 'assumeRoleExternalId',\n bootstrapStackVersionSsmParameter: 'bootstrapStackVersionSsmParameter',\n requiresBootstrapStackVersion: 123,\n },\n notificationArns: ['notificationArns'],\n parameters: {\n parametersKey: 'parameters',\n },\n requiresBootstrapStackVersion: 123,\n stackName: 'stackName',\n stackTemplateAssetObjectUrl: 'stackTemplateAssetObjectUrl',\n tags: {\n tagsKey: 'tags',\n },\n terminationProtection: false,\n validateOnSynth: false,\n },\n});", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/cx-api.CloudArtifact", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 316 }, "parameters": [ { "name": "assembly", "type": { "fqn": "@aws-cdk/cx-api.CloudAssembly" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "manifest", "type": { "fqn": "@aws-cdk/cloud-assembly-schema.ArtifactManifest" } } ], "protected": true }, "kind": "class", "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 292 }, "methods": [ { "docs": { "returns": "the `CloudArtifact` that matches the artifact type or `undefined` if it's an artifact type that is unrecognized by this module.", "stability": "stable", "summary": "Returns a subclass of `CloudArtifact` based on the artifact type defined in the artifact manifest." }, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 303 }, "name": "fromManifest", "parameters": [ { "docs": { "summary": "- The cloud assembly from which to load the artifact." }, "name": "assembly", "type": { "fqn": "@aws-cdk/cx-api.CloudAssembly" } }, { "docs": { "summary": "- The artifact ID." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- The artifact manifest." }, "name": "artifact", "type": { "fqn": "@aws-cdk/cloud-assembly-schema.ArtifactManifest" } } ], "returns": { "optional": true, "type": { "fqn": "@aws-cdk/cx-api.CloudArtifact" } }, "static": true }, { "docs": { "returns": "all the metadata entries of a specific type in this artifact.", "stability": "stable" }, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 324 }, "name": "findMetadataByType", "parameters": [ { "name": "type", "type": { "primitive": "string" } } ], "returns": { "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/cx-api.MetadataEntryResult" }, "kind": "array" } } } } ], "name": "CloudArtifact", "properties": [ { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 293 }, "name": "assembly", "type": { "fqn": "@aws-cdk/cx-api.CloudAssembly" } }, { "docs": { "stability": "stable", "summary": "Returns all the artifacts that this artifact depends on." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 320 }, "name": "dependencies", "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/cx-api.CloudArtifact" }, "kind": "array" } } }, { "docs": { "remarks": "Defaults to the normal\nid. Should only be used in user interfaces.", "stability": "stable", "summary": "An identifier that shows where this artifact is located in the tree of nested assemblies, based on their manifests." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 331 }, "name": "hierarchicalId", "type": { "primitive": "string" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 294 }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The artifact's manifest." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 307 }, "name": "manifest", "type": { "fqn": "@aws-cdk/cloud-assembly-schema.ArtifactManifest" } }, { "docs": { "stability": "stable", "summary": "The set of messages extracted from the artifact's metadata." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 311 }, "name": "messages", "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/cx-api.SynthesisMessage" }, "kind": "array" } } }, { "docs": { "stability": "stable", "summary": "Returns the metadata associated with this Cloud Artifact." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 336 }, "name": "metadata", "type": { "collection": { "elementtype": { "collection": { "elementtype": { "fqn": "@aws-cdk/cloud-assembly-schema.MetadataEntry" }, "kind": "array" } }, "kind": "map" } } } ], "symbolId": "lib/legacy-moved:CloudArtifact" }, "@aws-cdk/cx-api.CloudAssembly": { "assembly": "@aws-cdk/cx-api", "docs": { "stability": "stable", "summary": "Represents a deployable cloud application.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cx_api from '@aws-cdk/cx-api';\nconst cloudAssembly = new cx_api.CloudAssembly('directory', /* all optional props */ {\n skipEnumCheck: false,\n skipVersionCheck: false,\n topoSort: false,\n validateSchema: false,\n});", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/cx-api.CloudAssembly", "initializer": { "docs": { "stability": "stable", "summary": "Reads a cloud assembly from the specified directory." }, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 221 }, "parameters": [ { "docs": { "summary": "- The root directory of the assembly." }, "name": "directory", "type": { "primitive": "string" } }, { "name": "loadOptions", "optional": true, "type": { "fqn": "@aws-cdk/cloud-assembly-schema.LoadManifestOptions" } } ] }, "interfaces": [ "@aws-cdk/cloud-assembly-schema.ICloudAssembly" ], "kind": "class", "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 149 }, "methods": [ { "docs": { "remarks": "If a Cloud Assembly is emitted to a temporary directory, its directory gets\nadded to a list. This function iterates over that list and deletes each\ndirectory in it, to free up disk space.\n\nThis function will normally be called automatically during Node process\nexit and so you don't need to call this. However, some test environments do\nnot properly trigger Node's `exit` event. Notably: Jest does not trigger\nthe `exit` event ().\n\n## Cleaning up temporary directories in jest\n\nFor Jest, you have to make sure this function is called at the end of the\ntest suite instead:\n\n```js\nimport { CloudAssembly } from 'aws-cdk-lib/cx-api';\n\nafterAll(CloudAssembly.cleanupTemporaryDirectories);\n```\n\nAlternatively, you can use the `setupFilesAfterEnv` feature and use a\nprovided helper script to automatically inject the above into every\ntest file, so you don't have to do it by hand.\n\n```\n$ npx jest --setupFilesAfterEnv aws-cdk-lib/testhelpers/jest-autoclean\n```\n\nOr put the following into `jest.config.js`:\n\n```js\nmodule.exports = {\n // ...\n setupFilesAfterEnv: ['aws-cdk-lib/testhelpers/jest-cleanup'],\n};\n```", "stability": "stable", "summary": "Cleans up any temporary assembly directories that got created in this process." }, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 196 }, "name": "cleanupTemporaryDirectories", "static": true }, { "docs": { "remarks": "We do attribute detection since we can't reliably use 'instanceof'.", "stability": "stable", "summary": "Return whether the given object is a CloudAssembly." }, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 155 }, "name": "isCloudAssembly", "parameters": [ { "name": "x", "type": { "primitive": "any" } } ], "returns": { "type": { "primitive": "boolean" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Returns a nested assembly." }, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 269 }, "name": "getNestedAssembly", "parameters": [ { "docs": { "summary": "- The artifact ID of the nested assembly." }, "name": "artifactId", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/cx-api.CloudAssembly" } } }, { "docs": { "stability": "stable", "summary": "Returns a nested assembly artifact." }, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 263 }, "name": "getNestedAssemblyArtifact", "parameters": [ { "docs": { "summary": "- The artifact ID of the nested assembly." }, "name": "artifactId", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/cx-api.NestedCloudAssemblyArtifact" } } }, { "docs": { "deprecated": "renamed to `getStackByName` (or `getStackArtifact(id)`)", "stability": "deprecated", "summary": "Returns a CloudFormation stack artifact by name from this assembly." }, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 244 }, "name": "getStack", "parameters": [ { "name": "stackName", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/cx-api.CloudFormationStackArtifact" } } }, { "docs": { "custom": { "throws": "if there is no stack artifact with that id" }, "returns": "a `CloudFormationStackArtifact` object.", "stability": "stable", "summary": "Returns a CloudFormation stack artifact from this assembly." }, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 252 }, "name": "getStackArtifact", "parameters": [ { "docs": { "summary": "- the artifact id of the stack (can be obtained through `stack.artifactId`)." }, "name": "artifactId", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/cx-api.CloudFormationStackArtifact" } } }, { "docs": { "custom": { "throws": "if there is more than one stack with the same stack name. You can\nuse `getStackArtifact(stack.artifactId)` instead." }, "remarks": "Will only search the current assembly.", "returns": "a `CloudFormationStackArtifact` object.", "stability": "stable", "summary": "Returns a CloudFormation stack artifact from this assembly." }, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 239 }, "name": "getStackByName", "parameters": [ { "docs": { "summary": "- the name of the CloudFormation stack." }, "name": "stackName", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/cx-api.CloudFormationStackArtifact" } } }, { "docs": { "custom": { "throws": "if there is no metadata artifact by that name" }, "returns": "a `TreeCloudArtifact` object if there is one defined in the manifest, `undefined` otherwise.", "stability": "stable", "summary": "Returns the tree metadata artifact from this assembly." }, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 275 }, "name": "tree", "returns": { "optional": true, "type": { "fqn": "@aws-cdk/cx-api.TreeCloudArtifact" } } }, { "docs": { "returns": "A `CloudArtifact` object or `undefined` if the artifact does not exist in this assembly.", "stability": "stable", "summary": "Attempts to find an artifact with a specific identity." }, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 227 }, "name": "tryGetArtifact", "parameters": [ { "docs": { "summary": "- The artifact ID." }, "name": "id", "type": { "primitive": "string" } } ], "returns": { "optional": true, "type": { "fqn": "@aws-cdk/cx-api.CloudArtifact" } } } ], "name": "CloudAssembly", "properties": [ { "docs": { "stability": "stable", "summary": "All artifacts included in this assembly." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 208 }, "name": "artifacts", "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/cx-api.CloudArtifact" }, "kind": "array" } } }, { "docs": { "stability": "stable", "summary": "The root directory of the cloud assembly." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 200 }, "name": "directory", "overrides": "@aws-cdk/cloud-assembly-schema.ICloudAssembly", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The raw assembly manifest." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 216 }, "name": "manifest", "type": { "fqn": "@aws-cdk/cloud-assembly-schema.AssemblyManifest" } }, { "docs": { "stability": "stable", "summary": "The nested assembly artifacts in this assembly." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 283 }, "name": "nestedAssemblies", "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/cx-api.NestedCloudAssemblyArtifact" }, "kind": "array" } } }, { "docs": { "stability": "stable", "summary": "Runtime information such as module versions used to synthesize this assembly." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 212 }, "name": "runtime", "type": { "fqn": "@aws-cdk/cloud-assembly-schema.RuntimeInfo" } }, { "docs": { "returns": "all the CloudFormation stack artifacts that are included in this assembly.", "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 279 }, "name": "stacks", "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/cx-api.CloudFormationStackArtifact" }, "kind": "array" } } }, { "docs": { "stability": "stable", "summary": "Returns all the stacks, including the ones in nested assemblies." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 257 }, "name": "stacksRecursively", "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/cx-api.CloudFormationStackArtifact" }, "kind": "array" } } }, { "docs": { "stability": "stable", "summary": "The schema version of the assembly manifest." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 204 }, "name": "version", "type": { "primitive": "string" } } ], "symbolId": "lib/legacy-moved:CloudAssembly" }, "@aws-cdk/cx-api.CloudAssemblyBuilder": { "assembly": "@aws-cdk/cx-api", "docs": { "stability": "stable", "summary": "Can be used to build a cloud assembly.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cx_api from '@aws-cdk/cx-api';\n\ndeclare const cloudAssemblyBuilder_: cx_api.CloudAssemblyBuilder;\nconst cloudAssemblyBuilder = new cx_api.CloudAssemblyBuilder(/* all optional props */ 'outdir', /* all optional props */ {\n assetOutdir: 'assetOutdir',\n parentBuilder: cloudAssemblyBuilder_,\n});", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/cx-api.CloudAssemblyBuilder", "initializer": { "docs": { "stability": "stable", "summary": "Initializes a cloud assembly builder." }, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 640 }, "parameters": [ { "docs": { "summary": "- The output directory, uses temporary directory if undefined." }, "name": "outdir", "optional": true, "type": { "primitive": "string" } }, { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/cx-api.CloudAssemblyBuilderProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 624 }, "methods": [ { "docs": { "stability": "stable", "summary": "Adds an artifact into the cloud assembly." }, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 646 }, "name": "addArtifact", "parameters": [ { "docs": { "summary": "- The ID of the artifact." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- The artifact manifest." }, "name": "manifest", "type": { "fqn": "@aws-cdk/cloud-assembly-schema.ArtifactManifest" } } ] }, { "docs": { "stability": "stable", "summary": "Reports that some context is missing in order for this cloud assembly to be fully synthesized." }, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 651 }, "name": "addMissing", "parameters": [ { "docs": { "summary": "- Missing context information." }, "name": "missing", "type": { "fqn": "@aws-cdk/cloud-assembly-schema.MissingContext" } } ] }, { "docs": { "stability": "stable", "summary": "Finalizes the cloud assembly into the output directory returns a `CloudAssembly` object that can be used to inspect the assembly." }, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 656 }, "name": "buildAssembly", "parameters": [ { "name": "options", "optional": true, "type": { "fqn": "@aws-cdk/cx-api.AssemblyBuildOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/cx-api.CloudAssembly" } } }, { "docs": { "stability": "stable", "summary": "Creates a nested cloud assembly." }, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 660 }, "name": "createNestedAssembly", "parameters": [ { "name": "artifactId", "type": { "primitive": "string" } }, { "name": "displayName", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/cx-api.CloudAssemblyBuilder" } } }, { "docs": { "stability": "stable", "summary": "Delete the cloud assembly directory." }, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 664 }, "name": "delete" } ], "name": "CloudAssemblyBuilder", "properties": [ { "docs": { "stability": "stable", "summary": "The directory where assets of this Cloud Assembly should be stored." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 632 }, "name": "assetOutdir", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The root directory of the resulting cloud assembly." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 628 }, "name": "outdir", "type": { "primitive": "string" } } ], "symbolId": "lib/legacy-moved:CloudAssemblyBuilder" }, "@aws-cdk/cx-api.CloudAssemblyBuilderProps": { "assembly": "@aws-cdk/cx-api", "datatype": true, "docs": { "stability": "stable", "summary": "Construction properties for CloudAssemblyBuilder.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cx_api from '@aws-cdk/cx-api';\n\ndeclare const cloudAssemblyBuilder: cx_api.CloudAssemblyBuilder;\nconst cloudAssemblyBuilderProps: cx_api.CloudAssemblyBuilderProps = {\n assetOutdir: 'assetOutdir',\n parentBuilder: cloudAssemblyBuilder,\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/cx-api.CloudAssemblyBuilderProps", "kind": "interface", "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 693 }, "name": "CloudAssemblyBuilderProps", "properties": [ { "abstract": true, "docs": { "default": "- Same as the manifest outdir", "stability": "stable", "summary": "Use the given asset output directory." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 699 }, "name": "assetOutdir", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- This is a root assembly", "stability": "stable", "summary": "If this builder is for a nested assembly, the parent assembly builder." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 705 }, "name": "parentBuilder", "optional": true, "type": { "fqn": "@aws-cdk/cx-api.CloudAssemblyBuilder" } } ], "symbolId": "lib/legacy-moved:CloudAssemblyBuilderProps" }, "@aws-cdk/cx-api.CloudFormationStackArtifact": { "assembly": "@aws-cdk/cx-api", "base": "@aws-cdk/cx-api.CloudArtifact", "docs": { "stability": "stable", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nimport * as cx_api from '@aws-cdk/cx-api';\n\ndeclare const assumeRoleAdditionalOptions: any;\ndeclare const cloudAssembly: cx_api.CloudAssembly;\nconst cloudFormationStackArtifact = new cx_api.CloudFormationStackArtifact(cloudAssembly, 'artifactId', {\n type: cloud_assembly_schema.ArtifactType.NONE,\n\n // the properties below are optional\n additionalMetadataFile: 'additionalMetadataFile',\n dependencies: ['dependencies'],\n displayName: 'displayName',\n environment: 'environment',\n metadata: {\n metadataKey: [{\n type: 'type',\n\n // the properties below are optional\n data: 'data',\n trace: ['trace'],\n }],\n },\n properties: {\n templateFile: 'templateFile',\n\n // the properties below are optional\n assumeRoleAdditionalOptions: {\n assumeRoleAdditionalOptionsKey: assumeRoleAdditionalOptions,\n },\n assumeRoleArn: 'assumeRoleArn',\n assumeRoleExternalId: 'assumeRoleExternalId',\n bootstrapStackVersionSsmParameter: 'bootstrapStackVersionSsmParameter',\n cloudFormationExecutionRoleArn: 'cloudFormationExecutionRoleArn',\n lookupRole: {\n arn: 'arn',\n\n // the properties below are optional\n assumeRoleAdditionalOptions: {\n assumeRoleAdditionalOptionsKey: assumeRoleAdditionalOptions,\n },\n assumeRoleExternalId: 'assumeRoleExternalId',\n bootstrapStackVersionSsmParameter: 'bootstrapStackVersionSsmParameter',\n requiresBootstrapStackVersion: 123,\n },\n notificationArns: ['notificationArns'],\n parameters: {\n parametersKey: 'parameters',\n },\n requiresBootstrapStackVersion: 123,\n stackName: 'stackName',\n stackTemplateAssetObjectUrl: 'stackTemplateAssetObjectUrl',\n tags: {\n tagsKey: 'tags',\n },\n terminationProtection: false,\n validateOnSynth: false,\n },\n});", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/cx-api.CloudFormationStackArtifact", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 474 }, "parameters": [ { "name": "assembly", "type": { "fqn": "@aws-cdk/cx-api.CloudAssembly" } }, { "name": "artifactId", "type": { "primitive": "string" } }, { "name": "artifact", "type": { "fqn": "@aws-cdk/cloud-assembly-schema.ArtifactManifest" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 341 }, "methods": [ { "docs": { "remarks": "Use this method instead of `instanceof` to properly detect `CloudFormationStackArtifact`\ninstances, even when the construct library is symlinked.\n\nExplanation: in JavaScript, multiple copies of the `cx-api` library on\ndisk are seen as independent, completely different libraries. As a\nconsequence, the class `CloudFormationStackArtifact` in each copy of the `cx-api` library\nis seen as a different class, and an instance of one class will not test as\n`instanceof` the other class. `npm install` will not create installations\nlike this, but users may manually symlink construct libraries together or\nuse a monorepo tool: in those cases, multiple copies of the `cx-api`\nlibrary can be accidentally installed, and `instanceof` will behave\nunpredictably. It is safest to avoid using `instanceof`, and using\nthis type-testing method instead.", "stability": "stable", "summary": "Checks if `art` is an instance of this class." }, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 359 }, "name": "isCloudFormationStackArtifact", "parameters": [ { "name": "art", "type": { "primitive": "any" } } ], "returns": { "type": { "primitive": "boolean" } }, "static": true } ], "name": "CloudFormationStackArtifact", "properties": [ { "docs": { "stability": "stable", "summary": "Any assets associated with this stack." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 371 }, "name": "assets", "type": { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/cloud-assembly-schema.FileAssetMetadataEntry" }, { "fqn": "@aws-cdk/cloud-assembly-schema.ContainerImageAssetMetadataEntry" } ] } }, "kind": "array" } } }, { "docs": { "remarks": "Should only be used in user\ninterfaces. If the stackName has not been set explicitly, or has been set\nto artifactId, it will return the hierarchicalId of the stack. Otherwise,\nit will return something like \" ()\"", "stability": "stable", "summary": "A string that represents this stack." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 398 }, "name": "displayName", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The environment into which to deploy this artifact." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 407 }, "name": "environment", "type": { "fqn": "@aws-cdk/cx-api.Environment" } }, { "docs": { "deprecated": "renamed to `stackName`", "stability": "deprecated", "summary": "The physical name of this stack." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 403 }, "name": "name", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The original name as defined in the CDK app." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 367 }, "name": "originalName", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "CloudFormation parameters to pass to the stack." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 375 }, "name": "parameters", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "docs": { "stability": "stable", "summary": "The physical name of this stack." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 391 }, "name": "stackName", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "CloudFormation tags to pass to the stack." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 381 }, "name": "tags", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "docs": { "stability": "stable", "summary": "The CloudFormation template for this stack." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 482 }, "name": "template", "type": { "primitive": "any" } }, { "docs": { "stability": "stable", "summary": "The file name of the template." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 363 }, "name": "templateFile", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "Full path to the template file." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 478 }, "name": "templateFullPath", "type": { "primitive": "string" } }, { "docs": { "default": "- No additional options.", "remarks": "- `RoleArn` should not be used. Use the dedicated `assumeRoleArn` property instead.\n- `ExternalId` should not be used. Use the dedicated `assumeRoleExternalId` instead.\n- `TransitiveTagKeys` defaults to use all keys (if any) specified in `Tags`. E.g, all tags are transitive by default.", "see": "https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/STS.html#assumeRole-property", "stability": "stable", "summary": "Additional options to pass to STS when assuming the role for cloudformation deployments." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 430 }, "name": "assumeRoleAdditionalOptions", "optional": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "default": "- No role is assumed (current credentials are used)", "stability": "stable", "summary": "The role that needs to be assumed to deploy the stack." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 413 }, "name": "assumeRoleArn", "optional": true, "type": { "primitive": "string" } }, { "docs": { "default": "- No external ID", "stability": "stable", "summary": "External ID to use when assuming role for cloudformation deployments." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 419 }, "name": "assumeRoleExternalId", "optional": true, "type": { "primitive": "string" } }, { "docs": { "default": "- Discover SSM parameter by reading stack", "stability": "stable", "summary": "Name of SSM parameter with bootstrap stack version." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 462 }, "name": "bootstrapStackVersionSsmParameter", "optional": true, "type": { "primitive": "string" } }, { "docs": { "default": "- No role is passed (currently assumed role/credentials are used)", "stability": "stable", "summary": "The role that is passed to CloudFormation to execute the change set." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 438 }, "name": "cloudFormationExecutionRoleArn", "optional": true, "type": { "primitive": "string" } }, { "docs": { "default": "- No role is assumed (current credentials are used)", "stability": "stable", "summary": "The role to use to look up values from the target AWS account." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 444 }, "name": "lookupRole", "optional": true, "type": { "fqn": "@aws-cdk/cloud-assembly-schema.BootstrapRole" } }, { "docs": { "stability": "stable", "summary": "SNS Topics that will receive stack events." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 387 }, "name": "notificationArns", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "docs": { "default": "- No bootstrap stack required", "stability": "stable", "summary": "Version of bootstrap stack required to deploy this stack." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 456 }, "name": "requiresBootstrapStackVersion", "optional": true, "type": { "primitive": "number" } }, { "docs": { "default": "- Not uploaded yet, upload just before deploying", "stability": "stable", "summary": "If the stack template has already been included in the asset manifest, its asset URL." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 450 }, "name": "stackTemplateAssetObjectUrl", "optional": true, "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "Whether termination protection is enabled for this stack." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 466 }, "name": "terminationProtection", "optional": true, "type": { "primitive": "boolean" } }, { "docs": { "default": "- false", "stability": "stable", "summary": "Whether this stack should be validated by the CLI after synthesis." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 472 }, "name": "validateOnSynth", "optional": true, "type": { "primitive": "boolean" } } ], "symbolId": "lib/legacy-moved:CloudFormationStackArtifact" }, "@aws-cdk/cx-api.EndpointServiceAvailabilityZonesContextQuery": { "assembly": "@aws-cdk/cx-api", "datatype": true, "docs": { "deprecated": "The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.", "stability": "deprecated", "summary": "Query to hosted zone context provider.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cx_api from '@aws-cdk/cx-api';\nconst endpointServiceAvailabilityZonesContextQuery: cx_api.EndpointServiceAvailabilityZonesContextQuery = {\n account: 'account',\n region: 'region',\n serviceName: 'serviceName',\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/cx-api.EndpointServiceAvailabilityZonesContextQuery", "kind": "interface", "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 1086 }, "name": "EndpointServiceAvailabilityZonesContextQuery", "properties": [ { "abstract": true, "docs": { "stability": "deprecated", "summary": "Query account." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 1090 }, "name": "account", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "deprecated", "summary": "Query region." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 1094 }, "name": "region", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "deprecated", "summary": "Query service name." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 1098 }, "name": "serviceName", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/legacy-moved:EndpointServiceAvailabilityZonesContextQuery" }, "@aws-cdk/cx-api.Environment": { "assembly": "@aws-cdk/cx-api", "datatype": true, "docs": { "deprecated": "The official definition of this type has moved to `@aws-cdk/cloud-assembly-api`.", "stability": "deprecated", "summary": "Models an AWS execution environment, for use within the CDK toolkit.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cx_api from '@aws-cdk/cx-api';\nconst environment: cx_api.Environment = {\n account: 'account',\n name: 'name',\n region: 'region',\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/cx-api.Environment", "kind": "interface", "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 612 }, "name": "Environment", "properties": [ { "abstract": true, "docs": { "stability": "deprecated", "summary": "The AWS account this environment deploys into." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 616 }, "name": "account", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "deprecated", "summary": "The arbitrary name of this environment (user-set, or at least user-meaningful)." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 614 }, "name": "name", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "deprecated", "summary": "The AWS region name where this environment deploys into." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 618 }, "name": "region", "type": { "primitive": "string" } } ], "symbolId": "lib/legacy-moved:Environment" }, "@aws-cdk/cx-api.EnvironmentPlaceholderValues": { "assembly": "@aws-cdk/cx-api", "datatype": true, "docs": { "deprecated": "The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.", "stability": "deprecated", "summary": "Return the appropriate values for the environment placeholders.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cx_api from '@aws-cdk/cx-api';\nconst environmentPlaceholderValues: cx_api.EnvironmentPlaceholderValues = {\n accountId: 'accountId',\n partition: 'partition',\n region: 'region',\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/cx-api.EnvironmentPlaceholderValues", "kind": "interface", "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 770 }, "name": "EnvironmentPlaceholderValues", "properties": [ { "abstract": true, "docs": { "stability": "deprecated", "summary": "Return the account." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 778 }, "name": "accountId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "deprecated", "summary": "Return the partition." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 782 }, "name": "partition", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "deprecated", "summary": "Return the region." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 774 }, "name": "region", "type": { "primitive": "string" } } ], "symbolId": "lib/legacy-moved:EnvironmentPlaceholderValues" }, "@aws-cdk/cx-api.EnvironmentPlaceholders": { "assembly": "@aws-cdk/cx-api", "docs": { "deprecated": "The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.", "remarks": "These can occur both in the Asset Manifest as well as the general\nCloud Assembly manifest.", "stability": "deprecated", "summary": "Placeholders which can be used manifests.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cx_api from '@aws-cdk/cx-api';\nconst environmentPlaceholders = new cx_api.EnvironmentPlaceholders();", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/cx-api.EnvironmentPlaceholders", "initializer": { "docs": { "stability": "stable" } }, "kind": "class", "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 737 }, "methods": [ { "docs": { "remarks": "Duplicated between cdk-assets and aws-cdk CLI because we don't have a good single place to put it\n(they're nominally independent tools).", "stability": "deprecated", "summary": "Replace the environment placeholders in all strings found in a complex object." }, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 756 }, "name": "replace", "parameters": [ { "name": "object", "type": { "primitive": "any" } }, { "name": "values", "type": { "fqn": "@aws-cdk/cx-api.EnvironmentPlaceholderValues" } } ], "returns": { "type": { "primitive": "any" } }, "static": true }, { "async": true, "docs": { "stability": "deprecated", "summary": "Like 'replace', but asynchronous." }, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 760 }, "name": "replaceAsync", "parameters": [ { "name": "object", "type": { "primitive": "any" } }, { "name": "provider", "type": { "fqn": "@aws-cdk/cx-api.IEnvironmentPlaceholderProvider" } } ], "returns": { "type": { "primitive": "any" } }, "static": true } ], "name": "EnvironmentPlaceholders", "properties": [ { "const": true, "docs": { "stability": "deprecated", "summary": "Insert this into the destination fields to be replaced with the current account." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 745 }, "name": "CURRENT_ACCOUNT", "static": true, "type": { "primitive": "string" } }, { "const": true, "docs": { "stability": "deprecated", "summary": "Insert this into the destination fields to be replaced with the current partition." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 749 }, "name": "CURRENT_PARTITION", "static": true, "type": { "primitive": "string" } }, { "const": true, "docs": { "stability": "deprecated", "summary": "Insert this into the destination fields to be replaced with the current region." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 741 }, "name": "CURRENT_REGION", "static": true, "type": { "primitive": "string" } } ], "symbolId": "lib/legacy-moved:EnvironmentPlaceholders" }, "@aws-cdk/cx-api.EnvironmentUtils": { "assembly": "@aws-cdk/cx-api", "docs": { "deprecated": "The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.", "stability": "deprecated", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cx_api from '@aws-cdk/cx-api';\nconst environmentUtils = new cx_api.EnvironmentUtils();", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/cx-api.EnvironmentUtils", "initializer": { "docs": { "stability": "stable" } }, "kind": "class", "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 807 }, "methods": [ { "docs": { "stability": "deprecated", "summary": "Format an environment string from an account and region." }, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 816 }, "name": "format", "parameters": [ { "name": "account", "type": { "primitive": "string" } }, { "name": "region", "type": { "primitive": "string" } } ], "returns": { "type": { "primitive": "string" } }, "static": true }, { "docs": { "stability": "deprecated", "summary": "Build an environment object from an account and region." }, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 812 }, "name": "make", "parameters": [ { "name": "account", "type": { "primitive": "string" } }, { "name": "region", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/cx-api.Environment" } }, "static": true }, { "docs": { "stability": "deprecated" }, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 808 }, "name": "parse", "parameters": [ { "name": "environment", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/cx-api.Environment" } }, "static": true } ], "name": "EnvironmentUtils", "symbolId": "lib/legacy-moved:EnvironmentUtils" }, "@aws-cdk/cx-api.IEnvironmentPlaceholderProvider": { "assembly": "@aws-cdk/cx-api", "docs": { "deprecated": "The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.", "stability": "deprecated", "summary": "Return the appropriate values for the environment placeholders." }, "fqn": "@aws-cdk/cx-api.IEnvironmentPlaceholderProvider", "kind": "interface", "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 789 }, "methods": [ { "abstract": true, "async": true, "docs": { "stability": "deprecated", "summary": "Return the account." }, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 797 }, "name": "accountId", "returns": { "type": { "primitive": "string" } } }, { "abstract": true, "async": true, "docs": { "stability": "deprecated", "summary": "Return the partition." }, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 801 }, "name": "partition", "returns": { "type": { "primitive": "string" } } }, { "abstract": true, "async": true, "docs": { "stability": "deprecated", "summary": "Return the region." }, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 793 }, "name": "region", "returns": { "type": { "primitive": "string" } } } ], "name": "IEnvironmentPlaceholderProvider", "symbolId": "lib/legacy-moved:IEnvironmentPlaceholderProvider" }, "@aws-cdk/cx-api.KeyContextResponse": { "assembly": "@aws-cdk/cx-api", "datatype": true, "docs": { "deprecated": "The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.", "stability": "deprecated", "summary": "Properties of a discovered key.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cx_api from '@aws-cdk/cx-api';\nconst keyContextResponse: cx_api.KeyContextResponse = {\n keyId: 'keyId',\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/cx-api.KeyContextResponse", "kind": "interface", "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 1074 }, "name": "KeyContextResponse", "properties": [ { "abstract": true, "docs": { "stability": "deprecated", "summary": "Id of the key." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 1078 }, "name": "keyId", "type": { "primitive": "string" } } ], "symbolId": "lib/legacy-moved:KeyContextResponse" }, "@aws-cdk/cx-api.LoadBalancerContextResponse": { "assembly": "@aws-cdk/cx-api", "datatype": true, "docs": { "deprecated": "The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.", "stability": "deprecated", "summary": "Properties of a discovered load balancer.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cx_api from '@aws-cdk/cx-api';\nconst loadBalancerContextResponse: cx_api.LoadBalancerContextResponse = {\n ipAddressType: cx_api.LoadBalancerIpAddressType.IPV4,\n loadBalancerArn: 'loadBalancerArn',\n loadBalancerCanonicalHostedZoneId: 'loadBalancerCanonicalHostedZoneId',\n loadBalancerDnsName: 'loadBalancerDnsName',\n securityGroupIds: ['securityGroupIds'],\n vpcId: 'vpcId',\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/cx-api.LoadBalancerContextResponse", "kind": "interface", "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 1023 }, "name": "LoadBalancerContextResponse", "properties": [ { "abstract": true, "docs": { "stability": "deprecated", "summary": "Type of IP address." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 1039 }, "name": "ipAddressType", "type": { "fqn": "@aws-cdk/cx-api.LoadBalancerIpAddressType" } }, { "abstract": true, "docs": { "stability": "deprecated", "summary": "The ARN of the load balancer." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 1027 }, "name": "loadBalancerArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "deprecated", "summary": "The hosted zone ID of the load balancer's name." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 1031 }, "name": "loadBalancerCanonicalHostedZoneId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "deprecated", "summary": "Load balancer's DNS name." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 1035 }, "name": "loadBalancerDnsName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "deprecated", "summary": "Load balancer's security groups." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 1043 }, "name": "securityGroupIds", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "stability": "deprecated", "summary": "Load balancer's VPC." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 1047 }, "name": "vpcId", "type": { "primitive": "string" } } ], "symbolId": "lib/legacy-moved:LoadBalancerContextResponse" }, "@aws-cdk/cx-api.LoadBalancerIpAddressType": { "assembly": "@aws-cdk/cx-api", "docs": { "deprecated": "The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.", "stability": "deprecated", "summary": "Load balancer ip address type." }, "fqn": "@aws-cdk/cx-api.LoadBalancerIpAddressType", "kind": "enum", "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 1004 }, "members": [ { "docs": { "stability": "deprecated", "summary": "IPV4 ip address." }, "name": "IPV4" }, { "docs": { "stability": "deprecated", "summary": "Dual stack address." }, "name": "DUAL_STACK" }, { "docs": { "stability": "deprecated", "summary": "IPv6 only public addresses, with private IPv4 and IPv6 addresses." }, "name": "DUAL_STACK_WITHOUT_PUBLIC_IPV4" } ], "name": "LoadBalancerIpAddressType", "symbolId": "lib/legacy-moved:LoadBalancerIpAddressType" }, "@aws-cdk/cx-api.LoadBalancerListenerContextResponse": { "assembly": "@aws-cdk/cx-api", "datatype": true, "docs": { "deprecated": "The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.", "stability": "deprecated", "summary": "Properties of a discovered load balancer listener.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cx_api from '@aws-cdk/cx-api';\nconst loadBalancerListenerContextResponse: cx_api.LoadBalancerListenerContextResponse = {\n listenerArn: 'listenerArn',\n listenerPort: 123,\n securityGroupIds: ['securityGroupIds'],\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/cx-api.LoadBalancerListenerContextResponse", "kind": "interface", "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 1054 }, "name": "LoadBalancerListenerContextResponse", "properties": [ { "abstract": true, "docs": { "stability": "deprecated", "summary": "The ARN of the listener." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 1058 }, "name": "listenerArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "deprecated", "summary": "The port the listener is listening on." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 1062 }, "name": "listenerPort", "type": { "primitive": "number" } }, { "abstract": true, "docs": { "stability": "deprecated", "summary": "The security groups of the load balancer." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 1066 }, "name": "securityGroupIds", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "lib/legacy-moved:LoadBalancerListenerContextResponse" }, "@aws-cdk/cx-api.MetadataEntry": { "assembly": "@aws-cdk/cx-api", "datatype": true, "docs": { "custom": { "aws-cdk": "/core library.", "exampleMetadata": "fixture=_generated" }, "deprecated": "The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.", "remarks": "This is necessary because its used as an input in the stable", "see": "core.ConstructNode.metadata", "stability": "deprecated", "summary": "Backwards compatibility for when `MetadataEntry` was defined here.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cx_api from '@aws-cdk/cx-api';\nconst metadataEntry: cx_api.MetadataEntry = {\n type: 'type',\n\n // the properties below are optional\n data: 'data',\n trace: ['trace'],\n};" }, "fqn": "@aws-cdk/cx-api.MetadataEntry", "interfaces": [ "@aws-cdk/cloud-assembly-schema.MetadataEntry" ], "kind": "interface", "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 1109 }, "name": "MetadataEntry", "symbolId": "lib/legacy-moved:MetadataEntry" }, "@aws-cdk/cx-api.MetadataEntryResult": { "assembly": "@aws-cdk/cx-api", "datatype": true, "docs": { "deprecated": "The official definition of this type has moved to `@aws-cdk/cloud-assembly-api`.", "stability": "deprecated", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cx_api from '@aws-cdk/cx-api';\nconst metadataEntryResult: cx_api.MetadataEntryResult = {\n path: 'path',\n type: 'type',\n\n // the properties below are optional\n data: 'data',\n trace: ['trace'],\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/cx-api.MetadataEntryResult", "interfaces": [ "@aws-cdk/cloud-assembly-schema.MetadataEntry" ], "kind": "interface", "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 600 }, "name": "MetadataEntryResult", "properties": [ { "abstract": true, "docs": { "stability": "deprecated", "summary": "The path in which this entry was defined." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 604 }, "name": "path", "type": { "primitive": "string" } } ], "symbolId": "lib/legacy-moved:MetadataEntryResult" }, "@aws-cdk/cx-api.MissingContext": { "assembly": "@aws-cdk/cx-api", "datatype": true, "docs": { "deprecated": "Use `stack.reportMissingContextKey()` instead", "stability": "deprecated", "summary": "Properties to `stack.reportMissingContext().", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cx_api from '@aws-cdk/cx-api';\n\ndeclare const props: any;\nconst missingContext: cx_api.MissingContext = {\n key: 'key',\n props: {\n propsKey: props,\n },\n provider: 'provider',\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/cx-api.MissingContext", "kind": "interface", "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 125 }, "name": "MissingContext", "properties": [ { "abstract": true, "docs": { "stability": "deprecated", "summary": "The missing context key." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 129 }, "name": "key", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "(This is the old untyped definition, which is necessary for backwards compatibility.\nSee cxschema for a type definition.)", "stability": "deprecated", "summary": "A set of provider-specific options." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 143 }, "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "abstract": true, "docs": { "remarks": "(This is the old untyped definition, which is necessary for backwards compatibility.\nSee cxschema for a type definition.)", "stability": "deprecated", "summary": "The provider from which we expect this context key to be obtained." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 136 }, "name": "provider", "type": { "primitive": "string" } } ], "symbolId": "lib/legacy-moved:MissingContext" }, "@aws-cdk/cx-api.NestedCloudAssemblyArtifact": { "assembly": "@aws-cdk/cx-api", "base": "@aws-cdk/cx-api.CloudArtifact", "docs": { "stability": "stable", "summary": "Asset manifest is a description of a set of assets which need to be built and published.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nimport * as cx_api from '@aws-cdk/cx-api';\n\ndeclare const assumeRoleAdditionalOptions: any;\ndeclare const cloudAssembly: cx_api.CloudAssembly;\nconst nestedCloudAssemblyArtifact = new cx_api.NestedCloudAssemblyArtifact(cloudAssembly, 'name', {\n type: cloud_assembly_schema.ArtifactType.NONE,\n\n // the properties below are optional\n additionalMetadataFile: 'additionalMetadataFile',\n dependencies: ['dependencies'],\n displayName: 'displayName',\n environment: 'environment',\n metadata: {\n metadataKey: [{\n type: 'type',\n\n // the properties below are optional\n data: 'data',\n trace: ['trace'],\n }],\n },\n properties: {\n templateFile: 'templateFile',\n\n // the properties below are optional\n assumeRoleAdditionalOptions: {\n assumeRoleAdditionalOptionsKey: assumeRoleAdditionalOptions,\n },\n assumeRoleArn: 'assumeRoleArn',\n assumeRoleExternalId: 'assumeRoleExternalId',\n bootstrapStackVersionSsmParameter: 'bootstrapStackVersionSsmParameter',\n cloudFormationExecutionRoleArn: 'cloudFormationExecutionRoleArn',\n lookupRole: {\n arn: 'arn',\n\n // the properties below are optional\n assumeRoleAdditionalOptions: {\n assumeRoleAdditionalOptionsKey: assumeRoleAdditionalOptions,\n },\n assumeRoleExternalId: 'assumeRoleExternalId',\n bootstrapStackVersionSsmParameter: 'bootstrapStackVersionSsmParameter',\n requiresBootstrapStackVersion: 123,\n },\n notificationArns: ['notificationArns'],\n parameters: {\n parametersKey: 'parameters',\n },\n requiresBootstrapStackVersion: 123,\n stackName: 'stackName',\n stackTemplateAssetObjectUrl: 'stackTemplateAssetObjectUrl',\n tags: {\n tagsKey: 'tags',\n },\n terminationProtection: false,\n validateOnSynth: false,\n },\n});", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/cx-api.NestedCloudAssemblyArtifact", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 565 }, "parameters": [ { "name": "assembly", "type": { "fqn": "@aws-cdk/cx-api.CloudAssembly" } }, { "name": "name", "type": { "primitive": "string" } }, { "name": "artifact", "type": { "fqn": "@aws-cdk/cloud-assembly-schema.ArtifactManifest" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 534 }, "methods": [ { "docs": { "remarks": "Use this method instead of `instanceof` to properly detect `NestedCloudAssemblyArtifact`\ninstances, even when the construct library is symlinked.\n\nExplanation: in JavaScript, multiple copies of the `cx-api` library on\ndisk are seen as independent, completely different libraries. As a\nconsequence, the class `NestedCloudAssemblyArtifact` in each copy of the `cx-api` library\nis seen as a different class, and an instance of one class will not test as\n`instanceof` the other class. `npm install` will not create installations\nlike this, but users may manually symlink construct libraries together or\nuse a monorepo tool: in those cases, multiple copies of the `cx-api`\nlibrary can be accidentally installed, and `instanceof` will behave\nunpredictably. It is safest to avoid using `instanceof`, and using\nthis type-testing method instead.", "stability": "stable", "summary": "Checks if `art` is an instance of this class." }, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 552 }, "name": "isNestedCloudAssemblyArtifact", "parameters": [ { "name": "art", "type": { "primitive": "any" } } ], "returns": { "type": { "primitive": "boolean" } }, "static": true } ], "name": "NestedCloudAssemblyArtifact", "properties": [ { "docs": { "stability": "stable", "summary": "The relative directory name of the asset manifest." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 556 }, "name": "directoryName", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "Display name." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 560 }, "name": "displayName", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "Full path to the nested assembly directory." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 569 }, "name": "fullPath", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The nested Assembly." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 564 }, "name": "nestedAssembly", "type": { "fqn": "@aws-cdk/cx-api.CloudAssembly" } } ], "symbolId": "lib/legacy-moved:NestedCloudAssemblyArtifact" }, "@aws-cdk/cx-api.RuntimeInfo": { "assembly": "@aws-cdk/cx-api", "datatype": true, "docs": { "custom": { "aws-cdk": "/core library.", "exampleMetadata": "fixture=_generated" }, "deprecated": "moved to package 'cloud-assembly-schema'", "remarks": "This is necessary because its used as an input in the stable", "see": "core.ConstructNode.synth", "stability": "deprecated", "summary": "Backwards compatibility for when `RuntimeInfo` was defined here.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cx_api from '@aws-cdk/cx-api';\nconst runtimeInfo: cx_api.RuntimeInfo = {\n libraries: {\n librariesKey: 'libraries',\n },\n};" }, "fqn": "@aws-cdk/cx-api.RuntimeInfo", "interfaces": [ "@aws-cdk/cloud-assembly-schema.RuntimeInfo" ], "kind": "interface", "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 726 }, "name": "RuntimeInfo", "symbolId": "lib/legacy-moved:RuntimeInfo" }, "@aws-cdk/cx-api.SecurityGroupContextResponse": { "assembly": "@aws-cdk/cx-api", "datatype": true, "docs": { "deprecated": "The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.", "stability": "deprecated", "summary": "Properties of a discovered SecurityGroup.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cx_api from '@aws-cdk/cx-api';\nconst securityGroupContextResponse: cx_api.SecurityGroupContextResponse = {\n allowAllOutbound: false,\n securityGroupId: 'securityGroupId',\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/cx-api.SecurityGroupContextResponse", "kind": "interface", "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 825 }, "name": "SecurityGroupContextResponse", "properties": [ { "abstract": true, "docs": { "remarks": "This will be true\nwhen the security group has all-protocol egress permissions to access both\n`0.0.0.0/0` and `::/0`.", "stability": "deprecated", "summary": "Whether the security group allows all outbound traffic." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 835 }, "name": "allowAllOutbound", "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "stability": "deprecated", "summary": "The security group's id." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 829 }, "name": "securityGroupId", "type": { "primitive": "string" } } ], "symbolId": "lib/legacy-moved:SecurityGroupContextResponse" }, "@aws-cdk/cx-api.SynthesisMessage": { "assembly": "@aws-cdk/cx-api", "datatype": true, "docs": { "deprecated": "The official definition of this type has moved to `@aws-cdk/cloud-assembly-api`.", "stability": "deprecated", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cx_api from '@aws-cdk/cx-api';\nconst synthesisMessage: cx_api.SynthesisMessage = {\n entry: {\n type: 'type',\n\n // the properties below are optional\n data: 'data',\n trace: ['trace'],\n },\n id: 'id',\n level: cx_api.SynthesisMessageLevel.INFO,\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/cx-api.SynthesisMessage", "kind": "interface", "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 105 }, "name": "SynthesisMessage", "properties": [ { "abstract": true, "docs": { "stability": "deprecated" }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 108 }, "name": "entry", "type": { "fqn": "@aws-cdk/cloud-assembly-schema.MetadataEntry" } }, { "abstract": true, "docs": { "stability": "deprecated" }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 107 }, "name": "id", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "deprecated" }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 106 }, "name": "level", "type": { "fqn": "@aws-cdk/cx-api.SynthesisMessageLevel" } } ], "symbolId": "lib/legacy-moved:SynthesisMessage" }, "@aws-cdk/cx-api.SynthesisMessageLevel": { "assembly": "@aws-cdk/cx-api", "docs": { "deprecated": "The official definition of this type has moved to `@aws-cdk/cloud-assembly-api`.", "stability": "deprecated" }, "fqn": "@aws-cdk/cx-api.SynthesisMessageLevel", "kind": "enum", "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 114 }, "members": [ { "docs": { "stability": "deprecated" }, "name": "INFO" }, { "docs": { "stability": "deprecated" }, "name": "WARNING" }, { "docs": { "stability": "deprecated" }, "name": "ERROR" } ], "name": "SynthesisMessageLevel", "symbolId": "lib/legacy-moved:SynthesisMessageLevel" }, "@aws-cdk/cx-api.TreeCloudArtifact": { "assembly": "@aws-cdk/cx-api", "base": "@aws-cdk/cx-api.CloudArtifact", "docs": { "stability": "stable", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nimport * as cx_api from '@aws-cdk/cx-api';\n\ndeclare const assumeRoleAdditionalOptions: any;\ndeclare const cloudAssembly: cx_api.CloudAssembly;\nconst treeCloudArtifact = new cx_api.TreeCloudArtifact(cloudAssembly, 'name', {\n type: cloud_assembly_schema.ArtifactType.NONE,\n\n // the properties below are optional\n additionalMetadataFile: 'additionalMetadataFile',\n dependencies: ['dependencies'],\n displayName: 'displayName',\n environment: 'environment',\n metadata: {\n metadataKey: [{\n type: 'type',\n\n // the properties below are optional\n data: 'data',\n trace: ['trace'],\n }],\n },\n properties: {\n templateFile: 'templateFile',\n\n // the properties below are optional\n assumeRoleAdditionalOptions: {\n assumeRoleAdditionalOptionsKey: assumeRoleAdditionalOptions,\n },\n assumeRoleArn: 'assumeRoleArn',\n assumeRoleExternalId: 'assumeRoleExternalId',\n bootstrapStackVersionSsmParameter: 'bootstrapStackVersionSsmParameter',\n cloudFormationExecutionRoleArn: 'cloudFormationExecutionRoleArn',\n lookupRole: {\n arn: 'arn',\n\n // the properties below are optional\n assumeRoleAdditionalOptions: {\n assumeRoleAdditionalOptionsKey: assumeRoleAdditionalOptions,\n },\n assumeRoleExternalId: 'assumeRoleExternalId',\n bootstrapStackVersionSsmParameter: 'bootstrapStackVersionSsmParameter',\n requiresBootstrapStackVersion: 123,\n },\n notificationArns: ['notificationArns'],\n parameters: {\n parametersKey: 'parameters',\n },\n requiresBootstrapStackVersion: 123,\n stackName: 'stackName',\n stackTemplateAssetObjectUrl: 'stackTemplateAssetObjectUrl',\n tags: {\n tagsKey: 'tags',\n },\n terminationProtection: false,\n validateOnSynth: false,\n },\n});", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/cx-api.TreeCloudArtifact", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 593 }, "parameters": [ { "name": "assembly", "type": { "fqn": "@aws-cdk/cx-api.CloudAssembly" } }, { "name": "name", "type": { "primitive": "string" } }, { "name": "artifact", "type": { "fqn": "@aws-cdk/cloud-assembly-schema.ArtifactManifest" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 573 }, "methods": [ { "docs": { "remarks": "Use this method instead of `instanceof` to properly detect `TreeCloudArtifact`\ninstances, even when the construct library is symlinked.\n\nExplanation: in JavaScript, multiple copies of the `cx-api` library on\ndisk are seen as independent, completely different libraries. As a\nconsequence, the class `TreeCloudArtifact` in each copy of the `cx-api` library\nis seen as a different class, and an instance of one class will not test as\n`instanceof` the other class. `npm install` will not create installations\nlike this, but users may manually symlink construct libraries together or\nuse a monorepo tool: in those cases, multiple copies of the `cx-api`\nlibrary can be accidentally installed, and `instanceof` will behave\nunpredictably. It is safest to avoid using `instanceof`, and using\nthis type-testing method instead.", "stability": "stable", "summary": "Checks if `art` is an instance of this class." }, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 591 }, "name": "isTreeCloudArtifact", "parameters": [ { "name": "art", "type": { "primitive": "any" } } ], "returns": { "type": { "primitive": "boolean" } }, "static": true } ], "name": "TreeCloudArtifact", "properties": [ { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 592 }, "name": "file", "type": { "primitive": "string" } } ], "symbolId": "lib/legacy-moved:TreeCloudArtifact" }, "@aws-cdk/cx-api.VpcContextResponse": { "assembly": "@aws-cdk/cx-api", "datatype": true, "docs": { "deprecated": "The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.", "stability": "deprecated", "summary": "Properties of a discovered VPC.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cx_api from '@aws-cdk/cx-api';\nconst vpcContextResponse: cx_api.VpcContextResponse = {\n availabilityZones: ['availabilityZones'],\n vpcId: 'vpcId',\n\n // the properties below are optional\n isolatedSubnetIds: ['isolatedSubnetIds'],\n isolatedSubnetNames: ['isolatedSubnetNames'],\n isolatedSubnetRouteTableIds: ['isolatedSubnetRouteTableIds'],\n ownerAccountId: 'ownerAccountId',\n privateSubnetIds: ['privateSubnetIds'],\n privateSubnetNames: ['privateSubnetNames'],\n privateSubnetRouteTableIds: ['privateSubnetRouteTableIds'],\n publicSubnetIds: ['publicSubnetIds'],\n publicSubnetNames: ['publicSubnetNames'],\n publicSubnetRouteTableIds: ['publicSubnetRouteTableIds'],\n region: 'region',\n subnetGroups: [{\n name: 'name',\n subnets: [{\n availabilityZone: 'availabilityZone',\n routeTableId: 'routeTableId',\n subnetId: 'subnetId',\n\n // the properties below are optional\n cidr: 'cidr',\n }],\n type: cx_api.VpcSubnetGroupType.PUBLIC,\n }],\n vpcCidrBlock: 'vpcCidrBlock',\n vpnGatewayId: 'vpnGatewayId',\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/cx-api.VpcContextResponse", "kind": "interface", "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 902 }, "name": "VpcContextResponse", "properties": [ { "abstract": true, "docs": { "stability": "deprecated", "summary": "AZs." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 916 }, "name": "availabilityZones", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "stability": "deprecated", "summary": "VPC id." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 906 }, "name": "vpcId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "Element count: #(availabilityZones) · #(isolatedGroups)", "stability": "deprecated", "summary": "IDs of all isolated subnets." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 958 }, "name": "isolatedSubnetIds", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "remarks": "Element count: #(isolatedGroups)", "stability": "deprecated", "summary": "Name of isolated subnet groups." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 964 }, "name": "isolatedSubnetNames", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "remarks": "Element count: #(availabilityZones) · #(isolatedGroups)", "stability": "deprecated", "summary": "Route Table IDs of isolated subnet groups." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 970 }, "name": "isolatedSubnetRouteTableIds", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "the account id of the parent stack", "stability": "deprecated", "summary": "The ID of the AWS account that owns the VPC." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 996 }, "name": "ownerAccountId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "Element count: #(availabilityZones) · #(privateGroups)", "stability": "deprecated", "summary": "IDs of all private subnets." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 940 }, "name": "privateSubnetIds", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "remarks": "Element count: #(privateGroups)", "stability": "deprecated", "summary": "Name of private subnet groups." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 946 }, "name": "privateSubnetNames", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "remarks": "Element count: #(availabilityZones) · #(privateGroups)", "stability": "deprecated", "summary": "Route Table IDs of private subnet groups." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 952 }, "name": "privateSubnetRouteTableIds", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "remarks": "Element count: #(availabilityZones) · #(publicGroups)", "stability": "deprecated", "summary": "IDs of all public subnets." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 922 }, "name": "publicSubnetIds", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "remarks": "Element count: #(publicGroups)", "stability": "deprecated", "summary": "Name of public subnet groups." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 928 }, "name": "publicSubnetNames", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "remarks": "Element count: #(availabilityZones) · #(publicGroups)", "stability": "deprecated", "summary": "Route Table IDs of public subnet groups." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 934 }, "name": "publicSubnetRouteTableIds", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- Region of the parent stack", "stability": "deprecated", "summary": "The region in which the VPC is in." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 990 }, "name": "region", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- no subnet groups will be returned unless `VpcContextQuery.returnAsymmetricSubnets` is true", "remarks": "Unlike the above properties, this will include asymmetric subnets,\nif the VPC has any.\nThis property will only be populated if `VpcContextQuery.returnAsymmetricSubnets`\nis true.", "stability": "deprecated", "summary": "The subnet groups discovered for the given VPC." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 984 }, "name": "subnetGroups", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/cx-api.VpcSubnetGroup" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- CIDR information not available", "stability": "deprecated", "summary": "VPC cidr." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 912 }, "name": "vpcCidrBlock", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "deprecated", "summary": "The VPN gateway ID." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 974 }, "name": "vpnGatewayId", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/legacy-moved:VpcContextResponse" }, "@aws-cdk/cx-api.VpcSubnet": { "assembly": "@aws-cdk/cx-api", "datatype": true, "docs": { "deprecated": "The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.", "stability": "deprecated", "summary": "A subnet representation that the VPC provider uses.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cx_api from '@aws-cdk/cx-api';\nconst vpcSubnet: cx_api.VpcSubnet = {\n availabilityZone: 'availabilityZone',\n routeTableId: 'routeTableId',\n subnetId: 'subnetId',\n\n // the properties below are optional\n cidr: 'cidr',\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/cx-api.VpcSubnet", "kind": "interface", "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 858 }, "name": "VpcSubnet", "properties": [ { "abstract": true, "docs": { "stability": "deprecated", "summary": "The code of the availability zone this subnet is in (for example, 'us-west-2a')." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 865 }, "name": "availabilityZone", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "deprecated", "summary": "The identifier of the route table for this subnet." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 867 }, "name": "routeTableId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "deprecated", "summary": "The identifier of the subnet." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 860 }, "name": "subnetId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- CIDR information not available", "stability": "deprecated", "summary": "CIDR range of the subnet." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 873 }, "name": "cidr", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/legacy-moved:VpcSubnet" }, "@aws-cdk/cx-api.VpcSubnetGroup": { "assembly": "@aws-cdk/cx-api", "datatype": true, "docs": { "deprecated": "The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.", "remarks": "The included subnets do NOT have to be symmetric!", "stability": "deprecated", "summary": "A group of subnets returned by the VPC provider.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cx_api from '@aws-cdk/cx-api';\nconst vpcSubnetGroup: cx_api.VpcSubnetGroup = {\n name: 'name',\n subnets: [{\n availabilityZone: 'availabilityZone',\n routeTableId: 'routeTableId',\n subnetId: 'subnetId',\n\n // the properties below are optional\n cidr: 'cidr',\n }],\n type: cx_api.VpcSubnetGroupType.PUBLIC,\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/cx-api.VpcSubnetGroup", "kind": "interface", "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 881 }, "name": "VpcSubnetGroup", "properties": [ { "abstract": true, "docs": { "stability": "deprecated", "summary": "The name of the subnet group, determined by looking at the tags of of the subnets that belong to it." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 887 }, "name": "name", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "There is no condition that the subnets have to be symmetric\nin the group.", "stability": "deprecated", "summary": "The subnets that are part of this group." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 895 }, "name": "subnets", "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/cx-api.VpcSubnet" }, "kind": "array" } } }, { "abstract": true, "docs": { "stability": "deprecated", "summary": "The type of the subnet group." }, "immutable": true, "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 889 }, "name": "type", "type": { "fqn": "@aws-cdk/cx-api.VpcSubnetGroupType" } } ], "symbolId": "lib/legacy-moved:VpcSubnetGroup" }, "@aws-cdk/cx-api.VpcSubnetGroupType": { "assembly": "@aws-cdk/cx-api", "docs": { "deprecated": "The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.", "remarks": "Same as SubnetType in the aws-cdk-lib/aws-ec2 package,\nbut we can't use that because of cyclical dependencies.", "stability": "deprecated", "summary": "The type of subnet group." }, "fqn": "@aws-cdk/cx-api.VpcSubnetGroupType", "kind": "enum", "locationInModule": { "filename": "lib/legacy-moved.ts", "line": 845 }, "members": [ { "docs": { "stability": "deprecated", "summary": "Public subnet group type." }, "name": "PUBLIC" }, { "docs": { "stability": "deprecated", "summary": "Private subnet group type." }, "name": "PRIVATE" }, { "docs": { "stability": "deprecated", "summary": "Isolated subnet group type." }, "name": "ISOLATED" } ], "name": "VpcSubnetGroupType", "symbolId": "lib/legacy-moved:VpcSubnetGroupType" } }, "version": "2.250.0", "fingerprint": "**********" }