CfnBranch L1 construct
The AWS::Amplify::Branch resource specifies a new branch within an app.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_amplify as amplify } from 'aws-cdk-lib';
const cfnBranch = new amplify.CfnBranch(this, 'MyCfnBranch', {
appId: 'appId',
branchName: 'branchName',
// the properties below are optional
backend: {
stackArn: 'stackArn',
},
basicAuthConfig: {
password: 'password',
username: 'username',
// the properties below are optional
enableBasicAuth: false,
},
buildSpec: 'buildSpec',
computeRoleArn: 'computeRoleArn',
description: 'description',
enableAutoBuild: false,
enablePerformanceMode: false,
enablePullRequestPreview: false,
enableSkewProtection: false,
environmentVariables: [{
name: 'name',
value: 'value',
}],
framework: 'framework',
pullRequestEnvironmentName: 'pullRequestEnvironmentName',
stage: 'stage',
tags: [{
key: 'key',
value: 'value',
}],
});
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_amplify as amplify
cfn_branch = amplify.CfnBranch(self, "MyCfnBranch",
app_id="appId",
branch_name="branchName",
# the properties below are optional
backend=amplify.CfnBranch.BackendProperty(
stack_arn="stackArn"
),
basic_auth_config=amplify.CfnBranch.BasicAuthConfigProperty(
password="password",
username="username",
# the properties below are optional
enable_basic_auth=False
),
build_spec="buildSpec",
compute_role_arn="computeRoleArn",
description="description",
enable_auto_build=False,
enable_performance_mode=False,
enable_pull_request_preview=False,
enable_skew_protection=False,
environment_variables=[amplify.CfnBranch.EnvironmentVariableProperty(
name="name",
value="value"
)],
framework="framework",
pull_request_environment_name="pullRequestEnvironmentName",
stage="stage",
tags=[CfnTag(
key="key",
value="value"
)]
)
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.amplify.*;
CfnBranch cfnBranch = CfnBranch.Builder.create(this, "MyCfnBranch")
.appId("appId")
.branchName("branchName")
// the properties below are optional
.backend(BackendProperty.builder()
.stackArn("stackArn")
.build())
.basicAuthConfig(BasicAuthConfigProperty.builder()
.password("password")
.username("username")
// the properties below are optional
.enableBasicAuth(false)
.build())
.buildSpec("buildSpec")
.computeRoleArn("computeRoleArn")
.description("description")
.enableAutoBuild(false)
.enablePerformanceMode(false)
.enablePullRequestPreview(false)
.enableSkewProtection(false)
.environmentVariables(List.of(EnvironmentVariableProperty.builder()
.name("name")
.value("value")
.build()))
.framework("framework")
.pullRequestEnvironmentName("pullRequestEnvironmentName")
.stage("stage")
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.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.Amplify;
var cfnBranch = new CfnBranch(this, "MyCfnBranch", new CfnBranchProps {
AppId = "appId",
BranchName = "branchName",
// the properties below are optional
Backend = new BackendProperty {
StackArn = "stackArn"
},
BasicAuthConfig = new BasicAuthConfigProperty {
Password = "password",
Username = "username",
// the properties below are optional
EnableBasicAuth = false
},
BuildSpec = "buildSpec",
ComputeRoleArn = "computeRoleArn",
Description = "description",
EnableAutoBuild = false,
EnablePerformanceMode = false,
EnablePullRequestPreview = false,
EnableSkewProtection = false,
EnvironmentVariables = new [] { new EnvironmentVariableProperty {
Name = "name",
Value = "value"
} },
Framework = "framework",
PullRequestEnvironmentName = "pullRequestEnvironmentName",
Stage = "stage",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
// 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"
cfnBranch := awscdk.Aws_amplify.NewCfnBranch(this, jsii.String("MyCfnBranch"), &CfnBranchProps{
AppId: jsii.String("appId"),
BranchName: jsii.String("branchName"),
// the properties below are optional
Backend: &BackendProperty{
StackArn: jsii.String("stackArn"),
},
BasicAuthConfig: &BasicAuthConfigProperty{
Password: jsii.String("password"),
Username: jsii.String("username"),
// the properties below are optional
EnableBasicAuth: jsii.Boolean(false),
},
BuildSpec: jsii.String("buildSpec"),
ComputeRoleArn: jsii.String("computeRoleArn"),
Description: jsii.String("description"),
EnableAutoBuild: jsii.Boolean(false),
EnablePerformanceMode: jsii.Boolean(false),
EnablePullRequestPreview: jsii.Boolean(false),
EnableSkewProtection: jsii.Boolean(false),
EnvironmentVariables: []interface{}{
&EnvironmentVariableProperty{
Name: jsii.String("name"),
Value: jsii.String("value"),
},
},
Framework: jsii.String("framework"),
PullRequestEnvironmentName: jsii.String("pullRequestEnvironmentName"),
Stage: jsii.String("stage"),
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
Initializer
new CfnBranch(scope: Construct, id: string, props: CfnBranchProps)
CfnBranch(scope: Construct, id: str, props: CfnBranchProps)
new CfnBranch(Construct scope, String id, CfnBranchProps props)
new CfnBranch(Construct scope, string id, CfnBranchProps props)
NewCfnBranch(Scope Construct, Id *string, Props CfnBranchProps)
Construct Props
backendoptionalIResolvable | CfnBranch.BackendPropertybackendoptionaltyping.Union[IResolvable, BackendProperty]backendoptionalIResolvableBackendoptionalIResolvableBackendoptionalinterface{}#This field is available to Amplify Gen 2 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
basicAuthConfigoptionalIResolvable | CfnBranch.BasicAuthConfigPropertybasic_auth_configoptionaltyping.Union[IResolvable, BasicAuthConfigProperty]basicAuthConfigoptionalIResolvableBasicAuthConfigoptionalIResolvableBasicAuthConfigoptionalinterface{}#You must base64-encode the authorization credentials and provide them in the format user:password .
buildSpecoptionalstringbuild_specoptionalstrbuildSpecoptionalStringBuildSpecoptionalstringBuildSpecoptional*string#computeRoleArnoptionalstringcompute_role_arnoptionalstrcomputeRoleArnoptionalStringComputeRoleArnoptionalstringComputeRoleArnoptional*string#notes
The SSR Compute role allows the Amplify Hosting compute service to securely access specific AWS resources based on the role's permissions. For more information about the SSR Compute role, see Adding an SSR Compute role in the Amplify User Guide .
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#enableAutoBuildoptionalboolean | IResolvableenable_auto_buildoptionaltyping.Union[bool, IResolvable]enableAutoBuildoptionalBooleanEnableAutoBuildoptionalboolEnableAutoBuildoptionalinterface{}#enablePerformanceModeoptionalboolean | IResolvableenable_performance_modeoptionaltyping.Union[bool, IResolvable]enablePerformanceModeoptionalBooleanEnablePerformanceModeoptionalboolEnablePerformanceModeoptionalinterface{}#Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.
enablePullRequestPreviewoptionalboolean | IResolvableenable_pull_request_previewoptionaltyping.Union[bool, IResolvable]enablePullRequestPreviewoptionalBooleanEnablePullRequestPreviewoptionalboolEnablePullRequestPreviewoptionalinterface{}#notes
If this property is enabled, Amplify deploys your app to a unique preview URL after each pull request is opened. Development and QA teams can use this preview to test the pull request before it's merged into a production or integration branch.
To provide backend support for your preview, Amplify automatically provisions a temporary backend environment that it deletes when the pull request is closed. If you want to specify a dedicated backend environment for your previews, use the PullRequestEnvironmentName property.
For more information, see Web Previews in the AWS Amplify Hosting User Guide .
enableSkewProtectionoptionalboolean | IResolvableenable_skew_protectionoptionaltyping.Union[bool, IResolvable]enableSkewProtectionoptionalBooleanEnableSkewProtectionoptionalboolEnableSkewProtectionoptionalinterface{}#notes
Deployment skew protection is available to Amplify applications to eliminate version skew issues between client and servers in web applications. When you apply skew protection to a branch, you can ensure that your clients always interact with the correct version of server-side assets, regardless of when a deployment occurs. For more information about skew protection, see Skew protection for Amplify deployments in the Amplify User Guide .
environmentVariablesoptionalIResolvable | IResolvable | CfnBranch.EnvironmentVariableProperty[]environment_variablesoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, EnvironmentVariableProperty]]]environmentVariablesoptionalIResolvableEnvironmentVariablesoptionalIResolvableEnvironmentVariablesoptionalinterface{}#frameworkoptionalstringframeworkoptionalstrframeworkoptionalStringFrameworkoptionalstringFrameworkoptional*string#pullRequestEnvironmentNameoptionalstringpull_request_environment_nameoptionalstrpullRequestEnvironmentNameoptionalStringPullRequestEnvironmentNameoptionalstringPullRequestEnvironmentNameoptional*string#notes
For example, you could specify an environment named prod , test , or dev that you initialized with the Amplify CLI and mapped to this branch.
To enable pull request previews, set the EnablePullRequestPreview property to true .
If you don't specify an environment, Amplify Hosting provides backend support for each preview by automatically provisioning a temporary backend environment. Amplify Hosting deletes this environment when the pull request is closed.
For more information about creating backend environments, see Feature Branch Deployments and Team Workflows in the AWS Amplify Hosting User Guide .
Properties
attrBranchNamestringattr_branch_namestrattrBranchNameStringAttrBranchNamestringAttrBranchName*stringrequired#backendmay be undefinedIResolvable | CfnBranch.BackendPropertybackendmay be undefinedtyping.Union[IResolvable, BackendProperty]backendmay be undefinedIResolvableBackendmay be undefinedIResolvableBackendmay be undefinedinterface{}#Use for a backend created from an CloudFormation stack.
basicAuthConfigmay be undefinedIResolvable | CfnBranch.BasicAuthConfigPropertybasic_auth_configmay be undefinedtyping.Union[IResolvable, BasicAuthConfigProperty]basicAuthConfigmay be undefinedIResolvableBasicAuthConfigmay be undefinedIResolvableBasicAuthConfigmay be undefinedinterface{}#branchRefBranchReferencebranch_refBranchReferencebranchRefBranchReferenceBranchRefBranchReferenceBranchRefBranchReferencerequired#buildSpecmay be undefinedstringbuild_specmay be undefinedstrbuildSpecmay be undefinedStringBuildSpecmay be undefinedstringBuildSpecmay be undefined*string#CFN_RESOURCE_TYPE_NAMEstringcfn_resource_type_namestrCFN_RESOURCE_TYPE_NAMEStringCFN_RESOURCE_TYPE_NAMEstringCFN_RESOURCE_TYPE_NAME*stringrequiredstatic#cfnOptionsICfnResourceOptionscfn_optionsICfnResourceOptionscfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptionsrequired#cfnResourceTypestringcfn_resource_typestrcfnResourceTypeStringCfnResourceTypestringCfnResourceType*stringrequired#computeRoleArnmay be undefinedstringcompute_role_arnmay be undefinedstrcomputeRoleArnmay be undefinedStringComputeRoleArnmay be undefinedstringComputeRoleArnmay be undefined*string#creationStackstring[]creation_stacktyping.List[str]creationStackList<String>CreationStackstring[]CreationStack*[]*stringrequired#descriptionmay be undefinedstringdescriptionmay be undefinedstrdescriptionmay be undefinedStringDescriptionmay be undefinedstringDescriptionmay be undefined*string#enableAutoBuildmay be undefinedboolean | IResolvableenable_auto_buildmay be undefinedtyping.Union[bool, IResolvable]enableAutoBuildmay be undefinedBooleanEnableAutoBuildmay be undefinedboolEnableAutoBuildmay be undefinedinterface{}#enablePerformanceModemay be undefinedboolean | IResolvableenable_performance_modemay be undefinedtyping.Union[bool, IResolvable]enablePerformanceModemay be undefinedBooleanEnablePerformanceModemay be undefinedboolEnablePerformanceModemay be undefinedinterface{}#enablePullRequestPreviewmay be undefinedboolean | IResolvableenable_pull_request_previewmay be undefinedtyping.Union[bool, IResolvable]enablePullRequestPreviewmay be undefinedBooleanEnablePullRequestPreviewmay be undefinedboolEnablePullRequestPreviewmay be undefinedinterface{}#enableSkewProtectionmay be undefinedboolean | IResolvableenable_skew_protectionmay be undefinedtyping.Union[bool, IResolvable]enableSkewProtectionmay be undefinedBooleanEnableSkewProtectionmay be undefinedboolEnableSkewProtectionmay be undefinedinterface{}#environmentVariablesmay be undefinedIResolvable | IResolvable | CfnBranch.EnvironmentVariableProperty[]environment_variablesmay be undefinedtyping.Union[IResolvable, typing.List[typing.Union[IResolvable, EnvironmentVariableProperty]]]environmentVariablesmay be undefinedIResolvableEnvironmentVariablesmay be undefinedIResolvableEnvironmentVariablesmay be undefinedinterface{}#frameworkmay be undefinedstringframeworkmay be undefinedstrframeworkmay be undefinedStringFrameworkmay be undefinedstringFrameworkmay be undefined*string#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).
pullRequestEnvironmentNamemay be undefinedstringpull_request_environment_namemay be undefinedstrpullRequestEnvironmentNamemay be undefinedStringPullRequestEnvironmentNamemay be undefinedstringPullRequestEnvironmentNamemay be undefined*string#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 }).
CfnElements must be defined within a stack scope (directly or indirectly).
stagemay be undefinedstringstagemay be undefinedstrstagemay be undefinedStringStagemay be undefinedstringStagemay be undefined*string#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)#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#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#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{})#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{})#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)#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{})#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)#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)#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)#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:
arnForBranch(resource: IBranchRef): string@staticmethod def arn_for_branch(resource: IBranchRef) -> strpublic static String arnForBranch(IBranchRef resource)public static string ArnForBranch(IBranchRef resource)func ArnForBranch(Resource IBranchRef) *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#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{}#inspect(inspector: TreeInspector): voiddef inspect(self, inspector: TreeInspector) -> Nonepublic void inspect(TreeInspector inspector)public void Inspect(TreeInspector inspector)func Inspect(Inspector TreeInspector)#1 parameter
Parameters
inspectorinspectorinspectorinspectorInspector— tree inspector to collect and process attributes.
isCfnBranch(x: any): boolean@staticmethod def is_cfn_branch(x: Any) -> boolpublic static Boolean isCfnBranch(Object x)public static bool IsCfnBranch(object x)func IsCfnBranch(X interface{}) *boolstatic#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#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#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#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{}#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)#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#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)#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)#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
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#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.