aws-cdk-lib.aws_bedrockagentcore.CfnRuntime

CfnRuntime L1 construct

Contains information about an agent runtime. An agent runtime is the execution environment for a Amazon Bedrock Agent.

AgentCore Runtime is a secure, serverless runtime purpose-built for deploying and scaling dynamic AI agents and tools using any open-source framework including LangGraph, CrewAI, and Strands Agents, any protocol, and any model.

For more information about using agent runtime in Amazon Bedrock AgentCore, see Host agent or tools with Amazon Bedrock AgentCore Runtime .

See the Properties section below for descriptions of both the required and optional properties.

Construct›CfnElement›CfnRefElement›CfnResource›CfnRuntime

implements

• IInspectable,
• ITaggableV2,
• IEnvironmentAware,
• IRuntimeRef,
• 2 more

  • IConstruct,
  • IDependable

CloudFormation

AWS::BedrockAgentCore::Runtime

Source

Generated code

Type last changed

v2.272.0 · 30 Sep 2026

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_bedrockagentcore as bedrockagentcore } from 'aws-cdk-lib';
const cfnRuntime = new bedrockagentcore.CfnRuntime(this, 'MyCfnRuntime', {
  agentRuntimeArtifact: {
    codeConfiguration: {
      code: {
        s3: {
          bucket: 'bucket',
          prefix: 'prefix',

          // the properties below are optional
          versionId: 'versionId',
        },
      },
      entryPoint: ['entryPoint'],
      runtime: 'runtime',
    },
    containerConfiguration: {
      containerUri: 'containerUri',
    },
  },
  agentRuntimeName: 'agentRuntimeName',
  roleArn: 'roleArn',

  // the properties below are optional
  authorizerConfiguration: {
    customJwtAuthorizer: {
      discoveryUrl: 'discoveryUrl',

      // the properties below are optional
      allowedAudience: ['allowedAudience'],
      allowedClients: ['allowedClients'],
      allowedScopes: ['allowedScopes'],
      allowedWorkloadConfiguration: {
        hostingEnvironments: [{
          arn: 'arn',
        }],
        workloadIdentities: ['workloadIdentities'],
      },
      customClaims: [{
        authorizingClaimMatchValue: {
          claimMatchOperator: 'claimMatchOperator',
          claimMatchValue: {
            matchValueString: 'matchValueString',
            matchValueStringList: ['matchValueStringList'],
          },
        },
        inboundTokenClaimName: 'inboundTokenClaimName',
        inboundTokenClaimValueType: 'inboundTokenClaimValueType',
      }],
      privateEndpoint: {
        managedVpcResource: {
          endpointIpAddressType: 'endpointIpAddressType',
          subnetIds: ['subnetIds'],
          vpcIdentifier: 'vpcIdentifier',

          // the properties below are optional
          routingDomain: 'routingDomain',
          securityGroupIds: ['securityGroupIds'],
          tags: {
            tagsKey: 'tags',
          },
        },
        selfManagedLatticeResource: {
          resourceConfigurationIdentifier: 'resourceConfigurationIdentifier',
        },
      },
      privateEndpointOverrides: [{
        domain: 'domain',
        privateEndpoint: {
          managedVpcResource: {
            endpointIpAddressType: 'endpointIpAddressType',
            subnetIds: ['subnetIds'],
            vpcIdentifier: 'vpcIdentifier',

            // the properties below are optional
            routingDomain: 'routingDomain',
            securityGroupIds: ['securityGroupIds'],
            tags: {
              tagsKey: 'tags',
            },
          },
          selfManagedLatticeResource: {
            resourceConfigurationIdentifier: 'resourceConfigurationIdentifier',
          },
        },
      }],
    },
  },
  capacityProviderConfiguration: {
    capacityProviderArn: 'capacityProviderArn',
  },
  description: 'description',
  environmentVariables: {
    environmentVariablesKey: 'environmentVariables',
  },
  filesystemConfigurations: [{
    capacityProviderVolume: {
      mountPath: 'mountPath',
      volumeName: 'volumeName',
    },
    efsAccessPoint: {
      accessPointArn: 'accessPointArn',
      mountPath: 'mountPath',
    },
    s3FilesAccessPoint: {
      accessPointArn: 'accessPointArn',
      mountPath: 'mountPath',
    },
    sessionStorage: {
      mountPath: 'mountPath',
    },
  }],
  lifecycleConfiguration: {
    idleRuntimeSessionTimeout: 123,
    maxLifetime: 123,
  },
  networkConfiguration: {
    networkMode: 'networkMode',

    // the properties below are optional
    networkModeConfig: {
      securityGroups: ['securityGroups'],
      subnets: ['subnets'],
    },
  },
  platformVersion: 'platformVersion',
  protocolConfiguration: 'protocolConfiguration',
  requestHeaderConfiguration: {
    requestHeaderAllowlist: ['requestHeaderAllowlist'],
  },
  tags: {
    tagsKey: 'tags',
  },
});

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrockagentcore as bedrockagentcore

