Skip to content
v2.277.0

CfnRoute L1 construct ​

Creates an AWS Migration Hub Refactor Spaces route.

The account owner of the service resource is always the environment owner, regardless of which account creates the route. Routes target a service in the application. If an application does not have any routes, then the first route must be created as a DEFAULT RouteType .

When created, the default route defaults to an active state so state is not a required input. However, like all other state values the state of the default route can be updated after creation, but only when all other routes are also inactive. Conversely, no route can be active without the default route also being active.

In the AWS::RefactorSpaces::Route resource, you can only update the ActivationState property, which resides under the UriPathRoute and DefaultRoute properties. All other properties associated with the AWS::RefactorSpaces::Route cannot be updated, even though the property description might indicate otherwise. Updating all other properties will result in the replacement of Route.

When you create a route, Refactor Spaces configures the ABPlong to send traffic to the target service as follows:

  • URL Endpoints

If the service has a URL endpoint, and the endpoint resolves to a private IP address, Refactor Spaces routes traffic using the ABP VPC link. If a service endpoint resolves to a public IP address, Refactor Spaces routes traffic over the public internet. Services can have HTTP or HTTPS URL endpoints. For HTTPS URLs, publicly-signed certificates are supported. Private Certificate Authorities (CAs) are permitted only if the CA's domain is also publicly resolvable.

Refactor Spaces automatically resolves the public Domain Name System (DNS) names that are set in CreateService:UrlEndpoint when you create a service. The DNS names resolve when the DNS time-to-live (TTL) expires, or every 60 seconds for TTLs less than 60 seconds. This periodic DNS resolution ensures that the route configuration remains up-to-date.

One-time health check

A one-time health check is performed on the service when either the route is updated from inactive to active, or when it is created with an active state. If the health check fails, the route transitions the route state to FAILED , an error code of SERVICE_ENDPOINT_HEALTH_CHECK_FAILURE is provided, and no traffic is sent to the service.

For private URLs, a target group is created on the Network Load Balancer and the load balancer target group runs default target health checks. By default, the health check is run against the service endpoint URL. Optionally, the health check can be performed against a different protocol, port, and/or path using the CreateService:UrlEndpoint parameter. All other health check settings for the load balancer use the default values described in the Health checks for your target groups in the Elastic Load Balancing guide . The health check is considered successful if at least one target within the target group transitions to a healthy state.

  • AWS Lambda function endpoints

If the service has an AWS Lambda function endpoint, then Refactor Spaces configures the Lambda function's resource policy to allow the application's ABP to invoke the function.

The Lambda function state is checked. If the function is not active, the function configuration is updated so that Lambda resources are provisioned. If the Lambda state is Failed , then the route creation fails. For more information, see the GetFunctionConfiguration's State response parameter in the AWS Lambda Developer Guide .

A check is performed to determine that a Lambda function with the specified ARN exists. If it does not exist, the health check fails. For public URLs, a connection is opened to the public endpoint. If the URL is not reachable, the health check fails.

Environments without a network bridge

