cxapi

package

v2.252.0 Latest Latest Go to latest Published: Apr 30, 2026 License: Apache-2.0 Imports: 6 Imported by: 4

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/aws/aws-cdk-go

Links

Open Source Insights

README ¶

Cloud Executable API

This module is part of the AWS Cloud Development Kit project.

V2 Feature Flags

@aws-cdk/aws-s3:createDefaultLoggingPolicy

Enable this feature flag to create an S3 bucket policy by default in cases where an AWS service would automatically create the Policy if one does not exist.

For example, in order to send VPC flow logs to an S3 bucket, there is a specific Bucket Policy that needs to be attached to the bucket. If you create the bucket without a policy and then add the bucket as the flow log destination, the service will automatically create the bucket policy with the necessary permissions. If you were to then try and add your own bucket policy CloudFormation will throw and error indicating that a bucket policy already exists.

In cases where we know what the required policy is we can go ahead and create the policy so we can remain in control of it.

https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html#AWS-logs-infrastructure-S3

cdk.json

{
  "context": {
    "@aws-cdk/aws-s3:createDefaultLoggingPolicy": true
  }
}

@aws-cdk/aws-sns-subscriptions:restrictSqsDescryption

Enable this feature flag to restrict the decryption of a SQS queue, which is subscribed to a SNS topic, to only the topic which it is subscribed to and not the whole SNS service of an account.

Previously the decryption was only restricted to the SNS service principal. To make the SQS subscription more secure, it is a good practice to restrict the decryption further and only allow the connected SNS topic to decryption the subscribed queue.

cdk.json

{
  "context": {
    "@aws-cdk/aws-sns-subscriptions:restrictSqsDescryption": true
  }
}

@aws-cdk/aws-apigateway:disableCloudWatchRole

Enable this feature flag to change the default behavior for aws-apigateway.RestApi and aws-apigateway.SpecRestApi to not create a CloudWatch role and Account. There is only a single ApiGateway account per AWS environment which means that each time you create a RestApi in your account the ApiGateway account is overwritten. If at some point the newest RestApi is deleted, the ApiGateway Account and CloudWatch role will also be deleted, breaking any existing ApiGateways that were depending on them.

When this flag is enabled you should either create the ApiGateway account and CloudWatch role separately or only enable the cloudWatchRole on a single RestApi.

cdk.json

{
  "context": {
    "@aws-cdk/aws-apigateway:disableCloudWatchRole": true
  }
}

@aws-cdk/core:enablePartitionLiterals

Enable this feature flag to have Stack.partition return a literal string for a stack's partition when the stack has a known region configured. If the region is undefined, or set to an unknown value, the Stack.partition will be the CloudFormation intrinsic value AWS::Partition. Without this feature flag, Stack.partition always returns the CloudFormation intrinsic value AWS::Partition.

This feature will often simplify ARN strings in CDK generated templates, for example:

 Principal:
   AWS:
     Fn::Join:
       - ""
       - - "arn:"
         - Ref: AWS::Partition
         - :iam::123456789876:root

becomes:

 Principal:
   AWS: "arn:aws:iam::123456789876:root"

@aws-cdk/aws-ecs:disableExplicitDeploymentControllerForCircuitBreaker

Enable this feature flag to avoid setting the "ECS" deployment controller when adding a circuit breaker to an ECS Service, as this will trigger a full replacement which fails to deploy when using set service names. This does not change any behaviour as the default deployment controller when it is not defined is ECS.

cdk.json

{
  "context": {
    "@aws-cdk/aws-ecs:disableExplicitDeploymentControllerForCircuitBreaker": true
  }
}

@aws-cdk/aws-s3:serverAccessLogsUseBucketPolicy

Enable this feature flag to use S3 Bucket Policy for granting permission fo Server Access Logging rather than using the canned LogDeliveryWrite ACL. ACLs do not work when Object Ownership is enabled on the bucket.

This flag uses a Bucket Policy statement to allow Server Access Log delivery, following best practices for S3.

https://docs.aws.amazon.com/AmazonS3/latest/userguide/enable-server-access-logging.html

{
  "context": {
    "@aws-cdk/aws-s3:serverAccessLogsUseBucketPolicy": true
  }
}

@aws-cdk/aws-rds:databaseProxyUniqueResourceName

Enable this feature flag to use unique resource names for each DatabaseProxy.

Previously, the default behavior for DatabaseProxy was to use id of the constructor for dbProxyName. In this case, users couldn't deploy DatabaseProxys that have the same id in the same region.

This is a feature flag as the old behavior was technically incorrect, but users may have come to depend on it.

{
  "context": {
    "@aws-cdk/aws-rds:databaseProxyUniqueResourceName": true
  }
}

@aws-cdk/aws-redshift:columnId

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

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

cdk.json

{
  "context": {
    "@aws-cdk/aws-redshift:columnId": true
  }
}

@aws-cdk/aws-stepfunctions-tasks:enableEmrServicePolicyV2

Enable this feature flag to use the AmazonEMRServicePolicy_v2 managed policies for the EMR service role.

This is a feature flag as the old behavior will be deprecated, but some resources may require manual intervention since they might not have the appropriate tags propagated automatically.

https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-managed-iam-policies.html

cdk.json

{
  "context": {
    "@aws-cdk/aws-stepfunctions-tasks:enableEmrServicePolicyV2": true
  }
}

@aws-cdk/core:includePrefixInUniqueNameGeneration

Enable this feature flag to include the stack's prefixes to the name generation process.

Not doing so can cause the name of stack to exceed 128 characters:

The name generation ensures it doesn't exceed 128 characters
Without this feature flag, the prefix is prepended to the generated name, which result can exceed 128 characters

This is a feature flag as it changes the name generated for stacks. Any CDK application deployed prior this fix will most likely be generated with a new name, causing the stack to be recreated with the new name, and then deleting the old one. For applications running on production environments this can be unmanageable.

cdk.json

{
  "context": {
    "@aws-cdk/core:includePrefixInUniqueNameGeneration": true
  }
}

@aws-cdk/aws-lambda-nodejs:useLatestRuntimeVersion

Enable this feature flag to automatically use the latest available NodeJS version in the aws-lambda-nodejs.Function construct.

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

Functions defined previously will continue to function correctly as long as they pass an explicit runtime version, or do not exclude packages during bundling.

cdk.json

{
  "context": {
    "@aws-cdk/aws-lambda-nodejs:useLatestRuntimeVersion": true
  }
}

@aws-cdk/aws-codepipeline-actions:useNewDefaultBranchForCodeCommitSource

Enable this feature flag to update the default branch for CodeCommit source actions to main.

Previously, the default branch for CodeCommit source actions was set to master. However, this convention is no longer supported, and repositories created after March 2021 now have main as their default branch.

cdk.json

{
  "context": {
    "@aws-cdk/aws-codepipeline-actions:useNewDefaultBranchForCodeCommitSource": true
  }
}

@aws-cdk/aws-cloudwatch-actions:changeLambdaPermissionLogicalIdForLambdaAction

Enable this feature flag to change the logical ID of the LambdaPermission for the LambdaAction to include an alarm ID.

Previously, only one alarm with the LambdaAction could be created per Lambda. This flag allows multiple alarms with the LambdaAction for the same Lambda to be created.

cdk.json

{
  "context": {
    "@aws-cdk/aws-cloudwatch-actions:changeLambdaPermissionLogicalIdForLambdaAction": true
  }
}

@aws-cdk/aws-codepipeline:crossAccountKeysDefaultValueToFalse

Enables Pipeline to set the default value for crossAccountKeys to false.

When this feature flag is enabled, and the crossAccountKeys property is not provided in a Pipeline construct, the construct automatically defaults the value of this property to false.

cdk.json

{
  "context": {
    "@aws-cdk/aws-codepipeline:crossAccountKeysDefaultValueToFalse": true
  }
}

@aws-cdk/aws-codepipeline:defaultPipelineTypeToV2

Enables Pipeline to set the default pipeline type to V2.

When this feature flag is enabled, and the pipelineType property is not provided in a Pipeline construct, the construct automatically defaults the value of this property to PipelineType.V2.

cdk.json

{
  "context": {
    "@aws-cdk/aws-codepipeline:defaultPipelineTypeToV2": true
  }
}

@aws-cdk/aws-kms:reduceCrossAccountRegionPolicyScope

Reduce resource scope of the IAM Policy created from KMS key grant to granting key only.

When this feature flag is enabled and calling KMS key grant method, the created IAM policy will reduce the resource scope from '*' to this specific granting KMS key.

cdk.json

{
  "context": {
    "@aws-cdk/aws-kms:reduceCrossAccountRegionPolicyScope": true
  }
}

@aws-cdk/aws-kms:applyImportedAliasPermissionsToPrincipal

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

cdk.json

{
  "context": {
    "@aws-cdk/aws-kms:applyImportedAliasPermissionsToPrincipal": true
  }
}

@aws-cdk/aws-eks:nodegroupNameAttribute

When enabled, nodegroupName attribute of the provisioned EKS NodeGroup will not have the cluster name prefix.

When this feature flag is enabled, the nodegroupName attribute will be exactly the name of the nodegroup without any prefix.

cdk.json

{
  "context": {
    "@aws-cdk/aws-eks:nodegroupNameAttribute": true
  }
}

@aws-cdk/aws-ec2:ebsDefaultGp3Volume

When enabled, the default volume type of the EBS volume will be GP3.

When this featuer flag is enabled, the default volume type of the EBS volume will be EbsDeviceVolumeType.GENERAL_PURPOSE_SSD_GP3

cdk.json

{
  "context": {
    "@aws-cdk/aws-ec2:ebsDefaultGp3Volume": true
  }
}

@aws-cdk/aws-ecs:removeDefaultDeploymentAlarm

When enabled, remove default deployment alarm settings.

When this featuer flag is enabled, remove the default deployment alarm settings when creating a AWS ECS service.

cdk.json

{
  "context": {
    "@aws-cdk/aws-ec2:ebsDefaultGp3Volume": true
  }
}

@aws-cdk/aws-stepfunctions-tasks:ecsReduceRunTaskPermissions

When enabled, IAM Policy created to run tasks won't include the task definition ARN, only the revision ARN.

When this feature flag is enabled, the IAM Policy created to run tasks won't include the task definition ARN, only the revision ARN. The revision ARN is more specific than the task definition ARN. See https://docs.aws.amazon.com/step-functions/latest/dg/ecs-iam.html for more details.