cfn_runtime = bedrockagentcore.CfnRuntime(self, "MyCfnRuntime",
    agent_runtime_artifact=bedrockagentcore.CfnRuntime.AgentRuntimeArtifactProperty(
        code_configuration=bedrockagentcore.CfnRuntime.CodeConfigurationProperty(
            code=bedrockagentcore.CfnRuntime.CodeProperty(
                s3=bedrockagentcore.CfnRuntime.S3LocationProperty(
                    bucket="bucket",
                    prefix="prefix",

                    # the properties below are optional
                    version_id="versionId"
                )
            ),
            entry_point=["entryPoint"],
            runtime="runtime"
        ),
        container_configuration=bedrockagentcore.CfnRuntime.ContainerConfigurationProperty(
            container_uri="containerUri"
        )
    ),
    agent_runtime_name="agentRuntimeName",
    role_arn="roleArn",

    # the properties below are optional
    authorizer_configuration=bedrockagentcore.CfnRuntime.AuthorizerConfigurationProperty(
        custom_jwt_authorizer=bedrockagentcore.CfnRuntime.CustomJWTAuthorizerConfigurationProperty(
            discovery_url="discoveryUrl",

            # the properties below are optional
            allowed_audience=["allowedAudience"],
            allowed_clients=["allowedClients"],
            allowed_scopes=["allowedScopes"],
            allowed_workload_configuration=bedrockagentcore.CfnRuntime.AllowedWorkloadConfigurationProperty(
                hosting_environments=[bedrockagentcore.CfnRuntime.HostingEnvironmentProperty(
                    arn="arn"
                )],
                workload_identities=["workloadIdentities"]
            ),
            custom_claims=[bedrockagentcore.CfnRuntime.CustomClaimValidationTypeProperty(
                authorizing_claim_match_value=bedrockagentcore.CfnRuntime.AuthorizingClaimMatchValueTypeProperty(
                    claim_match_operator="claimMatchOperator",
                    claim_match_value=bedrockagentcore.CfnRuntime.ClaimMatchValueTypeProperty(
                        match_value_string="matchValueString",
                        match_value_string_list=["matchValueStringList"]
                    )
                ),
                inbound_token_claim_name="inboundTokenClaimName",
                inbound_token_claim_value_type="inboundTokenClaimValueType"
            )],
            private_endpoint=bedrockagentcore.CfnRuntime.PrivateEndpointProperty(
                managed_vpc_resource=bedrockagentcore.CfnRuntime.ManagedVpcResourceProperty(
                    endpoint_ip_address_type="endpointIpAddressType",
                    subnet_ids=["subnetIds"],
                    vpc_identifier="vpcIdentifier",

                    # the properties below are optional
                    routing_domain="routingDomain",
                    security_group_ids=["securityGroupIds"],
                    tags={
                        "tags_key": "tags"
                    }
                ),
                self_managed_lattice_resource=bedrockagentcore.CfnRuntime.SelfManagedLatticeResourceProperty(
                    resource_configuration_identifier="resourceConfigurationIdentifier"
                )
            ),
            private_endpoint_overrides=[bedrockagentcore.CfnRuntime.PrivateEndpointOverrideProperty(
                domain="domain",
                private_endpoint=bedrockagentcore.CfnRuntime.PrivateEndpointProperty(
                    managed_vpc_resource=bedrockagentcore.CfnRuntime.ManagedVpcResourceProperty(
                        endpoint_ip_address_type="endpointIpAddressType",
                        subnet_ids=["subnetIds"],
                        vpc_identifier="vpcIdentifier",

                        # the properties below are optional
                        routing_domain="routingDomain",
                        security_group_ids=["securityGroupIds"],
                        tags={
                            "tags_key": "tags"
                        }
                    ),
                    self_managed_lattice_resource=bedrockagentcore.CfnRuntime.SelfManagedLatticeResourceProperty(
                        resource_configuration_identifier="resourceConfigurationIdentifier"
                    )
                )
            )]
        )
    ),
    capacity_provider_configuration=bedrockagentcore.CfnRuntime.CapacityProviderConfigurationProperty(
        capacity_provider_arn="capacityProviderArn"
    ),
    description="description",
    environment_variables={
        "environment_variables_key": "environmentVariables"
    },
    filesystem_configurations=[bedrockagentcore.CfnRuntime.FilesystemConfigurationProperty(
        capacity_provider_volume=bedrockagentcore.CfnRuntime.CapacityProviderVolumeConfigurationProperty(
            mount_path="mountPath",
            volume_name="volumeName"
        ),
        efs_access_point=bedrockagentcore.CfnRuntime.EfsAccessPointConfigurationProperty(
            access_point_arn="accessPointArn",
            mount_path="mountPath"
        ),
        s3_files_access_point=bedrockagentcore.CfnRuntime.S3FilesAccessPointConfigurationProperty(
            access_point_arn="accessPointArn",
            mount_path="mountPath"
        ),
        session_storage=bedrockagentcore.CfnRuntime.SessionStorageConfigurationProperty(
            mount_path="mountPath"
        )
    )],
    lifecycle_configuration=bedrockagentcore.CfnRuntime.LifecycleConfigurationProperty(
        idle_runtime_session_timeout=123,
        max_lifetime=123
    ),
    network_configuration=bedrockagentcore.CfnRuntime.NetworkConfigurationProperty(
        network_mode="networkMode",

        # the properties below are optional
        network_mode_config=bedrockagentcore.CfnRuntime.VpcConfigProperty(
            security_groups=["securityGroups"],
            subnets=["subnets"]
        )
    ),
    platform_version="platformVersion",
    protocol_configuration="protocolConfiguration",
    request_header_configuration=bedrockagentcore.CfnRuntime.RequestHeaderConfigurationProperty(
        request_header_allowlist=["requestHeaderAllowlist"]
    ),
    tags={
        "tags_key": "tags"
    }
)

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.bedrockagentcore.*;