When you create environments without a network bridge ( CreateEnvironment:NetworkFabricType is NONE) and you use your own networking infrastructure, you need to configure VPC to VPC connectivity between your network and the application proxy VPC. Route creation from the application proxy to service endpoints will fail if your network is not configured to connect to the application proxy VPC. For more information, see Create a route in the Refactor Spaces User Guide .

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_refactorspaces as refactorspaces } from 'aws-cdk-lib';
const cfnRoute = new refactorspaces.CfnRoute(this, 'MyCfnRoute', {
  applicationIdentifier: 'applicationIdentifier',
  environmentIdentifier: 'environmentIdentifier',
  routeType: 'routeType',
  serviceIdentifier: 'serviceIdentifier',

  // the properties below are optional
  defaultRoute: {
    activationState: 'activationState',
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
  uriPathRoute: {
    activationState: 'activationState',

    // the properties below are optional
    appendSourcePath: false,
    includeChildPaths: false,
    methods: ['methods'],
    sourcePath: 'sourcePath',
  },
});
python
from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_refactorspaces as refactorspaces

cfn_route = refactorspaces.CfnRoute(self, "MyCfnRoute",
    application_identifier="applicationIdentifier",
    environment_identifier="environmentIdentifier",
    route_type="routeType",
    service_identifier="serviceIdentifier",

    # the properties below are optional
    default_route=refactorspaces.CfnRoute.DefaultRouteInputProperty(
        activation_state="activationState"
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    uri_path_route=refactorspaces.CfnRoute.UriPathRouteInputProperty(
        activation_state="activationState",

        # the properties below are optional
        append_source_path=False,
        include_child_paths=False,
        methods=["methods"],
        source_path="sourcePath"
    )
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.refactorspaces.*;

CfnRoute cfnRoute = CfnRoute.Builder.create(this, "MyCfnRoute")
        .applicationIdentifier("applicationIdentifier")
        .environmentIdentifier("environmentIdentifier")
        .routeType("routeType")
        .serviceIdentifier("serviceIdentifier")

        // the properties below are optional
        .defaultRoute(DefaultRouteInputProperty.builder()
                .activationState("activationState")
                .build())
        .tags(List.of(CfnTag.builder()
                .key("key")
                .value("value")
                .build()))
        .uriPathRoute(UriPathRouteInputProperty.builder()
                .activationState("activationState")

                // the properties below are optional
                .appendSourcePath(false)
                .includeChildPaths(false)
                .methods(List.of("methods"))
                .sourcePath("sourcePath")
                .build())
        .build();
csharp
// 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.RefactorSpaces;

var cfnRoute = new CfnRoute(this, "MyCfnRoute", new CfnRouteProps {
    ApplicationIdentifier = "applicationIdentifier",
    EnvironmentIdentifier = "environmentIdentifier",
    RouteType = "routeType",
    ServiceIdentifier = "serviceIdentifier",

    // the properties below are optional
    DefaultRoute = new DefaultRouteInputProperty {
        ActivationState = "activationState"
    },
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } },
    UriPathRoute = new UriPathRouteInputProperty {
        ActivationState = "activationState",

        // the properties below are optional
        AppendSourcePath = false,
        IncludeChildPaths = false,
        Methods = new [] { "methods" },
        SourcePath = "sourcePath"
    }
});
go
// 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"

cfnRoute := awscdk.Aws_refactorspaces.NewCfnRoute(this, jsii.String("MyCfnRoute"), &CfnRouteProps{
	ApplicationIdentifier: jsii.String("applicationIdentifier"),
	EnvironmentIdentifier: jsii.String("environmentIdentifier"),
	RouteType: jsii.String("routeType"),
	ServiceIdentifier: jsii.String("serviceIdentifier"),

	// the properties below are optional
	DefaultRoute: &DefaultRouteInputProperty{
		ActivationState: jsii.String("activationState"),
	},
	Tags: []CfnTag{
		&CfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
	UriPathRoute: &UriPathRouteInputProperty{
		ActivationState: jsii.String("activationState"),

		// the properties below are optional
		AppendSourcePath: jsii.Boolean(false),
		IncludeChildPaths: jsii.Boolean(false),
		Methods: []*string{
			jsii.String("methods"),
		},
		SourcePath: jsii.String("sourcePath"),
	},
})

Initializer ​

ts
new CfnRoute(scope: Construct, id: string, props: CfnRouteProps)
python
CfnRoute(scope: Construct, id: str, props: CfnRouteProps)
java
new CfnRoute(Construct scope, String id, CfnRouteProps props)
csharp
new CfnRoute(Construct scope, string id, CfnRouteProps props)
go
NewCfnRoute(Scope Construct, Id *string, Props CfnRouteProps)

Construct Props ​

applicationIdentifierstring | IApplicationRefapplication_identifiertyping.Union[str, IApplicationRef]applicationIdentifierStringApplicationIdentifierstringApplicationIdentifierinterface{}required#
The unique identifier of the application.
defaultRouteoptionalIResolvable | CfnRoute.DefaultRouteInputPropertydefault_routeoptionaltyping.Union[IResolvable, DefaultRouteInputProperty]defaultRouteoptionalIResolvableDefaultRouteoptionalIResolvableDefaultRouteoptionalinterface{}#
Configuration for the default route type.
environmentIdentifierstring | IEnvironmentRefenvironment_identifiertyping.Union[str, IEnvironmentRef]environmentIdentifierStringEnvironmentIdentifierstringEnvironmentIdentifierinterface{}required#
The unique identifier of the environment.
routeTypestringroute_typestrrouteTypeStringRouteTypestringRouteType*stringrequired#
The route type of the route.
serviceIdentifierstring | IServiceRefservice_identifiertyping.Union[str, IServiceRef]serviceIdentifierStringServiceIdentifierstringServiceIdentifierinterface{}required#
The unique identifier of the service.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
The tags assigned to the route.
uriPathRouteoptionalIResolvable | CfnRoute.UriPathRouteInputPropertyuri_path_routeoptionaltyping.Union[IResolvable, UriPathRouteInputProperty]uriPathRouteoptionalIResolvableUriPathRouteoptionalIResolvableUriPathRouteoptionalinterface{}#
The configuration for the URI path route type.

Properties ​

applicationIdentifierstringapplication_identifierstrapplicationIdentifierStringApplicationIdentifierstringApplicationIdentifier*string#
The unique identifier of the application.
attrArnstringattr_arnstrattrArnStringAttrArnstringAttrArn*string#
The Amazon Resource Name (ARN) of the route.
attrPathResourceToIdstringattr_path_resource_to_idstrattrPathResourceToIdStringAttrPathResourceToIdstringAttrPathResourceToId*string#
A mapping of ABPlong path resources to resource IDs.
attrRouteIdentifierstringattr_route_identifierstrattrRouteIdentifierStringAttrRouteIdentifierstringAttrRouteIdentifier*string#
The unique identifier of the route.
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.
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#
defaultRoutemay be undefinedIResolvable | CfnRoute.DefaultRouteInputPropertydefault_routemay be undefinedtyping.Union[IResolvable, DefaultRouteInputProperty]defaultRoutemay be undefinedIResolvableDefaultRoutemay be undefinedIResolvableDefaultRoutemay be undefinedinterface{}#
Configuration for the default route type.
environmentIdentifierstringenvironment_identifierstrenvironmentIdentifierStringEnvironmentIdentifierstringEnvironmentIdentifier*string#
The unique identifier of the environment.
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).

nodeNodenodeNodenodeNodeNodeNodeNodeNode#
The tree node.
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 }).

A reference to a Route resource.
routeTypestringroute_typestrrouteTypeStringRouteTypestringRouteType*string#
The route type of the route.
serviceIdentifierstringservice_identifierstrserviceIdentifierStringServiceIdentifierstringServiceIdentifier*string#
The unique identifier of the service.
stackStackstackStackstackStackStackStackStackStack#
The stack in which this element is defined.

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

Tag Manager which manages the tags for this resource.
tagsRawmay be undefinedCfnTag[]tags_rawmay be undefinedtyping.List[CfnTag]tagsRawmay be undefinedList<CfnTag>TagsRawmay be undefinedCfnTag[]TagsRawmay be undefined*[]CfnTag#
The tags assigned to the route.
uriPathRoutemay be undefinedIResolvable | CfnRoute.UriPathRouteInputPropertyuri_path_routemay be undefinedtyping.Union[IResolvable, UriPathRouteInputProperty]uriPathRoutemay be undefinedIResolvableUriPathRoutemay be undefinedIResolvableUriPathRoutemay be undefinedinterface{}#
The configuration for the URI path route type.

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,

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

would add the overrides

json
"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:

arnForRoute(resource: IRouteRef): string@staticmethod def arn_for_route(resource: IRouteRef) -> strpublic static String arnForRoute(IRouteRef resource)public static string ArnForRoute(IRouteRef resource)func ArnForRoute(Resource IRouteRef) *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.
isCfnRoute(x: any): boolean@staticmethod def is_cfn_route(x: Any) -> boolpublic static Boolean isCfnRoute(Object x)public static bool IsCfnRoute(object x)func IsCfnRoute(X interface{}) *boolstatic#
Checks whether the given object is a CfnRoute.
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.