cdk.json

{
  "context": {
    "@aws-cdk/aws-stepfunctions-tasks:ecsReduceRunTaskPermissions": true
  }
}

@aws-cdk/aws-stepfunctions-taks:useNewS3UriParametersForBedrockInvokeModelTask

When enabled, use new props for S3 URI under input and output fields in task definition of state machine for bedrock invoke model.

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

cdk.json

{
  "context": {
    "@aws-cdk/aws-stepfunctions-tasks:useNewS3UriParametersForBedrockInvokeModelTask": true
  }
}

@aws-cdk/aws-ecs:reduceEc2FargateCloudWatchPermissions

Currently, we will automatically add a number of cloudwatch permissions to the task role when no cloudwatch log group is specified as logConfiguration and it will grant 'Resources': ['*'] to the task role.

When this feature flag is enabled, we will only grant the necessary permissions when users specify cloudwatch log group.

cdk.json

{
  "context": {
    "@aws-cdk/aws-ecs:reduceEc2FargateCloudWatchPermissions": true
  }
}

@aws-cdk/aws-ec2:ec2SumTImeoutEnabled

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

When this feature flag is enabled, if both initOptions.timeout and resourceSignalTimeout are specified, the values will to be summed together.

cdk.json

{
  "context": {
    "@aws-cdk/aws-ec2:ec2SumTImeoutEnabled": true
  }
}

@aws-cdk/aws-appsync:appSyncGraphQLAPIScopeLambdaPermission

Currently, 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.

When this feature flag is enabled, the AWS::Lambda::Permission will be properly scoped with the SourceArn corresponding to the specific AppSync GraphQL API.

cdk.json

{
  "context": {
    "@aws-cdk/aws-ec2:appSyncGraphQLAPIScopeLambdaPermission": true
  }
}

@aws-cdk/aws-rds:setCorrectValueForDatabaseInstanceReadReplicaInstanceResourceId

When enabled, the value of property instanceResourceId in construct DatabaseInstanceReadReplica will be set to the correct value which is DbiResourceId instead of currently DbInstanceArn* (fix)

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

cdk.json

{
  "context": {
    "@aws-cdk/aws-rds:setCorrectValueForDatabaseInstanceReadReplicaInstanceResourceId": true
  }
}

@aws-cdk/aws-lambda-nodejs:sdkV3ExcludeSmithyPackages