CfnRuntime cfnRuntime = CfnRuntime.Builder.create(this, "MyCfnRuntime")
        .agentRuntimeArtifact(AgentRuntimeArtifactProperty.builder()
                .codeConfiguration(CodeConfigurationProperty.builder()
                        .code(CodeProperty.builder()
                                .s3(S3LocationProperty.builder()
                                        .bucket("bucket")
                                        .prefix("prefix")

                                        // the properties below are optional
                                        .versionId("versionId")
                                        .build())
                                .build())
                        .entryPoint(List.of("entryPoint"))
                        .runtime("runtime")
                        .build())
                .containerConfiguration(ContainerConfigurationProperty.builder()
                        .containerUri("containerUri")
                        .build())
                .build())
        .agentRuntimeName("agentRuntimeName")
        .roleArn("roleArn")

        // the properties below are optional
        .authorizerConfiguration(AuthorizerConfigurationProperty.builder()
                .customJwtAuthorizer(CustomJWTAuthorizerConfigurationProperty.builder()
                        .discoveryUrl("discoveryUrl")

                        // the properties below are optional
                        .allowedAudience(List.of("allowedAudience"))
                        .allowedClients(List.of("allowedClients"))
                        .allowedScopes(List.of("allowedScopes"))
                        .allowedWorkloadConfiguration(AllowedWorkloadConfigurationProperty.builder()
                                .hostingEnvironments(List.of(HostingEnvironmentProperty.builder()
                                        .arn("arn")
                                        .build()))
                                .workloadIdentities(List.of("workloadIdentities"))
                                .build())
                        .customClaims(List.of(CustomClaimValidationTypeProperty.builder()
                                .authorizingClaimMatchValue(AuthorizingClaimMatchValueTypeProperty.builder()
                                        .claimMatchOperator("claimMatchOperator")
                                        .claimMatchValue(ClaimMatchValueTypeProperty.builder()
                                                .matchValueString("matchValueString")
                                                .matchValueStringList(List.of("matchValueStringList"))
                                                .build())
                                        .build())
                                .inboundTokenClaimName("inboundTokenClaimName")
                                .inboundTokenClaimValueType("inboundTokenClaimValueType")
                                .build()))
                        .privateEndpoint(PrivateEndpointProperty.builder()
                                .managedVpcResource(ManagedVpcResourceProperty.builder()
                                        .endpointIpAddressType("endpointIpAddressType")
                                        .subnetIds(List.of("subnetIds"))
                                        .vpcIdentifier("vpcIdentifier")

                                        // the properties below are optional
                                        .routingDomain("routingDomain")
                                        .securityGroupIds(List.of("securityGroupIds"))
                                        .tags(Map.of(
                                                "tagsKey", "tags"))
                                        .build())
                                .selfManagedLatticeResource(SelfManagedLatticeResourceProperty.builder()
                                        .resourceConfigurationIdentifier("resourceConfigurationIdentifier")
                                        .build())
                                .build())
                        .privateEndpointOverrides(List.of(PrivateEndpointOverrideProperty.builder()
                                .domain("domain")
                                .privateEndpoint(PrivateEndpointProperty.builder()
                                        .managedVpcResource(ManagedVpcResourceProperty.builder()
                                                .endpointIpAddressType("endpointIpAddressType")
                                                .subnetIds(List.of("subnetIds"))
                                                .vpcIdentifier("vpcIdentifier")

                                                // the properties below are optional
                                                .routingDomain("routingDomain")
                                                .securityGroupIds(List.of("securityGroupIds"))
                                                .tags(Map.of(
                                                        "tagsKey", "tags"))
                                                .build())
                                        .selfManagedLatticeResource(SelfManagedLatticeResourceProperty.builder()
                                                .resourceConfigurationIdentifier("resourceConfigurationIdentifier")
                                                .build())
                                        .build())
                                .build()))
                        .build())
                .build())
        .capacityProviderConfiguration(CapacityProviderConfigurationProperty.builder()
                .capacityProviderArn("capacityProviderArn")
                .build())
        .description("description")
        .environmentVariables(Map.of(
                "environmentVariablesKey", "environmentVariables"))
        .filesystemConfigurations(List.of(FilesystemConfigurationProperty.builder()
                .capacityProviderVolume(CapacityProviderVolumeConfigurationProperty.builder()
                        .mountPath("mountPath")
                        .volumeName("volumeName")
                        .build())
                .efsAccessPoint(EfsAccessPointConfigurationProperty.builder()
                        .accessPointArn("accessPointArn")
                        .mountPath("mountPath")
                        .build())
                .s3FilesAccessPoint(S3FilesAccessPointConfigurationProperty.builder()
                        .accessPointArn("accessPointArn")
                        .mountPath("mountPath")
                        .build())
                .sessionStorage(SessionStorageConfigurationProperty.builder()
                        .mountPath("mountPath")
                        .build())
                .build()))
        .lifecycleConfiguration(LifecycleConfigurationProperty.builder()
                .idleRuntimeSessionTimeout(123)
                .maxLifetime(123)
                .build())
        .networkConfiguration(NetworkConfigurationProperty.builder()
                .networkMode("networkMode")

                // the properties below are optional
                .networkModeConfig(VpcConfigProperty.builder()
                        .securityGroups(List.of("securityGroups"))
                        .subnets(List.of("subnets"))
                        .build())
                .build())
        .platformVersion("platformVersion")
        .protocolConfiguration("protocolConfiguration")
        .requestHeaderConfiguration(RequestHeaderConfigurationProperty.builder()
                .requestHeaderAllowlist(List.of("requestHeaderAllowlist"))
                .build())
        .tags(Map.of(
                "tagsKey", "tags"))
        .build();

// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.BedrockAgentCore;

var cfnRuntime = new CfnRuntime(this, "MyCfnRuntime", new CfnRuntimeProps {
    AgentRuntimeArtifact = new AgentRuntimeArtifactProperty {
        CodeConfiguration = new CodeConfigurationProperty {
            Code = new CodeProperty {
                S3 = new S3LocationProperty {
                    Bucket = "bucket",
                    Prefix = "prefix",

                    // the properties below are optional
                    VersionId = "versionId"
                }
            },
            EntryPoint = new [] { "entryPoint" },
            Runtime = "runtime"
        },
        ContainerConfiguration = new ContainerConfigurationProperty {
            ContainerUri = "containerUri"
        }
    },
    AgentRuntimeName = "agentRuntimeName",
    RoleArn = "roleArn",

    // the properties below are optional
    AuthorizerConfiguration = new AuthorizerConfigurationProperty {
        CustomJwtAuthorizer = new CustomJWTAuthorizerConfigurationProperty {
            DiscoveryUrl = "discoveryUrl",

            // the properties below are optional
            AllowedAudience = new [] { "allowedAudience" },
            AllowedClients = new [] { "allowedClients" },
            AllowedScopes = new [] { "allowedScopes" },
            AllowedWorkloadConfiguration = new AllowedWorkloadConfigurationProperty {
                HostingEnvironments = new [] { new HostingEnvironmentProperty {
                    Arn = "arn"
                } },
                WorkloadIdentities = new [] { "workloadIdentities" }
            },
            CustomClaims = new [] { new CustomClaimValidationTypeProperty {
                AuthorizingClaimMatchValue = new AuthorizingClaimMatchValueTypeProperty {
                    ClaimMatchOperator = "claimMatchOperator",
                    ClaimMatchValue = new ClaimMatchValueTypeProperty {
                        MatchValueString = "matchValueString",
                        MatchValueStringList = new [] { "matchValueStringList" }
                    }
                },
                InboundTokenClaimName = "inboundTokenClaimName",
                InboundTokenClaimValueType = "inboundTokenClaimValueType"
            } },
            PrivateEndpoint = new PrivateEndpointProperty {
                ManagedVpcResource = new ManagedVpcResourceProperty {
                    EndpointIpAddressType = "endpointIpAddressType",
                    SubnetIds = new [] { "subnetIds" },
                    VpcIdentifier = "vpcIdentifier",

                    // the properties below are optional
                    RoutingDomain = "routingDomain",
                    SecurityGroupIds = new [] { "securityGroupIds" },
                    Tags = new Dictionary<string, string> {
                        { "tagsKey", "tags" }
                    }
                },
                SelfManagedLatticeResource = new SelfManagedLatticeResourceProperty {
                    ResourceConfigurationIdentifier = "resourceConfigurationIdentifier"
                }
            },
            PrivateEndpointOverrides = new [] { new PrivateEndpointOverrideProperty {
                Domain = "domain",
                PrivateEndpoint = new PrivateEndpointProperty {
                    ManagedVpcResource = new ManagedVpcResourceProperty {
                        EndpointIpAddressType = "endpointIpAddressType",
                        SubnetIds = new [] { "subnetIds" },
                        VpcIdentifier = "vpcIdentifier",

                        // the properties below are optional
                        RoutingDomain = "routingDomain",
                        SecurityGroupIds = new [] { "securityGroupIds" },
                        Tags = new Dictionary<string, string> {
                            { "tagsKey", "tags" }
                        }
                    },
                    SelfManagedLatticeResource = new SelfManagedLatticeResourceProperty {
                        ResourceConfigurationIdentifier = "resourceConfigurationIdentifier"
                    }
                }
            } }
        }
    },
    CapacityProviderConfiguration = new CapacityProviderConfigurationProperty {
        CapacityProviderArn = "capacityProviderArn"
    },
    Description = "description",
    EnvironmentVariables = new Dictionary<string, string> {
        { "environmentVariablesKey", "environmentVariables" }
    },
    FilesystemConfigurations = new [] { new FilesystemConfigurationProperty {
        CapacityProviderVolume = new CapacityProviderVolumeConfigurationProperty {
            MountPath = "mountPath",
            VolumeName = "volumeName"
        },
        EfsAccessPoint = new EfsAccessPointConfigurationProperty {
            AccessPointArn = "accessPointArn",
            MountPath = "mountPath"
        },
        S3FilesAccessPoint = new S3FilesAccessPointConfigurationProperty {
            AccessPointArn = "accessPointArn",
            MountPath = "mountPath"
        },
        SessionStorage = new SessionStorageConfigurationProperty {
            MountPath = "mountPath"
        }
    } },
    LifecycleConfiguration = new LifecycleConfigurationProperty {
        IdleRuntimeSessionTimeout = 123,
        MaxLifetime = 123
    },
    NetworkConfiguration = new NetworkConfigurationProperty {
        NetworkMode = "networkMode",

        // the properties below are optional
        NetworkModeConfig = new VpcConfigProperty {
            SecurityGroups = new [] { "securityGroups" },
            Subnets = new [] { "subnets" }
        }
    },
    PlatformVersion = "platformVersion",
    ProtocolConfiguration = "protocolConfiguration",
    RequestHeaderConfiguration = new RequestHeaderConfigurationProperty {
        RequestHeaderAllowlist = new [] { "requestHeaderAllowlist" }
    },
    Tags = new Dictionary<string, string> {
        { "tagsKey", "tags" }
    }
});

// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// 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"

cfnRuntime := awscdk.Aws_bedrockagentcore.NewCfnRuntime(this, jsii.String("MyCfnRuntime"), &CfnRuntimeProps{
	AgentRuntimeArtifact: &AgentRuntimeArtifactProperty{
		CodeConfiguration: &CodeConfigurationProperty{
			Code: &CodeProperty{
				S3: &S3LocationProperty{
					Bucket: jsii.String("bucket"),
					Prefix: jsii.String("prefix"),

					// the properties below are optional
					VersionId: jsii.String("versionId"),
				},
			},
			EntryPoint: []*string{
				jsii.String("entryPoint"),
			},
			Runtime: jsii.String("runtime"),
		},
		ContainerConfiguration: &ContainerConfigurationProperty{
			ContainerUri: jsii.String("containerUri"),
		},
	},
	AgentRuntimeName: jsii.String("agentRuntimeName"),
	RoleArn: jsii.String("roleArn"),

	// the properties below are optional
	AuthorizerConfiguration: &AuthorizerConfigurationProperty{
		CustomJwtAuthorizer: &CustomJWTAuthorizerConfigurationProperty{
			DiscoveryUrl: jsii.String("discoveryUrl"),

			// the properties below are optional
			AllowedAudience: []*string{
				jsii.String("allowedAudience"),
			},
			AllowedClients: []*string{
				jsii.String("allowedClients"),
			},
			AllowedScopes: []*string{
				jsii.String("allowedScopes"),
			},
			AllowedWorkloadConfiguration: &AllowedWorkloadConfigurationProperty{
				HostingEnvironments: []interface{}{
					&HostingEnvironmentProperty{
						Arn: jsii.String("arn"),
					},
				},
				WorkloadIdentities: []*string{
					jsii.String("workloadIdentities"),
				},
			},
			CustomClaims: []interface{}{
				&CustomClaimValidationTypeProperty{
					AuthorizingClaimMatchValue: &AuthorizingClaimMatchValueTypeProperty{
						ClaimMatchOperator: jsii.String("claimMatchOperator"),
						ClaimMatchValue: &ClaimMatchValueTypeProperty{
							MatchValueString: jsii.String("matchValueString"),
							MatchValueStringList: []*string{
								jsii.String("matchValueStringList"),
							},
						},
					},
					InboundTokenClaimName: jsii.String("inboundTokenClaimName"),
					InboundTokenClaimValueType: jsii.String("inboundTokenClaimValueType"),
				},
			},
			PrivateEndpoint: &PrivateEndpointProperty{
				ManagedVpcResource: &ManagedVpcResourceProperty{
					EndpointIpAddressType: jsii.String("endpointIpAddressType"),
					SubnetIds: []*string{
						jsii.String("subnetIds"),
					},
					VpcIdentifier: jsii.String("vpcIdentifier"),

					// the properties below are optional
					RoutingDomain: jsii.String("routingDomain"),
					SecurityGroupIds: []*string{
						jsii.String("securityGroupIds"),
					},
					Tags: map[string]*string{
						"tagsKey": jsii.String("tags"),
					},
				},
				SelfManagedLatticeResource: &SelfManagedLatticeResourceProperty{
					ResourceConfigurationIdentifier: jsii.String("resourceConfigurationIdentifier"),
				},
			},
			PrivateEndpointOverrides: []interface{}{
				&PrivateEndpointOverrideProperty{
					Domain: jsii.String("domain"),
					PrivateEndpoint: &PrivateEndpointProperty{
						ManagedVpcResource: &ManagedVpcResourceProperty{
							EndpointIpAddressType: jsii.String("endpointIpAddressType"),
							SubnetIds: []*string{
								jsii.String("subnetIds"),
							},
							VpcIdentifier: jsii.String("vpcIdentifier"),

							// the properties below are optional
							RoutingDomain: jsii.String("routingDomain"),
							SecurityGroupIds: []*string{
								jsii.String("securityGroupIds"),
							},
							Tags: map[string]*string{
								"tagsKey": jsii.String("tags"),
							},
						},
						SelfManagedLatticeResource: &SelfManagedLatticeResourceProperty{
							ResourceConfigurationIdentifier: jsii.String("resourceConfigurationIdentifier"),
						},
					},
				},
			},
		},
	},
	CapacityProviderConfiguration: &CapacityProviderConfigurationProperty{
		CapacityProviderArn: jsii.String("capacityProviderArn"),
	},
	Description: jsii.String("description"),
	EnvironmentVariables: map[string]*string{
		"environmentVariablesKey": jsii.String("environmentVariables"),
	},
	FilesystemConfigurations: []interface{}{
		&FilesystemConfigurationProperty{
			CapacityProviderVolume: &CapacityProviderVolumeConfigurationProperty{
				MountPath: jsii.String("mountPath"),
				VolumeName: jsii.String("volumeName"),
			},
			EfsAccessPoint: &EfsAccessPointConfigurationProperty{
				AccessPointArn: jsii.String("accessPointArn"),
				MountPath: jsii.String("mountPath"),
			},
			S3FilesAccessPoint: &S3FilesAccessPointConfigurationProperty{
				AccessPointArn: jsii.String("accessPointArn"),
				MountPath: jsii.String("mountPath"),
			},
			SessionStorage: &SessionStorageConfigurationProperty{
				MountPath: jsii.String("mountPath"),
			},
		},
	},
	LifecycleConfiguration: &LifecycleConfigurationProperty{
		IdleRuntimeSessionTimeout: jsii.Number(123),
		MaxLifetime: jsii.Number(123),
	},
	NetworkConfiguration: &NetworkConfigurationProperty{
		NetworkMode: jsii.String("networkMode"),

		// the properties below are optional
		NetworkModeConfig: &VpcConfigProperty{
			SecurityGroups: []*string{
				jsii.String("securityGroups"),
			},
			Subnets: []*string{
				jsii.String("subnets"),
			},
		},
	},
	PlatformVersion: jsii.String("platformVersion"),
	ProtocolConfiguration: jsii.String("protocolConfiguration"),
	RequestHeaderConfiguration: &RequestHeaderConfigurationProperty{
		RequestHeaderAllowlist: []*string{
			jsii.String("requestHeaderAllowlist"),
		},
	},
	Tags: map[string]*string{
		"tagsKey": jsii.String("tags"),
	},
})

Initializer

new CfnRuntime(scope: Construct, id: string, props: CfnRuntimeProps)

CfnRuntime(scope: Construct, id: str, props: CfnRuntimeProps)

new CfnRuntime(Construct scope, String id, CfnRuntimeProps props)

new CfnRuntime(Construct scope, string id, CfnRuntimeProps props)

NewCfnRuntime(Scope Construct, Id *string, Props CfnRuntimeProps)

Construct Props

agentRuntimeArtifactIResolvable | CfnRuntime.AgentRuntimeArtifactPropertyagent_runtime_artifacttyping.Union[IResolvable, AgentRuntimeArtifactProperty]agentRuntimeArtifactIResolvableAgentRuntimeArtifactIResolvableAgentRuntimeArtifactinterface{}required#

The artifact of the agent.

agentRuntimeNamestringagent_runtime_namestragentRuntimeNameStringAgentRuntimeNamestringAgentRuntimeName*stringrequired#

The name of the AgentCore Runtime endpoint.

authorizerConfiguration?optionalIResolvable | CfnRuntime.AuthorizerConfigurationPropertyauthorizer_configuration?optionaltyping.Union[IResolvable, AuthorizerConfigurationProperty]authorizerConfiguration?optionalIResolvableAuthorizerConfiguration?optionalIResolvableAuthorizerConfiguration?optionalinterface{}#

Represents inbound authorization configuration options used to authenticate incoming requests.

capacityProviderConfiguration?optionalIResolvable | CfnRuntime.CapacityProviderConfigurationPropertycapacity_provider_configuration?optionaltyping.Union[IResolvable, CapacityProviderConfigurationProperty]capacityProviderConfiguration?optionalIResolvableCapacityProviderConfiguration?optionalIResolvableCapacityProviderConfiguration?optionalinterface{}#

Configuration for a capacity provider.

description?optionalstringdescription?optionalstrdescription?optionalStringDescription?optionalstringDescription?optional*string#

The agent runtime description.

environmentVariables?optionalIResolvable | { [key: string]: string }environment_variables?optionaltyping.Union[IResolvable, typing.Mapping[str, str]]environmentVariables?optionalIResolvableEnvironmentVariables?optionalIResolvableEnvironmentVariables?optionalinterface{}#

The environment variables for the agent.

filesystemConfigurations?optionalIResolvable | IResolvable | CfnRuntime.FilesystemConfigurationProperty[]filesystem_configurations?optionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, FilesystemConfigurationProperty]]]filesystemConfigurations?optionalIResolvableFilesystemConfigurations?optionalIResolvableFilesystemConfigurations?optionalinterface{}#

List of filesystem configurations.

lifecycleConfiguration?optionalIResolvable | CfnRuntime.LifecycleConfigurationPropertylifecycle_configuration?optionaltyping.Union[IResolvable, LifecycleConfigurationProperty]lifecycleConfiguration?optionalIResolvableLifecycleConfiguration?optionalIResolvableLifecycleConfiguration?optionalinterface{}#

Configuration for managing the lifecycle of runtime sessions and resources.

networkConfiguration?optionalIResolvable | CfnRuntime.NetworkConfigurationPropertynetwork_configuration?optionaltyping.Union[IResolvable, NetworkConfigurationProperty]networkConfiguration?optionalIResolvableNetworkConfiguration?optionalIResolvableNetworkConfiguration?optionalinterface{}#

The network configuration.

platformVersion?optionalstringplatform_version?optionalstrplatformVersion?optionalStringPlatformVersion?optionalstringPlatformVersion?optional*string#

protocolConfiguration?optionalstringprotocol_configuration?optionalstrprotocolConfiguration?optionalStringProtocolConfiguration?optionalstringProtocolConfiguration?optional*string#

The protocol configuration for an agent runtime.

This structure defines how the agent runtime communicates with clients.

requestHeaderConfiguration?optionalIResolvable | CfnRuntime.RequestHeaderConfigurationPropertyrequest_header_configuration?optionaltyping.Union[IResolvable, RequestHeaderConfigurationProperty]requestHeaderConfiguration?optionalIResolvableRequestHeaderConfiguration?optionalIResolvableRequestHeaderConfiguration?optionalinterface{}#

Configuration for HTTP request headers.

roleArnstringrole_arnstrroleArnStringRoleArnstringRoleArn*stringrequired#

The Amazon Resource Name (ARN) for for the role.

tags?optional{ [key: string]: string }tags?optionaltyping.Mapping[str, str]tags?optionalMap<String, String>Tags?optionalIDictionary<string, string>Tags?optional*map[string]*string#

The tags for the agent.

Properties

agentRuntimeArtifactIResolvable | CfnRuntime.AgentRuntimeArtifactPropertyagent_runtime_artifacttyping.Union[IResolvable, AgentRuntimeArtifactProperty]agentRuntimeArtifactIResolvableAgentRuntimeArtifactIResolvableAgentRuntimeArtifactinterface{}#

The artifact of the agent.

agentRuntimeNamestringagent_runtime_namestragentRuntimeNameStringAgentRuntimeNamestringAgentRuntimeName*string#

The name of the AgentCore Runtime endpoint.

attrAgentRuntimeArnstringattr_agent_runtime_arnstrattrAgentRuntimeArnStringAttrAgentRuntimeArnstringAttrAgentRuntimeArn*string#

The agent runtime ARN.

attrAgentRuntimeIdstringattr_agent_runtime_idstrattrAgentRuntimeIdStringAttrAgentRuntimeIdstringAttrAgentRuntimeId*string#

The ID for the agent runtime.

attrAgentRuntimeVersionstringattr_agent_runtime_versionstrattrAgentRuntimeVersionStringAttrAgentRuntimeVersionstringAttrAgentRuntimeVersion*string#

The version for the agent runtime.

attrCreatedAtstringattr_created_atstrattrCreatedAtStringAttrCreatedAtstringAttrCreatedAt*string#

The time at which the runtime was created.

attrFailureReasonstringattr_failure_reasonstrattrFailureReasonStringAttrFailureReasonstringAttrFailureReason*string#

The reason for failure if the agent is in a failed state.

attrLastUpdatedAtstringattr_last_updated_atstrattrLastUpdatedAtStringAttrLastUpdatedAtstringAttrLastUpdatedAt*string#

The time at which the runtime was last updated.

attrStatusstringattr_statusstrattrStatusStringAttrStatusstringAttrStatus*string#

The status for the agent runtime.

attrWorkloadIdentityDetailsIResolvableattr_workload_identity_detailsIResolvableattrWorkloadIdentityDetailsIResolvableAttrWorkloadIdentityDetailsIResolvableAttrWorkloadIdentityDetailsIResolvable#

Configuration for workload identity.

authorizerConfiguration?may be undefinedIResolvable | CfnRuntime.AuthorizerConfigurationPropertyauthorizer_configuration?may be undefinedtyping.Union[IResolvable, AuthorizerConfigurationProperty]authorizerConfiguration?may be undefinedIResolvableAuthorizerConfiguration?may be undefinedIResolvableAuthorizerConfiguration?may be undefinedinterface{}#

Represents inbound authorization configuration options used to authenticate incoming requests.

capacityProviderConfiguration?may be undefinedIResolvable | CfnRuntime.CapacityProviderConfigurationPropertycapacity_provider_configuration?may be undefinedtyping.Union[IResolvable, CapacityProviderConfigurationProperty]capacityProviderConfiguration?may be undefinedIResolvableCapacityProviderConfiguration?may be undefinedIResolvableCapacityProviderConfiguration?may be undefinedinterface{}#

Configuration for a capacity provider.

cdkTagManagerTagManagercdk_tag_managerTagManagercdkTagManagerTagManagerCdkTagManagerTagManagerCdkTagManagerTagManager#

Tag Manager which manages the tags for this resource.

CFN_RESOURCE_TYPE_NAMEstringcfn_resource_type_namestrCFN_RESOURCE_TYPE_NAMEStringCFN_RESOURCE_TYPE_NAMEstringCFN_RESOURCE_TYPE_NAME*stringstatic#

The CloudFormation resource type name for this resource class.

cfnOptionsICfnResourceOptionscfn_optionsICfnResourceOptionscfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptions#

Options for this resource, such as condition, update policy etc.

cfnResourceTypestringcfn_resource_typestrcfnResourceTypeStringCfnResourceTypestringCfnResourceType*string#

AWS resource type.

creationStackstring[]creation_stacktyping.List[str]creationStackList<String>CreationStackstring[]CreationStack*[]*string#

description?may be undefinedstringdescription?may be undefinedstrdescription?may be undefinedStringDescription?may be undefinedstringDescription?may be undefined*string#

The agent runtime description.

envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironment#

environmentVariables?may be undefinedIResolvable | { [key: string]: string }environment_variables?may be undefinedtyping.Union[IResolvable, typing.Mapping[str, str]]environmentVariables?may be undefinedIResolvableEnvironmentVariables?may be undefinedIResolvableEnvironmentVariables?may be undefinedinterface{}#

The environment variables for the agent.

filesystemConfigurations?may be undefinedIResolvable | IResolvable | CfnRuntime.FilesystemConfigurationProperty[]filesystem_configurations?may be undefinedtyping.Union[IResolvable, typing.List[typing.Union[IResolvable, FilesystemConfigurationProperty]]]filesystemConfigurations?may be undefinedIResolvableFilesystemConfigurations?may be undefinedIResolvableFilesystemConfigurations?may be undefinedinterface{}#

List of filesystem configurations.

lifecycleConfiguration?may be undefinedIResolvable | CfnRuntime.LifecycleConfigurationPropertylifecycle_configuration?may be undefinedtyping.Union[IResolvable, LifecycleConfigurationProperty]lifecycleConfiguration?may be undefinedIResolvableLifecycleConfiguration?may be undefinedIResolvableLifecycleConfiguration?may be undefinedinterface{}#

Configuration for managing the lifecycle of runtime sessions and resources.

logicalIdstringlogical_idstrlogicalIdStringLogicalIdstringLogicalId*string#

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

networkConfiguration?may be undefinedIResolvable | CfnRuntime.NetworkConfigurationPropertynetwork_configuration?may be undefinedtyping.Union[IResolvable, NetworkConfigurationProperty]networkConfiguration?may be undefinedIResolvableNetworkConfiguration?may be undefinedIResolvableNetworkConfiguration?may be undefinedinterface{}#

The network configuration.

nodeNodenodeNodenodeNodeNodeNodeNodeNode#

The tree node.

platformVersion?may be undefinedstringplatform_version?may be undefinedstrplatformVersion?may be undefinedStringPlatformVersion?may be undefinedstringPlatformVersion?may be undefined*string#

protocolConfiguration?may be undefinedstringprotocol_configuration?may be undefinedstrprotocolConfiguration?may be undefinedStringProtocolConfiguration?may be undefinedstringProtocolConfiguration?may be undefined*string#

The protocol configuration for an agent runtime.

refstringrefstrrefStringRefstringRef*string#

Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

requestHeaderConfiguration?may be undefinedIResolvable | CfnRuntime.RequestHeaderConfigurationPropertyrequest_header_configuration?may be undefinedtyping.Union[IResolvable, RequestHeaderConfigurationProperty]requestHeaderConfiguration?may be undefinedIResolvableRequestHeaderConfiguration?may be undefinedIResolvableRequestHeaderConfiguration?may be undefinedinterface{}#

Configuration for HTTP request headers.

roleArnstringrole_arnstrroleArnStringRoleArnstringRoleArn*string#

The Amazon Resource Name (ARN) for for the role.

runtimeRefRuntimeReferenceruntime_refRuntimeReferenceruntimeRefRuntimeReferenceRuntimeRefRuntimeReferenceRuntimeRefRuntimeReference#

A reference to a Runtime resource.

stackStackstackStackstackStackStackStackStackStack#

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tags?may be undefined{ [key: string]: string }tags?may be undefinedtyping.Mapping[str, str]tags?may be undefinedMap<String, String>Tags?may be undefinedIDictionary<string, string>Tags?may be undefined*map[string]*string#

The tags for the agent.

Methods

addDeletionOverride(path: string): voiddef add_deletion_override(self, path: str) -> Nonepublic void addDeletionOverride(String path)public void AddDeletionOverride(string path)func AddDeletionOverride(Path *string)#

Syntactic sugar for `addOverride(path, undefined)`.

1 parameter

Parameters

• pathpathpathpathPath — The path of the value to delete.

addDependency(target: CfnResource): voiddef add_dependency(self, target: CfnResource) -> Nonepublic void addDependency(CfnResource target)public void AddDependency(CfnResource target)func AddDependency(Target CfnResource)deprecated#

Use `addResourceDependency` instead.

This method has been renamed to addResourceDependency to more clearly set it apart from construct.node.addDependency. See the documentation of that function for more details.

addDependsOn(target: CfnResource): voiddef add_depends_on(self, target: CfnResource) -> Nonepublic void addDependsOn(CfnResource target)public void AddDependsOn(CfnResource target)func AddDependsOn(Target CfnResource)deprecated#

Use `addResourceDependency` instead.

notes

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

This method has been renamed to addResourceDependency, which makes it more clear that this method operates at a different level from the construct-level construct.node.addDependency() mechanism.

addMetadata(key: string, value: any): voiddef add_metadata(self, key: str, value: Any) -> Nonepublic void addMetadata(String key, Object value)public void AddMetadata(string key, object value)func AddMetadata(Key *string, Value interface{})#

Add a value to the CloudFormation Resource Metadata.

addOverride(path: string, value: any): voiddef add_override(self, path: str, value: Any) -> Nonepublic void addOverride(String path, Object value)public void AddOverride(string path, object value)func AddOverride(Path *string, Value interface{})#

Adds an override to the synthesized CloudFormation resource.

notes · 2 parameters

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters

• pathpathpathpathPath — - The path of the property, you can use dot notation to override values in complex types.
• valuevaluevaluevalueValue — - The value.

addPropertyDeletionOverride(propertyPath: string): voiddef add_property_deletion_override(self, property_path: str) -> Nonepublic void addPropertyDeletionOverride(String propertyPath)public void AddPropertyDeletionOverride(string propertyPath)func AddPropertyDeletionOverride(PropertyPath *string)#

Adds an override that deletes the value of a property from the resource definition.

1 parameter

Parameters

• propertyPathproperty_pathpropertyPathpropertyPathPropertyPath — The path to the property.

addPropertyOverride(propertyPath: string, value: any): voiddef add_property_override(self, property_path: str, value: Any) -> Nonepublic void addPropertyOverride(String propertyPath, Object value)public void AddPropertyOverride(string propertyPath, object value)func AddPropertyOverride(PropertyPath *string, Value interface{})#

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

2 parameters

Parameters

• propertyPathproperty_pathpropertyPathpropertyPathPropertyPath — The path of the property.
• valuevaluevaluevalueValue — The value.

addResourceDependency(target: CfnResource, reason?: string): voiddef add_resource_dependency(self, target: CfnResource, reason: typing.Optional[str] = None) -> Nonepublic void addResourceDependency(CfnResource target, String reason)public void AddResourceDependency(CfnResource target, string? reason = null)func AddResourceDependency(Target CfnResource, Reason *string)#

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

notes

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

This method only adds dependencies between L1 resources. If you are looking for a generic construct-to-construct dependency mechanism that works for all constructs including L2s, use construct.node.addDependency instead.

applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

1 parameter

Parameters

• strengthstrengthstrengthstrengthStrength — - The reference strength to use for this resource.

applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): voiddef apply_removal_policy(self, policy: typing.Optional[RemovalPolicy] = None, options: typing.Optional[RemovalPolicyOptions] = None) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy, RemovalPolicyOptions options)public void ApplyRemovalPolicy(RemovalPolicy? policy = null, RemovalPolicyOptions? options = null)func ApplyRemovalPolicy(Policy RemovalPolicy, Options RemovalPolicyOptions)#

Sets the deletion policy of the resource based on the removal policy specified.

notes

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

arnForRuntime(resource: IRuntimeRef): string@staticmethod def arn_for_runtime(resource: IRuntimeRef) -> strpublic static String arnForRuntime(IRuntimeRef resource)public static string ArnForRuntime(IRuntimeRef resource)func ArnForRuntime(Resource IRuntimeRef) *stringstatic#

cfnPropertyName(cdkPropertyName: string): stringdef cfn_property_name(self, cdk_property_name: str) -> strpublic String cfnPropertyName(String cdkPropertyName)public string CfnPropertyName(string cdkPropertyName)func CfnPropertyName(CdkPropertyName *string) *string#

getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Referencedef get_att(self, attribute_name: str, type_hint: typing.Optional[ResolutionTypeHint] = None) -> Referencepublic Reference getAtt(String attributeName, ResolutionTypeHint typeHint)public Reference GetAtt(string attributeName, ResolutionTypeHint? typeHint = null)func GetAtt(AttributeName *string, TypeHint ResolutionTypeHint) Reference#

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

1 parameter

Parameters

• attributeNameattribute_nameattributeNameattributeNameAttributeName — The name of the attribute.

getMetadata(key: string): anydef get_metadata(self, key: str) -> Anypublic Object getMetadata(String key)public object GetMetadata(string key)func GetMetadata(Key *string) interface{}#

Retrieve a value value from the CloudFormation Resource Metadata.

inspect(inspector: TreeInspector): voiddef inspect(self, inspector: TreeInspector) -> Nonepublic void inspect(TreeInspector inspector)public void Inspect(TreeInspector inspector)func Inspect(Inspector TreeInspector)#

Examines the CloudFormation resource and discloses attributes.

1 parameter

Parameters

• inspectorinspectorinspectorinspectorInspector — tree inspector to collect and process attributes.

isCfnElement(x: any): boolean@staticmethod def is_cfn_element(x: Any) -> boolpublic static Boolean isCfnElement(Object x)public static bool IsCfnElement(object x)func IsCfnElement(X interface{}) *boolstatic#

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

returns

Returns: The construct as a stack element or undefined if it is not a stack element.

isCfnResource(x: any): boolean@staticmethod def is_cfn_resource(x: Any) -> boolpublic static Boolean isCfnResource(Object x)public static bool IsCfnResource(object x)func IsCfnResource(X interface{}) *boolstatic#

Check whether the given object is a CfnResource.

isCfnRuntime(x: any): boolean@staticmethod def is_cfn_runtime(x: Any) -> boolpublic static Boolean isCfnRuntime(Object x)public static bool IsCfnRuntime(object x)func IsCfnRuntime(X interface{}) *boolstatic#

Checks whether the given object is a CfnRuntime.

isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#

Checks if `x` is a construct.

notes · 1 parameter · returns

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

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs 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 constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters

• xxxxX — Any object.

Returns: true if x is an object created from a class which extends Construct.

obtainDependencies(): Stack | CfnResource[]def obtain_dependencies(self, ) -> typing.List[typing.Union[Stack, CfnResource]]public List<Stack> obtainDependencies()public Stack[] ObtainDependencies()func ObtainDependencies() *[]interface{}#

Retrieves an array of resources and stacks this resource depends on.

For resources depended on directly, returns the CfnResource object. For dependencies on other stacks, returns the Stack object. The order of the array is not guaranteed.

overrideLogicalId(newLogicalId: string): voiddef override_logical_id(self, new_logical_id: str) -> Nonepublic void overrideLogicalId(String newLogicalId)public void OverrideLogicalId(string newLogicalId)func OverrideLogicalId(NewLogicalId *string)#

Overrides the auto-generated logical ID with a specific ID.

1 parameter

Parameters

• newLogicalIdnew_logical_idnewLogicalIdnewLogicalIdNewLogicalId — The new logical ID to use for this stack element.

removeDependency(target: CfnResource): voiddef remove_dependency(self, target: CfnResource) -> Nonepublic void removeDependency(CfnResource target)public void RemoveDependency(CfnResource target)func RemoveDependency(Target CfnResource)deprecated#

Use `removeResourceDependency` instead

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

removeResourceDependency(target: CfnResource): voiddef remove_resource_dependency(self, target: CfnResource) -> Nonepublic void removeResourceDependency(CfnResource target)public void RemoveResourceDependency(CfnResource target)func RemoveResourceDependency(Target CfnResource)#

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

replaceDependency(target: CfnResource, newTarget: CfnResource): voiddef replace_dependency(self, target: CfnResource, new_target: CfnResource) -> Nonepublic void replaceDependency(CfnResource target, CfnResource newTarget)public void ReplaceDependency(CfnResource target, CfnResource newTarget)func ReplaceDependency(Target CfnResource, NewTarget CfnResource)#

Replaces one dependency with another.

2 parameters

Parameters

• targettargettargettargetTarget — The dependency to replace.
• newTargetnew_targetnewTargetnewTargetNewTarget — The new dependency to add.

toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#

Returns a string representation of this construct.

returns

Returns: a string representation of this resource

with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.