Currently, when bundling Lambda functions with the non-latest runtime that supports AWS SDK JavaScript (v3), only the @aws-sdk/* packages are excluded by default. However, this can cause version mismatches between the @aws-sdk/* and @smithy/* packages, as they are tightly coupled dependencies in AWS SDK v3.

When this feature flag is enabled, both @aws-sdk/* and @smithy/* packages will be excluded during the bundling process. This ensures that no mismatches occur between these tightly coupled dependencies when using the AWS SDK v3 in Lambda functions.

cdk.json

{
  "context": {
    "@aws-cdk/aws-lambda-nodejs:sdkV3ExcludeSmithyPackages": true
  }
}

@aws-cdk/aws-dynamodb:resourcePolicyPerReplica

If this flag is not set, the default behavior for TableV2 is to use a different resourcePolicy for each replica.

If this flag is set to false, the behavior is that each replica shares the same resourcePolicy as the source table. This will prevent you from creating a new table which has an additional replica and a resource policy.

This is a feature flag as the old behavior was technically incorrect but users may have come to depend on it.

cdk.json

{
  "context": {
    "@aws-cdk/aws-dynamodb:resourcePolicyPerReplica": false,
  },
}

@aws-cdk/aws-route53-targets:userPoolDomainNameMethodWithoutCustomResource

When enabled, use a new method for DNS Name of user pool domain target without creating a custom resource.

When 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 creates a custom resource internally, but the new method doesn't need a custom resource.

If the flag is set to false then a custom resource will be created when using UserPoolDomainTarget.

cdk.json

{
  "context": {
    "@aws-cdk/aws-route53-targets:userPoolDomainNameMethodWithoutCustomResource": true
  }
}

@aws-cdk/aws-elasticloadbalancingV2:albDualstackWithoutPublicIpv4SecurityGroupRulesDefault

When enabled, the default security group ingress rules will allow IPv6 ingress from anywhere, For internet facing ALBs with dualstack-without-public-ipv4 IP address type, the default security group rules will allow IPv6 ingress from anywhere (::/0). Previously, the default security group rules would only allow IPv4 ingress.

Using a feature flag to make sure existing customers who might be relying on the overly restrictive permissions are not broken.,

If the flag is set to false then the default security group rules will only allow IPv4 ingress.

cdk.json

{
  "context": {
    "@aws-cdk/aws-elasticloadbalancingV2:albDualstackWithoutPublicIpv4SecurityGroupRulesDefault": true
  }
}

@aws-cdk/aws-iam:oidcRejectUnauthorizedConnections

When this feature flag is enabled, the default behaviour of OIDC Provider's custom resource handler will default to reject unauthorized connections when downloading CA Certificates.

When this feature flag is disabled, the behaviour will be the same as current and will allow downloading thumbprints from insecure connections.

cdk.json

{
  "context": {
    "@aws-cdk/aws-iam:oidcRejectUnauthorizedConnections": true
  }
}

@aws-cdk/core:enableAdditionalMetadataCollection

When this feature flag is enabled, CDK expands the scope of usage data collection to include the:

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.
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.
L2 construct method usage - Collection method name, parameter keys and parameter values of BOOL and ENUM type.

cdk.json

{
  "context": {
    "@aws-cdk/core:enableAdditionalMetadataCollection": true
  }
}

@aws-cdk/aws-lambda:createNewPoliciesWithAddToRolePolicy

[Deprecated default feature] When this feature flag is enabled, Lambda will create new inline policies with AddToRolePolicy. The purpose of this is to prevent lambda from creating a dependency on the Default Policy Statement. This 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. However 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. This 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. We recommend to unset the feature flag if already set which will restore the original behavior.

cdk.json

{
  "context": {
    "@aws-cdk/aws-lambda:createNewPoliciesWithAddToRolePolicy": false
  }
}

@aws-cdk/aws-s3:setUniqueReplicationRoleName

When this feature flag is enabled, a unique role name is specified only when performing cross-account replication. When disabled, 'CDKReplicationRole' is always specified.

cdk.json

{
  "context": {
    "@aws-cdk/aws-s3:setUniqueReplicationRoleName": true
  }
}

@aws-cdk/pipelines:reduceStageRoleTrustScope

When this feature flag is enabled, the root account principal will not be added to the trust policy of stage role. When this feature flag is disabled, it will keep the root account principal in the trust policy.

cdk.json

{
  "context": {
    "@aws-cdk/pipelines:reduceStageRoleTrustScope": true
  }
}

@aws-cdk/aws-events:requireEventBusPolicySid

When this flag is enabled:

Resource policies will be created with Statement IDs for service principals
The operation will succeed as expected

When this flag is disabled:

A warning will be emitted
The grant operation will be dropped
No permissions will be added

cdk.json

{
  "context": {
    "@aws-cdk/aws-events:requireEventBusPolicySid": true
  }
}

@aws-cdk/aws-dynamodb:retainTableReplica

Currently, table replica will always be deleted when stack deletes regardless of source table's deletion policy. When enabled, table replica will be default to the removal policy of source table unless specified otherwise.

cdk.json

{
  "context": {
    "@aws-cdk/aws-dynamodb:retainTableReplica": true
  }
}

@aws-cdk/cognito:logUserPoolClientSecretValue

When this feature flag is enabled, the SDK API call response to desribe user pool client values will be logged in the custom resource lambda function logs.

When this feature flag is disabled, the SDK API call response to describe user pool client values will not be logged in the custom resource lambda function logs.

cdk.json

{
  "context": {
    "@aws-cdk/cognito:logUserPoolClientSecretValue": true
  }
}

@aws-cdk/aws-s3:publicAccessBlockedByDefault

When BlockPublicAccess is not set at all, s3's default behavior will be to set all options to true in aws console. The 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. This is counter intuitive to the console behavior where the options would start in true state and a user would uncheck the boxes as needed. The 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.

cdk.json

{
  "context": {
    "@aws-cdk/aws-s3:publicAccessBlockedByDefault": true
  }
}

@aws-cdk/aws-ec2:requirePrivateSubnetsForEgressOnlyInternetGateway

When this feature flag is enabled, EgressOnlyGateway is created only for dual-stack VPC with private subnets

When this feature flag is disabled, EgressOnlyGateway resource is created for all dual-stack VPC regardless of subnet type

cdk.json

{
  "context": {
    "@aws-cdk/aws-ec2:requirePrivateSubnetsForEgressOnlyInternetGateway": true
  }
}

@aws-cdk/aws-stepfunctions-tasks:httpInvokeDynamicJsonPathEndpoint

When 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. When disabled, the JSONPath apiEndpoint property will only support a static string value.

_cdk.json

{
  "context": {
    "@aws-cdk/aws-stepfunctions-tasks:httpInvokeDynamicJsonPathEndpoint": true
  }
}

@aws-cdk/aws-signer:signingProfileNamePassedToCfn

When this feature flag is enabled, the signingProfileName property is passed to the L1 CfnSigningProfile construct, which ensures that the AWS Signer profile is created with the specified name.

When this feature flag is disabled, the signingProfileName is not passed to CloudFormation, maintaining backward compatibility with existing deployments where CloudFormation auto-generated profile names.

This feature flag is needed because enabling it can cause existing signing profiles to be replaced during deployment if a signingProfileName was specified but not previously used in the CloudFormation template.

cdk.json

{
  "context": {
    "@aws-cdk/aws-signer:signingProfileNamePassedToCfn": true
  }
}

@aws-cdk/aws-ecs-patterns:uniqueTargetGroupId

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

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

cdk.json

{
  "context": {
    "@aws-cdk/aws-ecs-patterns:uniqueTargetGroupId": true
  }
}

@aws-cdk/aws-batch:defaultToAL2023

When enabled, EC2 Batch compute environments (both ECS and EKS) that do not specify an imageType will default to ECS_AL2023 or EKS_AL2023 instead of the deprecated ECS_AL2 or EKS_AL2 (Amazon Linux 2, reaching EOL June 2026 for ECS; already EOL for EKS).

For EKS compute environments with a launch template, userdataType will automatically be set to EKS_NODEADM when an AL2023 image type is used, as required by the AWS Batch API.

When disabled, the default imageType remains ECS_AL2 / EKS_AL2 for backward compatibility.

cdk.json

{
  "context": {
    "@aws-cdk/aws-batch:defaultToAL2023": true
  }
}

Documentation ¶

Index ¶

func AssetManifestArtifact_IsAssetManifestArtifact(art interface{}) *bool
func CloudAssembly_CleanupTemporaryDirectories()
func CloudAssembly_IsCloudAssembly(x interface{}) *bool
func CloudFormationStackArtifact_IsCloudFormationStackArtifact(art interface{}) *bool
func EnvironmentPlaceholders_CURRENT_ACCOUNT() *string
func EnvironmentPlaceholders_CURRENT_PARTITION() *string
func EnvironmentPlaceholders_CURRENT_REGION() *string
func EnvironmentPlaceholders_Replace(object interface{}, values *EnvironmentPlaceholderValues) interface{}
func EnvironmentPlaceholders_ReplaceAsync(object interface{}, provider IEnvironmentPlaceholderProvider) interface{}
func EnvironmentUtils_Format(account *string, region *string) *string
func NestedCloudAssemblyArtifact_IsNestedCloudAssemblyArtifact(art interface{}) *bool
func NewAssetManifestArtifact_Override(a AssetManifestArtifact, assembly CloudAssembly, name *string, ...)
func NewCloudArtifact_Override(c CloudArtifact, assembly CloudAssembly, id *string, ...)
func NewCloudAssemblyBuilder_Override(c CloudAssemblyBuilder, outdir *string, props *CloudAssemblyBuilderProps)
func NewCloudAssembly_Override(c CloudAssembly, directory *string, ...)
func NewCloudFormationStackArtifact_Override(c CloudFormationStackArtifact, assembly CloudAssembly, artifactId *string, ...)
func NewEnvironmentPlaceholders_Override(e EnvironmentPlaceholders)deprecated
func NewEnvironmentUtils_Override(e EnvironmentUtils)deprecated
func NewNestedCloudAssemblyArtifact_Override(n NestedCloudAssemblyArtifact, assembly CloudAssembly, name *string, ...)
func NewTreeCloudArtifact_Override(t TreeCloudArtifact, assembly CloudAssembly, name *string, ...)
func TreeCloudArtifact_IsTreeCloudArtifact(art interface{}) *bool
type AssemblyBuildOptions
type AssetManifestArtifact
- func NewAssetManifestArtifact(assembly CloudAssembly, name *string, ...) AssetManifestArtifact
type AwsCloudFormationStackPropertiesdeprecated
type CloudArtifact
- func AssetManifestArtifact_FromManifest(assembly CloudAssembly, id *string, ...) CloudArtifact
- func CloudArtifact_FromManifest(assembly CloudAssembly, id *string, ...) CloudArtifact
- func CloudFormationStackArtifact_FromManifest(assembly CloudAssembly, id *string, ...) CloudArtifact
- func NestedCloudAssemblyArtifact_FromManifest(assembly CloudAssembly, id *string, ...) CloudArtifact
- func NewCloudArtifact(assembly CloudAssembly, id *string, ...) CloudArtifact
- func TreeCloudArtifact_FromManifest(assembly CloudAssembly, id *string, ...) CloudArtifact
type CloudAssembly
- func NewCloudAssembly(directory *string, loadOptions *cloudassemblyschema.LoadManifestOptions) CloudAssembly
type CloudAssemblyBuilder
- func NewCloudAssemblyBuilder(outdir *string, props *CloudAssemblyBuilderProps) CloudAssemblyBuilder
type CloudAssemblyBuilderProps
type CloudFormationStackArtifact
- func NewCloudFormationStackArtifact(assembly CloudAssembly, artifactId *string, ...) CloudFormationStackArtifact
type EndpointServiceAvailabilityZonesContextQuerydeprecated
type Environmentdeprecated
- func EnvironmentUtils_Make(account *string, region *string) *Environment
- func EnvironmentUtils_Parse(environment *string) *Environmentdeprecated
type EnvironmentPlaceholderValuesdeprecated
type EnvironmentPlaceholdersdeprecated
- func NewEnvironmentPlaceholders() EnvironmentPlaceholdersdeprecated
type EnvironmentUtilsdeprecated
- func NewEnvironmentUtils() EnvironmentUtilsdeprecated
type IEnvironmentPlaceholderProvider
type KeyContextResponsedeprecated
type LoadBalancerContextResponsedeprecated
type LoadBalancerIpAddressType
type LoadBalancerListenerContextResponsedeprecated
type MetadataEntryResultdeprecated
type NestedCloudAssemblyArtifact
- func NewNestedCloudAssemblyArtifact(assembly CloudAssembly, name *string, ...) NestedCloudAssemblyArtifact
type SecurityGroupContextResponsedeprecated
type SynthesisMessagedeprecated
type SynthesisMessageLeveldeprecated
type TreeCloudArtifact
- func NewTreeCloudArtifact(assembly CloudAssembly, name *string, ...) TreeCloudArtifact
type VpcContextResponsedeprecated
type VpcSubnetdeprecated
type VpcSubnetGroupdeprecated
type VpcSubnetGroupType

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func AssetManifestArtifact_IsAssetManifestArtifact ¶ added in v2.19.0

func AssetManifestArtifact_IsAssetManifestArtifact(art interface{}) *bool

Checks if `art` is an instance of this class.

Use this method instead of `instanceof` to properly detect `AssetManifestArtifact` instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the `cx-api` library on disk are seen as independent, completely different libraries. As a consequence, the class `AssetManifestArtifact` in each copy of the `cx-api` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `cx-api` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.

func CloudAssembly_CleanupTemporaryDirectories ¶ added in v2.232.0

func CloudAssembly_CleanupTemporaryDirectories()

Cleans up any temporary assembly directories that got created in this process.

If a Cloud Assembly is emitted to a temporary directory, its directory gets added to a list. This function iterates over that list and deletes each directory in it, to free up disk space.

This function will normally be called automatically during Node process exit and so you don't need to call this. However, some test environments do not properly trigger Node's `exit` event. Notably: Jest does not trigger the `exit` event (<https://github.com/jestjs/jest/issues/10927>).

## Cleaning up temporary directories in jest

For Jest, you have to make sure this function is called at the end of the test suite instead:

```js import { CloudAssembly } from 'aws-cdk-lib/cx-api';

afterAll(CloudAssembly.cleanupTemporaryDirectories); ```

Alternatively, you can use the `setupFilesAfterEnv` feature and use a provided helper script to automatically inject the above into every test file, so you don't have to do it by hand.

``` $ npx jest --setupFilesAfterEnv aws-cdk-lib/testhelpers/jest-autoclean ```

Or put the following into `jest.config.js`:

```js

module.exports = {
  // ...
  setupFilesAfterEnv: ['aws-cdk-lib/testhelpers/jest-cleanup'],
};

```.

func CloudAssembly_IsCloudAssembly ¶ added in v2.177.0

func CloudAssembly_IsCloudAssembly(x interface{}) *bool

Return whether the given object is a CloudAssembly.

We do attribute detection since we can't reliably use 'instanceof'.

func CloudFormationStackArtifact_IsCloudFormationStackArtifact ¶ added in v2.80.0

func CloudFormationStackArtifact_IsCloudFormationStackArtifact(art interface{}) *bool

Checks if `art` is an instance of this class.

Use this method instead of `instanceof` to properly detect `CloudFormationStackArtifact` instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the `cx-api` library on disk are seen as independent, completely different libraries. As a consequence, the class `CloudFormationStackArtifact` in each copy of the `cx-api` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `cx-api` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.

func EnvironmentPlaceholders_CURRENT_ACCOUNT ¶

func EnvironmentPlaceholders_CURRENT_ACCOUNT() *string

func EnvironmentPlaceholders_CURRENT_PARTITION ¶

func EnvironmentPlaceholders_CURRENT_PARTITION() *string

func EnvironmentPlaceholders_CURRENT_REGION ¶

func EnvironmentPlaceholders_CURRENT_REGION() *string

func EnvironmentPlaceholders_Replace ¶

func EnvironmentPlaceholders_Replace(object interface{}, values *EnvironmentPlaceholderValues) interface{}

Replace the environment placeholders in all strings found in a complex object.

Duplicated between cdk-assets and aws-cdk CLI because we don't have a good single place to put it (they're nominally independent tools). Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.

func EnvironmentPlaceholders_ReplaceAsync ¶

func EnvironmentPlaceholders_ReplaceAsync(object interface{}, provider IEnvironmentPlaceholderProvider) interface{}

Like 'replace', but asynchronous. Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.

func EnvironmentUtils_Format ¶

func EnvironmentUtils_Format(account *string, region *string) *string

Format an environment string from an account and region. Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.

func NestedCloudAssemblyArtifact_IsNestedCloudAssemblyArtifact ¶ added in v2.80.0

func NestedCloudAssemblyArtifact_IsNestedCloudAssemblyArtifact(art interface{}) *bool

Checks if `art` is an instance of this class.

Use this method instead of `instanceof` to properly detect `NestedCloudAssemblyArtifact` instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the `cx-api` library on disk are seen as independent, completely different libraries. As a consequence, the class `NestedCloudAssemblyArtifact` in each copy of the `cx-api` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `cx-api` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.

func NewAssetManifestArtifact_Override ¶

func NewAssetManifestArtifact_Override(a AssetManifestArtifact, assembly CloudAssembly, name *string, artifact *cloudassemblyschema.ArtifactManifest)

func NewCloudArtifact_Override ¶

func NewCloudArtifact_Override(c CloudArtifact, assembly CloudAssembly, id *string, manifest *cloudassemblyschema.ArtifactManifest)

func NewCloudAssemblyBuilder_Override ¶

func NewCloudAssemblyBuilder_Override(c CloudAssemblyBuilder, outdir *string, props *CloudAssemblyBuilderProps)

Initializes a cloud assembly builder.

func NewCloudAssembly_Override ¶

func NewCloudAssembly_Override(c CloudAssembly, directory *string, loadOptions *cloudassemblyschema.LoadManifestOptions)

Reads a cloud assembly from the specified directory.

func NewCloudFormationStackArtifact_Override ¶

func NewCloudFormationStackArtifact_Override(c CloudFormationStackArtifact, assembly CloudAssembly, artifactId *string, artifact *cloudassemblyschema.ArtifactManifest)

func NewEnvironmentPlaceholders_Override deprecated

func NewEnvironmentPlaceholders_Override(e EnvironmentPlaceholders)

Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.

func NewEnvironmentUtils_Override deprecated

func NewEnvironmentUtils_Override(e EnvironmentUtils)

Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.

func NewNestedCloudAssemblyArtifact_Override ¶

func NewNestedCloudAssemblyArtifact_Override(n NestedCloudAssemblyArtifact, assembly CloudAssembly, name *string, artifact *cloudassemblyschema.ArtifactManifest)

func NewTreeCloudArtifact_Override ¶

func NewTreeCloudArtifact_Override(t TreeCloudArtifact, assembly CloudAssembly, name *string, artifact *cloudassemblyschema.ArtifactManifest)

func TreeCloudArtifact_IsTreeCloudArtifact ¶ added in v2.80.0

func TreeCloudArtifact_IsTreeCloudArtifact(art interface{}) *bool

Checks if `art` is an instance of this class.

Use this method instead of `instanceof` to properly detect `TreeCloudArtifact` instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the `cx-api` library on disk are seen as independent, completely different libraries. As a consequence, the class `TreeCloudArtifact` in each copy of the `cx-api` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `cx-api` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.

Types ¶

type AssemblyBuildOptions ¶

type AssemblyBuildOptions struct {
}

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

assemblyBuildOptions := &AssemblyBuildOptions{
}

type AssetManifestArtifact ¶

type AssetManifestArtifact interface {
	CloudArtifact
	Assembly() CloudAssembly
	// Name of SSM parameter with bootstrap stack version.
	// Default: - Discover SSM parameter by reading stack.
	//
	BootstrapStackVersionSsmParameter() *string
	// The Asset Manifest contents.
	Contents() *cloudassemblyschema.AssetManifest
	// Returns all the artifacts that this artifact depends on.
	Dependencies() *[]CloudArtifact
	// The file name of the asset manifest.
	File() *string
	// An identifier that shows where this artifact is located in the tree of nested assemblies, based on their manifests.
	//
	// Defaults to the normal
	// id. Should only be used in user interfaces.
	HierarchicalId() *string
	Id() *string
	// The artifact's manifest.
	Manifest() *cloudassemblyschema.ArtifactManifest
	// The set of messages extracted from the artifact's metadata.
	Messages() *[]*SynthesisMessage
	// Returns the metadata associated with this Cloud Artifact.
	Metadata() *map[string]*[]*cloudassemblyschema.MetadataEntry
	// Version of bootstrap stack required to deploy this stack.
	RequiresBootstrapStackVersion() *float64
	// Returns: all the metadata entries of a specific type in this artifact.
	FindMetadataByType(type_ *string) *[]*MetadataEntryResult
}

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.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"

var assumeRoleAdditionalOptions interface{}
var cloudAssembly CloudAssembly

assetManifestArtifact := awscdk.Cx_api.NewAssetManifestArtifact(cloudAssembly, jsii.String("name"), &ArtifactManifest{
	Type: awscdk.Cloud_assembly_schema.ArtifactType_NONE,

	// the properties below are optional
	AdditionalMetadataFile: jsii.String("additionalMetadataFile"),
	Dependencies: []*string{
		jsii.String("dependencies"),
	},
	DisplayName: jsii.String("displayName"),
	Environment: jsii.String("environment"),
	Metadata: map[string][]MetadataEntry{
		"metadataKey": []MetadataEntry{
			&MetadataEntry{
				"type": jsii.String("type"),

				// the properties below are optional
				"data": jsii.String("data"),
				"trace": []*string{
					jsii.String("trace"),
				},
			},
		},
	},
	Properties: &AwsCloudFormationStackProperties{
		TemplateFile: jsii.String("templateFile"),

		// the properties below are optional
		AssumeRoleAdditionalOptions: map[string]interface{}{
			"assumeRoleAdditionalOptionsKey": assumeRoleAdditionalOptions,
		},
		AssumeRoleArn: jsii.String("assumeRoleArn"),
		AssumeRoleExternalId: jsii.String("assumeRoleExternalId"),
		BootstrapStackVersionSsmParameter: jsii.String("bootstrapStackVersionSsmParameter"),
		CloudFormationExecutionRoleArn: jsii.String("cloudFormationExecutionRoleArn"),
		LookupRole: &BootstrapRole{
			Arn: jsii.String("arn"),

			// the properties below are optional
			AssumeRoleAdditionalOptions: map[string]interface{}{
				"assumeRoleAdditionalOptionsKey": assumeRoleAdditionalOptions,
			},
			AssumeRoleExternalId: jsii.String("assumeRoleExternalId"),
			BootstrapStackVersionSsmParameter: jsii.String("bootstrapStackVersionSsmParameter"),
			RequiresBootstrapStackVersion: jsii.Number(123),
		},
		NotificationArns: []*string{
			jsii.String("notificationArns"),
		},
		Parameters: map[string]*string{
			"parametersKey": jsii.String("parameters"),
		},
		RequiresBootstrapStackVersion: jsii.Number(123),
		StackName: jsii.String("stackName"),
		StackTemplateAssetObjectUrl: jsii.String("stackTemplateAssetObjectUrl"),
		Tags: map[string]*string{
			"tagsKey": jsii.String("tags"),
		},
		TerminationProtection: jsii.Boolean(false),
		ValidateOnSynth: jsii.Boolean(false),
	},
})

func NewAssetManifestArtifact ¶

func NewAssetManifestArtifact(assembly CloudAssembly, name *string, artifact *cloudassemblyschema.ArtifactManifest) AssetManifestArtifact

type AwsCloudFormationStackProperties deprecated

type AwsCloudFormationStackProperties struct {
	// A file relative to the assembly root which contains the CloudFormation template for this stack.
	// Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.
	TemplateFile *string `field:"required" json:"templateFile" yaml:"templateFile"`
	// Values for CloudFormation stack parameters that should be passed when the stack is deployed.
	// Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.
	Parameters *map[string]*string `field:"optional" json:"parameters" yaml:"parameters"`
	// The name to use for the CloudFormation stack.
	// Default: - name derived from artifact ID.
	//
	// Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.
	StackName *string `field:"optional" json:"stackName" yaml:"stackName"`
	// Whether to enable termination protection for this stack.
	// Default: false.
	//
	// Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.
	TerminationProtection *bool `field:"optional" json:"terminationProtection" yaml:"terminationProtection"`
}

Artifact properties for CloudFormation stacks.

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

awsCloudFormationStackProperties := &AwsCloudFormationStackProperties{
	TemplateFile: jsii.String("templateFile"),

	// the properties below are optional
	Parameters: map[string]*string{
		"parametersKey": jsii.String("parameters"),
	},
	StackName: jsii.String("stackName"),
	TerminationProtection: jsii.Boolean(false),
}

Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.

type CloudArtifact ¶

type CloudArtifact interface {
	Assembly() CloudAssembly
	// Returns all the artifacts that this artifact depends on.
	Dependencies() *[]CloudArtifact
	// An identifier that shows where this artifact is located in the tree of nested assemblies, based on their manifests.
	//
	// Defaults to the normal
	// id. Should only be used in user interfaces.
	HierarchicalId() *string
	Id() *string
	// The artifact's manifest.
	Manifest() *cloudassemblyschema.ArtifactManifest
	// The set of messages extracted from the artifact's metadata.
	Messages() *[]*SynthesisMessage
	// Returns the metadata associated with this Cloud Artifact.
	Metadata() *map[string]*[]*cloudassemblyschema.MetadataEntry
	// Returns: all the metadata entries of a specific type in this artifact.
	FindMetadataByType(type_ *string) *[]*MetadataEntryResult
}

Represents an artifact within a cloud assembly.

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"

var assumeRoleAdditionalOptions interface{}
var cloudAssembly CloudAssembly

cloudArtifact := awscdk.Cx_api.CloudArtifact_FromManifest(cloudAssembly, jsii.String("MyCloudArtifact"), &ArtifactManifest{
	Type: awscdk.Cloud_assembly_schema.ArtifactType_NONE,

	// the properties below are optional
	AdditionalMetadataFile: jsii.String("additionalMetadataFile"),
	Dependencies: []*string{
		jsii.String("dependencies"),
	},
	DisplayName: jsii.String("displayName"),
	Environment: jsii.String("environment"),
	Metadata: map[string][]MetadataEntry{
		"metadataKey": []MetadataEntry{
			&MetadataEntry{
				"type": jsii.String("type"),

				// the properties below are optional
				"data": jsii.String("data"),
				"trace": []*string{
					jsii.String("trace"),
				},
			},
		},
	},
	Properties: &AwsCloudFormationStackProperties{
		TemplateFile: jsii.String("templateFile"),

		// the properties below are optional
		AssumeRoleAdditionalOptions: map[string]interface{}{
			"assumeRoleAdditionalOptionsKey": assumeRoleAdditionalOptions,
		},
		AssumeRoleArn: jsii.String("assumeRoleArn"),
		AssumeRoleExternalId: jsii.String("assumeRoleExternalId"),
		BootstrapStackVersionSsmParameter: jsii.String("bootstrapStackVersionSsmParameter"),
		CloudFormationExecutionRoleArn: jsii.String("cloudFormationExecutionRoleArn"),
		LookupRole: &BootstrapRole{
			Arn: jsii.String("arn"),

			// the properties below are optional
			AssumeRoleAdditionalOptions: map[string]interface{}{
				"assumeRoleAdditionalOptionsKey": assumeRoleAdditionalOptions,
			},
			AssumeRoleExternalId: jsii.String("assumeRoleExternalId"),
			BootstrapStackVersionSsmParameter: jsii.String("bootstrapStackVersionSsmParameter"),
			RequiresBootstrapStackVersion: jsii.Number(123),
		},
		NotificationArns: []*string{
			jsii.String("notificationArns"),
		},
		Parameters: map[string]*string{
			"parametersKey": jsii.String("parameters"),
		},
		RequiresBootstrapStackVersion: jsii.Number(123),
		StackName: jsii.String("stackName"),
		StackTemplateAssetObjectUrl: jsii.String("stackTemplateAssetObjectUrl"),
		Tags: map[string]*string{
			"tagsKey": jsii.String("tags"),
		},
		TerminationProtection: jsii.Boolean(false),
		ValidateOnSynth: jsii.Boolean(false),
	},
})

func AssetManifestArtifact_FromManifest ¶

func AssetManifestArtifact_FromManifest(assembly CloudAssembly, id *string, artifact *cloudassemblyschema.ArtifactManifest) CloudArtifact

Returns a subclass of `CloudArtifact` based on the artifact type defined in the artifact manifest.

Returns: the `CloudArtifact` that matches the artifact type or `undefined` if it's an artifact type that is unrecognized by this module.

func CloudArtifact_FromManifest ¶

func CloudArtifact_FromManifest(assembly CloudAssembly, id *string, artifact *cloudassemblyschema.ArtifactManifest) CloudArtifact

Returns a subclass of `CloudArtifact` based on the artifact type defined in the artifact manifest.

Returns: the `CloudArtifact` that matches the artifact type or `undefined` if it's an artifact type that is unrecognized by this module.

func CloudFormationStackArtifact_FromManifest ¶

func CloudFormationStackArtifact_FromManifest(assembly CloudAssembly, id *string, artifact *cloudassemblyschema.ArtifactManifest) CloudArtifact

Returns a subclass of `CloudArtifact` based on the artifact type defined in the artifact manifest.

Returns: the `CloudArtifact` that matches the artifact type or `undefined` if it's an artifact type that is unrecognized by this module.

func NestedCloudAssemblyArtifact_FromManifest ¶

func NestedCloudAssemblyArtifact_FromManifest(assembly CloudAssembly, id *string, artifact *cloudassemblyschema.ArtifactManifest) CloudArtifact

Returns a subclass of `CloudArtifact` based on the artifact type defined in the artifact manifest.

Returns: the `CloudArtifact` that matches the artifact type or `undefined` if it's an artifact type that is unrecognized by this module.

func NewCloudArtifact ¶

func NewCloudArtifact(assembly CloudAssembly, id *string, manifest *cloudassemblyschema.ArtifactManifest) CloudArtifact

func TreeCloudArtifact_FromManifest ¶

func TreeCloudArtifact_FromManifest(assembly CloudAssembly, id *string, artifact *cloudassemblyschema.ArtifactManifest) CloudArtifact

Returns a subclass of `CloudArtifact` based on the artifact type defined in the artifact manifest.

Returns: the `CloudArtifact` that matches the artifact type or `undefined` if it's an artifact type that is unrecognized by this module.

type CloudAssembly ¶

type CloudAssembly interface {
	cloudassemblyschema.ICloudAssembly
	// All artifacts included in this assembly.
	Artifacts() *[]CloudArtifact
	// The root directory of the cloud assembly.
	Directory() *string
	// The raw assembly manifest.
	Manifest() *cloudassemblyschema.AssemblyManifest
	// The nested assembly artifacts in this assembly.
	NestedAssemblies() *[]NestedCloudAssemblyArtifact
	// Runtime information such as module versions used to synthesize this assembly.
	Runtime() *cloudassemblyschema.RuntimeInfo
	// Returns: all the CloudFormation stack artifacts that are included in this assembly.
	Stacks() *[]CloudFormationStackArtifact
	// Returns all the stacks, including the ones in nested assemblies.
	StacksRecursively() *[]CloudFormationStackArtifact
	// The schema version of the assembly manifest.
	Version() *string
	// Returns a nested assembly.
	GetNestedAssembly(artifactId *string) CloudAssembly
	// Returns a nested assembly artifact.
	GetNestedAssemblyArtifact(artifactId *string) NestedCloudAssemblyArtifact
	// Returns a CloudFormation stack artifact from this assembly.
	//
	// Returns: a `CloudFormationStackArtifact` object.
	GetStackArtifact(artifactId *string) CloudFormationStackArtifact
	// Returns a CloudFormation stack artifact from this assembly.
	//
	// Will only search the current assembly.
	//
	// Returns: a `CloudFormationStackArtifact` object.
	GetStackByName(stackName *string) CloudFormationStackArtifact
	// Returns the tree metadata artifact from this assembly.
	//
	// Returns: a `TreeCloudArtifact` object if there is one defined in the manifest, `undefined` otherwise.
	Tree() TreeCloudArtifact
	// Attempts to find an artifact with a specific identity.
	//
	// Returns: A `CloudArtifact` object or `undefined` if the artifact does not exist in this assembly.
	TryGetArtifact(id *string) CloudArtifact
}

Represents a deployable cloud application.

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cloudAssembly := awscdk.Cx_api.NewCloudAssembly(jsii.String("directory"), &LoadManifestOptions{
	SkipEnumCheck: jsii.Boolean(false),
	SkipVersionCheck: jsii.Boolean(false),
	TopoSort: jsii.Boolean(false),
	ValidateSchema: jsii.Boolean(false),
})

func NewCloudAssembly ¶

func NewCloudAssembly(directory *string, loadOptions *cloudassemblyschema.LoadManifestOptions) CloudAssembly

Reads a cloud assembly from the specified directory.

type CloudAssemblyBuilder ¶

type CloudAssemblyBuilder interface {
	// The directory where assets of this Cloud Assembly should be stored.
	AssetOutdir() *string
	// The root directory of the resulting cloud assembly.
	Outdir() *string
	// Adds an artifact into the cloud assembly.
	AddArtifact(id *string, manifest *cloudassemblyschema.ArtifactManifest)
	// Reports that some context is missing in order for this cloud assembly to be fully synthesized.
	AddMissing(missing *cloudassemblyschema.MissingContext)
	// Finalizes the cloud assembly into the output directory returns a `CloudAssembly` object that can be used to inspect the assembly.
	BuildAssembly(options *AssemblyBuildOptions) CloudAssembly
	// Creates a nested cloud assembly.
	CreateNestedAssembly(artifactId *string, displayName *string) CloudAssemblyBuilder
	// Delete the cloud assembly directory.
	Delete()
}

Can be used to build a cloud assembly.

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

var cloudAssemblyBuilder_ CloudAssemblyBuilder

cloudAssemblyBuilder := awscdk.Cx_api.NewCloudAssemblyBuilder(jsii.String("outdir"), &CloudAssemblyBuilderProps{
	AssetOutdir: jsii.String("assetOutdir"),
	ParentBuilder: cloudAssemblyBuilder_,
})

func NewCloudAssemblyBuilder ¶

func NewCloudAssemblyBuilder(outdir *string, props *CloudAssemblyBuilderProps) CloudAssemblyBuilder

Initializes a cloud assembly builder.

type CloudAssemblyBuilderProps ¶

type CloudAssemblyBuilderProps struct {
	// Use the given asset output directory.
	// Default: - Same as the manifest outdir.
	//
	AssetOutdir *string `field:"optional" json:"assetOutdir" yaml:"assetOutdir"`
	// If this builder is for a nested assembly, the parent assembly builder.
	// Default: - This is a root assembly.
	//
	ParentBuilder CloudAssemblyBuilder `field:"optional" json:"parentBuilder" yaml:"parentBuilder"`
}

Construction properties for CloudAssemblyBuilder.

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

var cloudAssemblyBuilder CloudAssemblyBuilder

cloudAssemblyBuilderProps := &CloudAssemblyBuilderProps{
	AssetOutdir: jsii.String("assetOutdir"),
	ParentBuilder: cloudAssemblyBuilder,
}

type CloudFormationStackArtifact ¶

type CloudFormationStackArtifact interface {
	CloudArtifact
	Assembly() CloudAssembly
	// Any assets associated with this stack.
	Assets() *[]interface{}
	// Additional options to pass to STS when assuming the role for cloudformation deployments.
	//
	// - `RoleArn` should not be used. Use the dedicated `assumeRoleArn` property instead.
	// - `ExternalId` should not be used. Use the dedicated `assumeRoleExternalId` instead.
	// - `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
	//
	// Default: - No additional options.
	//
	AssumeRoleAdditionalOptions() *map[string]interface{}
	// The role that needs to be assumed to deploy the stack.
	// Default: - No role is assumed (current credentials are used).
	//
	AssumeRoleArn() *string
	// External ID to use when assuming role for cloudformation deployments.
	// Default: - No external ID.
	//
	AssumeRoleExternalId() *string
	// Name of SSM parameter with bootstrap stack version.
	// Default: - Discover SSM parameter by reading stack.
	//
	BootstrapStackVersionSsmParameter() *string
	// The role that is passed to CloudFormation to execute the change set.
	// Default: - No role is passed (currently assumed role/credentials are used).
	//
	CloudFormationExecutionRoleArn() *string
	// Returns all the artifacts that this artifact depends on.
	Dependencies() *[]CloudArtifact
	// A string that represents this stack.
	//
	// Should only be used in user
	// interfaces. If the stackName has not been set explicitly, or has been set
	// to artifactId, it will return the hierarchicalId of the stack. Otherwise,
	// it will return something like "<hierarchicalId> (<stackName>)".
	DisplayName() *string
	// The environment into which to deploy this artifact.
	Environment() *Environment
	// An identifier that shows where this artifact is located in the tree of nested assemblies, based on their manifests.
	//
	// Defaults to the normal
	// id. Should only be used in user interfaces.
	HierarchicalId() *string
	Id() *string
	// The role to use to look up values from the target AWS account.
	// Default: - No role is assumed (current credentials are used).
	//
	LookupRole() *cloudassemblyschema.BootstrapRole
	// The artifact's manifest.
	Manifest() *cloudassemblyschema.ArtifactManifest
	// The set of messages extracted from the artifact's metadata.
	Messages() *[]*SynthesisMessage
	// Returns the metadata associated with this Cloud Artifact.
	Metadata() *map[string]*[]*cloudassemblyschema.MetadataEntry
	// SNS Topics that will receive stack events.
	NotificationArns() *[]*string
	// The original name as defined in the CDK app.
	OriginalName() *string
	// CloudFormation parameters to pass to the stack.
	Parameters() *map[string]*string
	// Version of bootstrap stack required to deploy this stack.
	// Default: - No bootstrap stack required.
	//
	RequiresBootstrapStackVersion() *float64
	// The physical name of this stack.
	StackName() *string
	// If the stack template has already been included in the asset manifest, its asset URL.
	// Default: - Not uploaded yet, upload just before deploying.
	//
	StackTemplateAssetObjectUrl() *string
	// CloudFormation tags to pass to the stack.
	Tags() *map[string]*string
	// The CloudFormation template for this stack.
	Template() interface{}
	// The file name of the template.
	TemplateFile() *string
	// Full path to the template file.
	TemplateFullPath() *string
	// Whether termination protection is enabled for this stack.
	TerminationProtection() *bool
	// Whether this stack should be validated by the CLI after synthesis.
	// Default: - false.
	//
	ValidateOnSynth() *bool
	// Returns: all the metadata entries of a specific type in this artifact.
	FindMetadataByType(type_ *string) *[]*MetadataEntryResult
}

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"

var assumeRoleAdditionalOptions interface{}
var cloudAssembly CloudAssembly

cloudFormationStackArtifact := awscdk.Cx_api.NewCloudFormationStackArtifact(cloudAssembly, jsii.String("artifactId"), &ArtifactManifest{
	Type: awscdk.Cloud_assembly_schema.ArtifactType_NONE,

	// the properties below are optional
	AdditionalMetadataFile: jsii.String("additionalMetadataFile"),
	Dependencies: []*string{
		jsii.String("dependencies"),
	},
	DisplayName: jsii.String("displayName"),
	Environment: jsii.String("environment"),
	Metadata: map[string][]MetadataEntry{
		"metadataKey": []MetadataEntry{
			&MetadataEntry{
				"type": jsii.String("type"),

				// the properties below are optional
				"data": jsii.String("data"),
				"trace": []*string{
					jsii.String("trace"),
				},
			},
		},
	},
	Properties: &AwsCloudFormationStackProperties{
		TemplateFile: jsii.String("templateFile"),

		// the properties below are optional
		AssumeRoleAdditionalOptions: map[string]interface{}{
			"assumeRoleAdditionalOptionsKey": assumeRoleAdditionalOptions,
		},
		AssumeRoleArn: jsii.String("assumeRoleArn"),
		AssumeRoleExternalId: jsii.String("assumeRoleExternalId"),
		BootstrapStackVersionSsmParameter: jsii.String("bootstrapStackVersionSsmParameter"),
		CloudFormationExecutionRoleArn: jsii.String("cloudFormationExecutionRoleArn"),
		LookupRole: &BootstrapRole{
			Arn: jsii.String("arn"),

			// the properties below are optional
			AssumeRoleAdditionalOptions: map[string]interface{}{
				"assumeRoleAdditionalOptionsKey": assumeRoleAdditionalOptions,
			},
			AssumeRoleExternalId: jsii.String("assumeRoleExternalId"),
			BootstrapStackVersionSsmParameter: jsii.String("bootstrapStackVersionSsmParameter"),
			RequiresBootstrapStackVersion: jsii.Number(123),
		},
		NotificationArns: []*string{
			jsii.String("notificationArns"),
		},
		Parameters: map[string]*string{
			"parametersKey": jsii.String("parameters"),
		},
		RequiresBootstrapStackVersion: jsii.Number(123),
		StackName: jsii.String("stackName"),
		StackTemplateAssetObjectUrl: jsii.String("stackTemplateAssetObjectUrl"),
		Tags: map[string]*string{
			"tagsKey": jsii.String("tags"),
		},
		TerminationProtection: jsii.Boolean(false),
		ValidateOnSynth: jsii.Boolean(false),
	},
})

func NewCloudFormationStackArtifact ¶

func NewCloudFormationStackArtifact(assembly CloudAssembly, artifactId *string, artifact *cloudassemblyschema.ArtifactManifest) CloudFormationStackArtifact

type EndpointServiceAvailabilityZonesContextQuery deprecated

type EndpointServiceAvailabilityZonesContextQuery struct {
	// Query account.
	// Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.
	Account *string `field:"optional" json:"account" yaml:"account"`
	// Query region.
	// Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.
	Region *string `field:"optional" json:"region" yaml:"region"`
	// Query service name.
	// Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.
	ServiceName *string `field:"optional" json:"serviceName" yaml:"serviceName"`
}

Query to hosted zone context provider.

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

endpointServiceAvailabilityZonesContextQuery := &EndpointServiceAvailabilityZonesContextQuery{
	Account: jsii.String("account"),
	Region: jsii.String("region"),
	ServiceName: jsii.String("serviceName"),
}

Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.

type Environment deprecated

type Environment struct {
	// The AWS account this environment deploys into.
	// Deprecated: The official definition of this type has moved to `@aws-cdk/cloud-assembly-api`.
	Account *string `field:"required" json:"account" yaml:"account"`
	// The arbitrary name of this environment (user-set, or at least user-meaningful).
	// Deprecated: The official definition of this type has moved to `@aws-cdk/cloud-assembly-api`.
	Name *string `field:"required" json:"name" yaml:"name"`
	// The AWS region name where this environment deploys into.
	// Deprecated: The official definition of this type has moved to `@aws-cdk/cloud-assembly-api`.
	Region *string `field:"required" json:"region" yaml:"region"`
}

Models an AWS execution environment, for use within the CDK toolkit.

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

environment := &Environment{
	Account: jsii.String("account"),
	Name: jsii.String("name"),
	Region: jsii.String("region"),
}

Deprecated: The official definition of this type has moved to `@aws-cdk/cloud-assembly-api`.

func EnvironmentUtils_Make ¶

func EnvironmentUtils_Make(account *string, region *string) *Environment

Build an environment object from an account and region. Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.

func EnvironmentUtils_Parse deprecated

func EnvironmentUtils_Parse(environment *string) *Environment

Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.

type EnvironmentPlaceholderValues deprecated

type EnvironmentPlaceholderValues struct {
	// Return the account.
	// Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.
	AccountId *string `field:"required" json:"accountId" yaml:"accountId"`
	// Return the partition.
	// Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.
	Partition *string `field:"required" json:"partition" yaml:"partition"`
	// Return the region.
	// Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.
	Region *string `field:"required" json:"region" yaml:"region"`
}

Return the appropriate values for the environment placeholders.

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

environmentPlaceholderValues := &EnvironmentPlaceholderValues{
	AccountId: jsii.String("accountId"),
	Partition: jsii.String("partition"),
	Region: jsii.String("region"),
}

Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.

type EnvironmentPlaceholders deprecated

type EnvironmentPlaceholders interface {
}

Placeholders which can be used manifests.

These can occur both in the Asset Manifest as well as the general Cloud Assembly manifest.

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

environmentPlaceholders := awscdk.Cx_api.NewEnvironmentPlaceholders()

Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.

func NewEnvironmentPlaceholders deprecated

func NewEnvironmentPlaceholders() EnvironmentPlaceholders

Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.

type EnvironmentUtils deprecated

type EnvironmentUtils interface {
}

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

environmentUtils := awscdk.Cx_api.NewEnvironmentUtils()

Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.

func NewEnvironmentUtils deprecated

func NewEnvironmentUtils() EnvironmentUtils

Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.

type IEnvironmentPlaceholderProvider ¶

type IEnvironmentPlaceholderProvider interface {
	// Return the account.
	// Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.
	AccountId() *string
	// Return the partition.
	// Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.
	Partition() *string
	// Return the region.
	// Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.
	Region() *string
}

Return the appropriate values for the environment placeholders. Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.

type KeyContextResponse deprecated

type KeyContextResponse struct {
	// Id of the key.
	// Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.
	KeyId *string `field:"required" json:"keyId" yaml:"keyId"`
}

Properties of a discovered key.

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

keyContextResponse := &KeyContextResponse{
	KeyId: jsii.String("keyId"),
}

Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.

type LoadBalancerContextResponse deprecated

type LoadBalancerContextResponse struct {
	// Type of IP address.
	// Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.
	IpAddressType LoadBalancerIpAddressType `field:"required" json:"ipAddressType" yaml:"ipAddressType"`
	// The ARN of the load balancer.
	// Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.
	LoadBalancerArn *string `field:"required" json:"loadBalancerArn" yaml:"loadBalancerArn"`
	// The hosted zone ID of the load balancer's name.
	// Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.
	LoadBalancerCanonicalHostedZoneId *string `field:"required" json:"loadBalancerCanonicalHostedZoneId" yaml:"loadBalancerCanonicalHostedZoneId"`
	// Load balancer's DNS name.
	// Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.
	LoadBalancerDnsName *string `field:"required" json:"loadBalancerDnsName" yaml:"loadBalancerDnsName"`
	// Load balancer's security groups.
	// Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.
	SecurityGroupIds *[]*string `field:"required" json:"securityGroupIds" yaml:"securityGroupIds"`
	// Load balancer's VPC.
	// Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.
	VpcId *string `field:"required" json:"vpcId" yaml:"vpcId"`
}

Properties of a discovered load balancer.

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

loadBalancerContextResponse := &LoadBalancerContextResponse{
	IpAddressType: awscdk.Cx_api.LoadBalancerIpAddressType_IPV4,
	LoadBalancerArn: jsii.String("loadBalancerArn"),
	LoadBalancerCanonicalHostedZoneId: jsii.String("loadBalancerCanonicalHostedZoneId"),
	LoadBalancerDnsName: jsii.String("loadBalancerDnsName"),
	SecurityGroupIds: []*string{
		jsii.String("securityGroupIds"),
	},
	VpcId: jsii.String("vpcId"),
}

Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.

type LoadBalancerIpAddressType ¶

type LoadBalancerIpAddressType string

Load balancer ip address type. Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.

const (
	// IPV4 ip address.
	// Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.
	LoadBalancerIpAddressType_IPV4 LoadBalancerIpAddressType = "IPV4"
	// Dual stack address.
	// Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.
	LoadBalancerIpAddressType_DUAL_STACK LoadBalancerIpAddressType = "DUAL_STACK"
	// IPv6 only public addresses, with private IPv4 and IPv6 addresses.
	// Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.
	LoadBalancerIpAddressType_DUAL_STACK_WITHOUT_PUBLIC_IPV4 LoadBalancerIpAddressType = "DUAL_STACK_WITHOUT_PUBLIC_IPV4"
)

type LoadBalancerListenerContextResponse deprecated

type LoadBalancerListenerContextResponse struct {
	// The ARN of the listener.
	// Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.
	ListenerArn *string `field:"required" json:"listenerArn" yaml:"listenerArn"`
	// The port the listener is listening on.
	// Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.
	ListenerPort *float64 `field:"required" json:"listenerPort" yaml:"listenerPort"`
	// The security groups of the load balancer.
	// Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.
	SecurityGroupIds *[]*string `field:"required" json:"securityGroupIds" yaml:"securityGroupIds"`
}

Properties of a discovered load balancer listener.

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

loadBalancerListenerContextResponse := &LoadBalancerListenerContextResponse{
	ListenerArn: jsii.String("listenerArn"),
	ListenerPort: jsii.Number(123),
	SecurityGroupIds: []*string{
		jsii.String("securityGroupIds"),
	},
}

Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.

type MetadataEntryResult deprecated

type MetadataEntryResult struct {
	// The type of the metadata entry.
	// Deprecated: The official definition of this type has moved to `@aws-cdk/cloud-assembly-api`.
	Type *string `field:"required" json:"type" yaml:"type"`
	// The data.
	// Default: - no data.
	//
	// Deprecated: The official definition of this type has moved to `@aws-cdk/cloud-assembly-api`.
	Data interface{} `field:"optional" json:"data" yaml:"data"`
	// A stack trace for when the entry was created.
	// Default: - no trace.
	//
	// Deprecated: The official definition of this type has moved to `@aws-cdk/cloud-assembly-api`.
	Trace *[]*string `field:"optional" json:"trace" yaml:"trace"`
	// The path in which this entry was defined.
	// Deprecated: The official definition of this type has moved to `@aws-cdk/cloud-assembly-api`.
	Path *string `field:"required" json:"path" yaml:"path"`
}

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

metadataEntryResult := &MetadataEntryResult{
	Path: jsii.String("path"),
	Type: jsii.String("type"),

	// the properties below are optional
	Data: jsii.String("data"),
	Trace: []*string{
		jsii.String("trace"),
	},
}

Deprecated: The official definition of this type has moved to `@aws-cdk/cloud-assembly-api`.

type NestedCloudAssemblyArtifact ¶

type NestedCloudAssemblyArtifact interface {
	CloudArtifact
	Assembly() CloudAssembly
	// Returns all the artifacts that this artifact depends on.
	Dependencies() *[]CloudArtifact
	// The relative directory name of the asset manifest.
	DirectoryName() *string
	// Display name.
	DisplayName() *string
	// Full path to the nested assembly directory.
	FullPath() *string
	// An identifier that shows where this artifact is located in the tree of nested assemblies, based on their manifests.
	//
	// Defaults to the normal
	// id. Should only be used in user interfaces.
	HierarchicalId() *string
	Id() *string
	// The artifact's manifest.
	Manifest() *cloudassemblyschema.ArtifactManifest
	// The set of messages extracted from the artifact's metadata.
	Messages() *[]*SynthesisMessage
	// Returns the metadata associated with this Cloud Artifact.
	Metadata() *map[string]*[]*cloudassemblyschema.MetadataEntry
	// The nested Assembly.
	NestedAssembly() CloudAssembly
	// Returns: all the metadata entries of a specific type in this artifact.
	FindMetadataByType(type_ *string) *[]*MetadataEntryResult
}

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.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"

var assumeRoleAdditionalOptions interface{}
var cloudAssembly CloudAssembly

nestedCloudAssemblyArtifact := awscdk.Cx_api.NewNestedCloudAssemblyArtifact(cloudAssembly, jsii.String("name"), &ArtifactManifest{
	Type: awscdk.Cloud_assembly_schema.ArtifactType_NONE,

	// the properties below are optional
	AdditionalMetadataFile: jsii.String("additionalMetadataFile"),
	Dependencies: []*string{
		jsii.String("dependencies"),
	},
	DisplayName: jsii.String("displayName"),
	Environment: jsii.String("environment"),
	Metadata: map[string][]MetadataEntry{
		"metadataKey": []MetadataEntry{
			&MetadataEntry{
				"type": jsii.String("type"),

				// the properties below are optional
				"data": jsii.String("data"),
				"trace": []*string{
					jsii.String("trace"),
				},
			},
		},
	},
	Properties: &AwsCloudFormationStackProperties{
		TemplateFile: jsii.String("templateFile"),

		// the properties below are optional
		AssumeRoleAdditionalOptions: map[string]interface{}{
			"assumeRoleAdditionalOptionsKey": assumeRoleAdditionalOptions,
		},
		AssumeRoleArn: jsii.String("assumeRoleArn"),
		AssumeRoleExternalId: jsii.String("assumeRoleExternalId"),
		BootstrapStackVersionSsmParameter: jsii.String("bootstrapStackVersionSsmParameter"),
		CloudFormationExecutionRoleArn: jsii.String("cloudFormationExecutionRoleArn"),
		LookupRole: &BootstrapRole{
			Arn: jsii.String("arn"),

			// the properties below are optional
			AssumeRoleAdditionalOptions: map[string]interface{}{
				"assumeRoleAdditionalOptionsKey": assumeRoleAdditionalOptions,
			},
			AssumeRoleExternalId: jsii.String("assumeRoleExternalId"),
			BootstrapStackVersionSsmParameter: jsii.String("bootstrapStackVersionSsmParameter"),
			RequiresBootstrapStackVersion: jsii.Number(123),
		},
		NotificationArns: []*string{
			jsii.String("notificationArns"),
		},
		Parameters: map[string]*string{
			"parametersKey": jsii.String("parameters"),
		},
		RequiresBootstrapStackVersion: jsii.Number(123),
		StackName: jsii.String("stackName"),
		StackTemplateAssetObjectUrl: jsii.String("stackTemplateAssetObjectUrl"),
		Tags: map[string]*string{
			"tagsKey": jsii.String("tags"),
		},
		TerminationProtection: jsii.Boolean(false),
		ValidateOnSynth: jsii.Boolean(false),
	},
})

func NewNestedCloudAssemblyArtifact ¶

func NewNestedCloudAssemblyArtifact(assembly CloudAssembly, name *string, artifact *cloudassemblyschema.ArtifactManifest) NestedCloudAssemblyArtifact

type SecurityGroupContextResponse deprecated

type SecurityGroupContextResponse struct {
	// Whether the security group allows all outbound traffic.
	//
	// This will be true
	// when the security group has all-protocol egress permissions to access both
	// `0.0.0.0/0` and `::/0`.
	// Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.
	AllowAllOutbound *bool `field:"required" json:"allowAllOutbound" yaml:"allowAllOutbound"`
	// The security group's id.
	// Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.
	SecurityGroupId *string `field:"required" json:"securityGroupId" yaml:"securityGroupId"`
}

Properties of a discovered SecurityGroup.

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

securityGroupContextResponse := &SecurityGroupContextResponse{
	AllowAllOutbound: jsii.Boolean(false),
	SecurityGroupId: jsii.String("securityGroupId"),
}

Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.

type SynthesisMessage deprecated

type SynthesisMessage struct {
	// Deprecated: The official definition of this type has moved to `@aws-cdk/cloud-assembly-api`.
	Entry *cloudassemblyschema.MetadataEntry `field:"required" json:"entry" yaml:"entry"`
	// Deprecated: The official definition of this type has moved to `@aws-cdk/cloud-assembly-api`.
	Id *string `field:"required" json:"id" yaml:"id"`
	// Deprecated: The official definition of this type has moved to `@aws-cdk/cloud-assembly-api`.
	Level SynthesisMessageLevel `field:"required" json:"level" yaml:"level"`
}

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

synthesisMessage := &SynthesisMessage{
	Entry: &MetadataEntry{
		Type: jsii.String("type"),

		// the properties below are optional
		Data: jsii.String("data"),
		Trace: []*string{
			jsii.String("trace"),
		},
	},
	Id: jsii.String("id"),
	Level: awscdk.Cx_api.SynthesisMessageLevel_INFO,
}

Deprecated: The official definition of this type has moved to `@aws-cdk/cloud-assembly-api`.

type SynthesisMessageLevel deprecated

type SynthesisMessageLevel string

Deprecated: The official definition of this type has moved to `@aws-cdk/cloud-assembly-api`.

const (
	// Deprecated: The official definition of this type has moved to `@aws-cdk/cloud-assembly-api`.
	SynthesisMessageLevel_INFO SynthesisMessageLevel = "INFO"
	// Deprecated: The official definition of this type has moved to `@aws-cdk/cloud-assembly-api`.
	SynthesisMessageLevel_WARNING SynthesisMessageLevel = "WARNING"
	// Deprecated: The official definition of this type has moved to `@aws-cdk/cloud-assembly-api`.
	SynthesisMessageLevel_ERROR SynthesisMessageLevel = "ERROR"
)

type TreeCloudArtifact ¶

type TreeCloudArtifact interface {
	CloudArtifact
	Assembly() CloudAssembly
	// Returns all the artifacts that this artifact depends on.
	Dependencies() *[]CloudArtifact
	File() *string
	// An identifier that shows where this artifact is located in the tree of nested assemblies, based on their manifests.
	//
	// Defaults to the normal
	// id. Should only be used in user interfaces.
	HierarchicalId() *string
	Id() *string
	// The artifact's manifest.
	Manifest() *cloudassemblyschema.ArtifactManifest
	// The set of messages extracted from the artifact's metadata.
	Messages() *[]*SynthesisMessage
	// Returns the metadata associated with this Cloud Artifact.
	Metadata() *map[string]*[]*cloudassemblyschema.MetadataEntry
	// Returns: all the metadata entries of a specific type in this artifact.
	FindMetadataByType(type_ *string) *[]*MetadataEntryResult
}

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"

var assumeRoleAdditionalOptions interface{}
var cloudAssembly CloudAssembly

treeCloudArtifact := awscdk.Cx_api.NewTreeCloudArtifact(cloudAssembly, jsii.String("name"), &ArtifactManifest{
	Type: awscdk.Cloud_assembly_schema.ArtifactType_NONE,

	// the properties below are optional
	AdditionalMetadataFile: jsii.String("additionalMetadataFile"),
	Dependencies: []*string{
		jsii.String("dependencies"),
	},
	DisplayName: jsii.String("displayName"),
	Environment: jsii.String("environment"),
	Metadata: map[string][]MetadataEntry{
		"metadataKey": []MetadataEntry{
			&MetadataEntry{
				"type": jsii.String("type"),

				// the properties below are optional
				"data": jsii.String("data"),
				"trace": []*string{
					jsii.String("trace"),
				},
			},
		},
	},
	Properties: &AwsCloudFormationStackProperties{
		TemplateFile: jsii.String("templateFile"),

		// the properties below are optional
		AssumeRoleAdditionalOptions: map[string]interface{}{
			"assumeRoleAdditionalOptionsKey": assumeRoleAdditionalOptions,
		},
		AssumeRoleArn: jsii.String("assumeRoleArn"),
		AssumeRoleExternalId: jsii.String("assumeRoleExternalId"),
		BootstrapStackVersionSsmParameter: jsii.String("bootstrapStackVersionSsmParameter"),
		CloudFormationExecutionRoleArn: jsii.String("cloudFormationExecutionRoleArn"),
		LookupRole: &BootstrapRole{
			Arn: jsii.String("arn"),

			// the properties below are optional
			AssumeRoleAdditionalOptions: map[string]interface{}{
				"assumeRoleAdditionalOptionsKey": assumeRoleAdditionalOptions,
			},
			AssumeRoleExternalId: jsii.String("assumeRoleExternalId"),
			BootstrapStackVersionSsmParameter: jsii.String("bootstrapStackVersionSsmParameter"),
			RequiresBootstrapStackVersion: jsii.Number(123),
		},
		NotificationArns: []*string{
			jsii.String("notificationArns"),
		},
		Parameters: map[string]*string{
			"parametersKey": jsii.String("parameters"),
		},
		RequiresBootstrapStackVersion: jsii.Number(123),
		StackName: jsii.String("stackName"),
		StackTemplateAssetObjectUrl: jsii.String("stackTemplateAssetObjectUrl"),
		Tags: map[string]*string{
			"tagsKey": jsii.String("tags"),
		},
		TerminationProtection: jsii.Boolean(false),
		ValidateOnSynth: jsii.Boolean(false),
	},
})

func NewTreeCloudArtifact ¶

func NewTreeCloudArtifact(assembly CloudAssembly, name *string, artifact *cloudassemblyschema.ArtifactManifest) TreeCloudArtifact

type VpcContextResponse deprecated

type VpcContextResponse struct {
	// AZs.
	// Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.
	AvailabilityZones *[]*string `field:"required" json:"availabilityZones" yaml:"availabilityZones"`
	// VPC id.
	// Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.
	VpcId *string `field:"required" json:"vpcId" yaml:"vpcId"`
	// IDs of all isolated subnets.
	//
	// Element count: #(availabilityZones) · #(isolatedGroups).
	// Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.
	IsolatedSubnetIds *[]*string `field:"optional" json:"isolatedSubnetIds" yaml:"isolatedSubnetIds"`
	// Name of isolated subnet groups.
	//
	// Element count: #(isolatedGroups).
	// Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.
	IsolatedSubnetNames *[]*string `field:"optional" json:"isolatedSubnetNames" yaml:"isolatedSubnetNames"`
	// Route Table IDs of isolated subnet groups.
	//
	// Element count: #(availabilityZones) · #(isolatedGroups).
	// Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.
	IsolatedSubnetRouteTableIds *[]*string `field:"optional" json:"isolatedSubnetRouteTableIds" yaml:"isolatedSubnetRouteTableIds"`
	// The ID of the AWS account that owns the VPC.
	// Default: the account id of the parent stack.
	//
	// Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.
	OwnerAccountId *string `field:"optional" json:"ownerAccountId" yaml:"ownerAccountId"`
	// IDs of all private subnets.
	//
	// Element count: #(availabilityZones) · #(privateGroups).
	// Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.
	PrivateSubnetIds *[]*string `field:"optional" json:"privateSubnetIds" yaml:"privateSubnetIds"`
	// Name of private subnet groups.
	//
	// Element count: #(privateGroups).
	// Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.
	PrivateSubnetNames *[]*string `field:"optional" json:"privateSubnetNames" yaml:"privateSubnetNames"`
	// Route Table IDs of private subnet groups.
	//
	// Element count: #(availabilityZones) · #(privateGroups).
	// Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.
	PrivateSubnetRouteTableIds *[]*string `field:"optional" json:"privateSubnetRouteTableIds" yaml:"privateSubnetRouteTableIds"`
	// IDs of all public subnets.
	//
	// Element count: #(availabilityZones) · #(publicGroups).
	// Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.
	PublicSubnetIds *[]*string `field:"optional" json:"publicSubnetIds" yaml:"publicSubnetIds"`
	// Name of public subnet groups.
	//
	// Element count: #(publicGroups).
	// Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.
	PublicSubnetNames *[]*string `field:"optional" json:"publicSubnetNames" yaml:"publicSubnetNames"`
	// Route Table IDs of public subnet groups.
	//
	// Element count: #(availabilityZones) · #(publicGroups).
	// Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.
	PublicSubnetRouteTableIds *[]*string `field:"optional" json:"publicSubnetRouteTableIds" yaml:"publicSubnetRouteTableIds"`
	// The region in which the VPC is in.
	// Default: - Region of the parent stack.
	//
	// Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.
	Region *string `field:"optional" json:"region" yaml:"region"`
	// The subnet groups discovered for the given VPC.
	//
	// Unlike the above properties, this will include asymmetric subnets,
	// if the VPC has any.
	// This property will only be populated if `VpcContextQuery.returnAsymmetricSubnets`
	// is true.
	// Default: - no subnet groups will be returned unless `VpcContextQuery.returnAsymmetricSubnets` is true
	//
	// Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.
	SubnetGroups *[]*VpcSubnetGroup `field:"optional" json:"subnetGroups" yaml:"subnetGroups"`
	// VPC cidr.
	// Default: - CIDR information not available.
	//
	// Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.
	VpcCidrBlock *string `field:"optional" json:"vpcCidrBlock" yaml:"vpcCidrBlock"`
	// The VPN gateway ID.
	// Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.
	VpnGatewayId *string `field:"optional" json:"vpnGatewayId" yaml:"vpnGatewayId"`
}

Properties of a discovered VPC.

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

vpcContextResponse := &VpcContextResponse{
	AvailabilityZones: []*string{
		jsii.String("availabilityZones"),
	},
	VpcId: jsii.String("vpcId"),

	// the properties below are optional
	IsolatedSubnetIds: []*string{
		jsii.String("isolatedSubnetIds"),
	},
	IsolatedSubnetNames: []*string{
		jsii.String("isolatedSubnetNames"),
	},
	IsolatedSubnetRouteTableIds: []*string{
		jsii.String("isolatedSubnetRouteTableIds"),
	},
	OwnerAccountId: jsii.String("ownerAccountId"),
	PrivateSubnetIds: []*string{
		jsii.String("privateSubnetIds"),
	},
	PrivateSubnetNames: []*string{
		jsii.String("privateSubnetNames"),
	},
	PrivateSubnetRouteTableIds: []*string{
		jsii.String("privateSubnetRouteTableIds"),
	},
	PublicSubnetIds: []*string{
		jsii.String("publicSubnetIds"),
	},
	PublicSubnetNames: []*string{
		jsii.String("publicSubnetNames"),
	},
	PublicSubnetRouteTableIds: []*string{
		jsii.String("publicSubnetRouteTableIds"),
	},
	Region: jsii.String("region"),
	SubnetGroups: []VpcSubnetGroup{
		&VpcSubnetGroup{
			Name: jsii.String("name"),
			Subnets: []VpcSubnet{
				&VpcSubnet{
					AvailabilityZone: jsii.String("availabilityZone"),
					RouteTableId: jsii.String("routeTableId"),
					SubnetId: jsii.String("subnetId"),

					// the properties below are optional
					Cidr: jsii.String("cidr"),
				},
			},
			Type: awscdk.Cx_api.VpcSubnetGroupType_PUBLIC,
		},
	},
	VpcCidrBlock: jsii.String("vpcCidrBlock"),
	VpnGatewayId: jsii.String("vpnGatewayId"),
}

Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.

type VpcSubnet deprecated

type VpcSubnet struct {
	// The code of the availability zone this subnet is in (for example, 'us-west-2a').
	// Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.
	AvailabilityZone *string `field:"required" json:"availabilityZone" yaml:"availabilityZone"`
	// The identifier of the route table for this subnet.
	// Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.
	RouteTableId *string `field:"required" json:"routeTableId" yaml:"routeTableId"`
	// The identifier of the subnet.
	// Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.
	SubnetId *string `field:"required" json:"subnetId" yaml:"subnetId"`
	// CIDR range of the subnet.
	// Default: - CIDR information not available.
	//
	// Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.
	Cidr *string `field:"optional" json:"cidr" yaml:"cidr"`
}

A subnet representation that the VPC provider uses.

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

vpcSubnet := &VpcSubnet{
	AvailabilityZone: jsii.String("availabilityZone"),
	RouteTableId: jsii.String("routeTableId"),
	SubnetId: jsii.String("subnetId"),

	// the properties below are optional
	Cidr: jsii.String("cidr"),
}

Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.

type VpcSubnetGroup deprecated

type VpcSubnetGroup struct {
	// The name of the subnet group, determined by looking at the tags of of the subnets that belong to it.
	// Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.
	Name *string `field:"required" json:"name" yaml:"name"`
	// The subnets that are part of this group.
	//
	// There is no condition that the subnets have to be symmetric
	// in the group.
	// Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.
	Subnets *[]*VpcSubnet `field:"required" json:"subnets" yaml:"subnets"`
	// The type of the subnet group.
	// Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.
	Type VpcSubnetGroupType `field:"required" json:"type" yaml:"type"`
}

A group of subnets returned by the VPC provider.

The included subnets do NOT have to be symmetric!

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

vpcSubnetGroup := &VpcSubnetGroup{
	Name: jsii.String("name"),
	Subnets: []VpcSubnet{
		&VpcSubnet{
			AvailabilityZone: jsii.String("availabilityZone"),
			RouteTableId: jsii.String("routeTableId"),
			SubnetId: jsii.String("subnetId"),

			// the properties below are optional
			Cidr: jsii.String("cidr"),
		},
	},
	Type: awscdk.Cx_api.VpcSubnetGroupType_PUBLIC,
}

Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.

type VpcSubnetGroupType ¶

type VpcSubnetGroupType string

The type of subnet group.

Same as SubnetType in the aws-cdk-lib/aws-ec2 package, but we can't use that because of cyclical dependencies. Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.

const (
	// Public subnet group type.
	// Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.
	VpcSubnetGroupType_PUBLIC VpcSubnetGroupType = "PUBLIC"
	// Private subnet group type.
	// Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.
	VpcSubnetGroupType_PRIVATE VpcSubnetGroupType = "PRIVATE"
	// Isolated subnet group type.
	// Deprecated: The definition of this type has moved to `@aws-cdk/cloud-assembly-api`.
	VpcSubnetGroupType_ISOLATED VpcSubnetGroupType = "ISOLATED"
)

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
internal

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL