class CfnBranch (construct)
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Amplify.CfnBranch |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsamplify#CfnBranch |
![]() | software.amazon.awscdk.services.amplify.CfnBranch |
![]() | aws_cdk.aws_amplify.CfnBranch |
![]() | aws-cdk-lib » aws_amplify » CfnBranch |
Implements
IConstruct
, IDependable
, IInspectable
, ITaggable
The AWS::Amplify::Branch resource specifies a new branch within an app.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html
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',
description: 'description',
enableAutoBuild: false,
enablePerformanceMode: false,
enablePullRequestPreview: false,
environmentVariables: [{
name: 'name',
value: 'value',
}],
framework: 'framework',
pullRequestEnvironmentName: 'pullRequestEnvironmentName',
stage: 'stage',
tags: [{
key: 'key',
value: 'value',
}],
});
Initializer
new CfnBranch(scope: Construct, id: string, props: CfnBranchProps)
Parameters
- scope
Construct
— Scope in which this resource is defined. - id
string
— Construct identifier for this resource (unique in its scope). - props
Cfn
— Resource properties.Branch Props
Construct Props
Name | Type | Description |
---|---|---|
app | string | The unique ID for an Amplify app. |
branch | string | The name for the branch. |
backend? | IResolvable | Backend | The backend for a Branch of an Amplify app. Use for a backend created from an AWS CloudFormation stack. |
basic | IResolvable | Basic | The basic authorization credentials for a branch of an Amplify app. |
build | string | The build specification (build spec) for the branch. |
description? | string | The description for the branch that is part of an Amplify app. |
enable | boolean | IResolvable | Enables auto building for the branch. |
enable | boolean | IResolvable | Enables performance mode for the branch. |
enable | boolean | IResolvable | Specifies whether Amplify Hosting creates a preview for each pull request that is made for this branch. |
environment | IResolvable | IResolvable | Environment [] | The environment variables for the branch. |
framework? | string | The framework for the branch. |
pull | string | If pull request previews are enabled for this branch, you can use this property to specify a dedicated backend environment for your previews. |
stage? | string | Describes the current stage for the branch. |
tags? | Cfn [] | The tag for the branch. |
appId
Type:
string
The unique ID for an Amplify app.
branchName
Type:
string
The name for the branch.
backend?
Type:
IResolvable
|
Backend
(optional)
The backend for a Branch
of an Amplify app. Use for a backend created from an AWS CloudFormation stack.
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.
basicAuthConfig?
Type:
IResolvable
|
Basic
(optional)
The basic authorization credentials for a branch of an Amplify app.
You must base64-encode the authorization credentials and provide them in the format user:password
.
buildSpec?
Type:
string
(optional)
The build specification (build spec) for the branch.
description?
Type:
string
(optional)
The description for the branch that is part of an Amplify app.
enableAutoBuild?
Type:
boolean |
IResolvable
(optional)
Enables auto building for the branch.
enablePerformanceMode?
Type:
boolean |
IResolvable
(optional)
Enables performance mode for the branch.
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.
enablePullRequestPreview?
Type:
boolean |
IResolvable
(optional)
Specifies whether Amplify Hosting creates a preview for each pull request that is made for this branch.
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 .
environmentVariables?
Type:
IResolvable
|
IResolvable
|
Environment
[]
(optional)
The environment variables for the branch.
framework?
Type:
string
(optional)
The framework for the branch.
pullRequestEnvironmentName?
Type:
string
(optional)
If pull request previews are enabled for this branch, you can use this property to specify a dedicated backend environment for your previews.
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 .
stage?
Type:
string
(optional)
Describes the current stage for the branch.
tags?
Type:
Cfn
[]
(optional)
The tag for the branch.
Properties
Name | Type | Description |
---|---|---|
app | string | The unique ID for an Amplify app. |
attr | string | ARN for a branch, part of an Amplify App. |
attr | string | Name for a branch, part of an Amplify App. |
branch | string | The name for the branch. |
cfn | ICfn | Options for this resource, such as condition, update policy etc. |
cfn | { [string]: any } | |
cfn | string | AWS resource type. |
creation | string[] | |
logical | string | The logical ID for this CloudFormation stack element. |
node | Node | The tree node. |
ref | string | Return a string that will be resolved to a CloudFormation { Ref } for this element. |
stack | Stack | The stack in which this element is defined. |
tags | Tag | Tag Manager which manages the tags for this resource. |
backend? | IResolvable | Backend | The backend for a Branch of an Amplify app. |
basic | IResolvable | Basic | The basic authorization credentials for a branch of an Amplify app. |
build | string | The build specification (build spec) for the branch. |
description? | string | The description for the branch that is part of an Amplify app. |
enable | boolean | IResolvable | Enables auto building for the branch. |
enable | boolean | IResolvable | Enables performance mode for the branch. |
enable | boolean | IResolvable | Specifies whether Amplify Hosting creates a preview for each pull request that is made for this branch. |
environment | IResolvable | IResolvable | Environment [] | The environment variables for the branch. |
framework? | string | The framework for the branch. |
pull | string | If pull request previews are enabled for this branch, you can use this property to specify a dedicated backend environment for your previews. |
stage? | string | Describes the current stage for the branch. |
tags | Cfn [] | The tag for the branch. |
static CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. |
appId
Type:
string
The unique ID for an Amplify app.
attrArn
Type:
string
ARN for a branch, part of an Amplify App.
attrBranchName
Type:
string
Name for a branch, part of an Amplify App.
branchName
Type:
string
The name for the branch.
cfnOptions
Type:
ICfn
Options for this resource, such as condition, update policy etc.
cfnProperties
Type:
{ [string]: any }
cfnResourceType
Type:
string
AWS resource type.
creationStack
Type:
string[]
logicalId
Type:
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)
.
node
Type:
Node
The tree node.
ref
Type:
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 })
.
stack
Type:
Stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
tags
Type:
Tag
Tag Manager which manages the tags for this resource.
backend?
Type:
IResolvable
|
Backend
(optional)
The backend for a Branch
of an Amplify app.
Use for a backend created from an AWS CloudFormation stack.
basicAuthConfig?
Type:
IResolvable
|
Basic
(optional)
The basic authorization credentials for a branch of an Amplify app.
buildSpec?
Type:
string
(optional)
The build specification (build spec) for the branch.
description?
Type:
string
(optional)
The description for the branch that is part of an Amplify app.
enableAutoBuild?
Type:
boolean |
IResolvable
(optional)
Enables auto building for the branch.
enablePerformanceMode?
Type:
boolean |
IResolvable
(optional)
Enables performance mode for the branch.
enablePullRequestPreview?
Type:
boolean |
IResolvable
(optional)
Specifies whether Amplify Hosting creates a preview for each pull request that is made for this branch.
environmentVariables?
Type:
IResolvable
|
IResolvable
|
Environment
[]
(optional)
The environment variables for the branch.
framework?
Type:
string
(optional)
The framework for the branch.
pullRequestEnvironmentName?
Type:
string
(optional)
If pull request previews are enabled for this branch, you can use this property to specify a dedicated backend environment for your previews.
stage?
Type:
string
(optional)
Describes the current stage for the branch.
tagsRaw?
Type:
Cfn
[]
(optional)
The tag for the branch.
static CFN_RESOURCE_TYPE_NAME
Type:
string
The CloudFormation resource type name for this resource class.
Methods
Name | Description |
---|---|
add | Syntactic sugar for addOverride(path, undefined) . |
add | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
add | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
add | Add a value to the CloudFormation Resource Metadata. |
add | Adds an override to the synthesized CloudFormation resource. |
add | Adds an override that deletes the value of a property from the resource definition. |
add | Adds an override to a resource property. |
apply | Sets the deletion policy of the resource based on the removal policy specified. |
get | Returns a token for an runtime attribute of this resource. |
get | Retrieve a value value from the CloudFormation Resource Metadata. |
inspect(inspector) | Examines the CloudFormation resource and discloses attributes. |
obtain | Retrieves an array of resources this resource depends on. |
obtain | Get a shallow copy of dependencies between this resource and other resources in the same stack. |
override | Overrides the auto-generated logical ID with a specific ID. |
remove | Indicates that this resource no longer depends on another resource. |
replace | Replaces one dependency with another. |
to | Returns a string representation of this construct. |
protected render |
addDeletionOverride(path)
public addDeletionOverride(path: string): void
Parameters
- path
string
— The path of the value to delete.
Syntactic sugar for addOverride(path, undefined)
.
addDependency(target)
public addDependency(target: CfnResource): void
Parameters
- target
Cfn
Resource
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
addDependsOn(target)
public addDependsOn(target: CfnResource): void
⚠️ Deprecated: use addDependency
Parameters
- target
Cfn
Resource
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)
public addMetadata(key: string, value: any): void
Parameters
- key
string
- value
any
Add a value to the CloudFormation Resource Metadata.
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)
addOverride(path, value)
public addOverride(path: string, value: any): void
Parameters
- path
string
— - The path of the property, you can use dot notation to override values in complex types. - value
any
— - The value.
Adds an override to the synthesized CloudFormation resource.
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.
addPropertyDeletionOverride(propertyPath)
public addPropertyDeletionOverride(propertyPath: string): void
Parameters
- propertyPath
string
— The path to the property.
Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)
public addPropertyOverride(propertyPath: string, value: any): void
Parameters
- propertyPath
string
— The path of the property. - value
any
— The value.
Adds an override to a resource property.
Syntactic sugar for addOverride("Properties.<...>", value)
.
applyRemovalPolicy(policy?, options?)
public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void
Parameters
- policy
Removal
Policy - options
Removal
Policy Options
Sets the deletion policy of the resource based on the removal policy specified.
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:
getAtt(attributeName, typeHint?)
public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference
Parameters
- attributeName
string
— The name of the attribute. - typeHint
Resolution
Type Hint
Returns
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.
getMetadata(key)
public getMetadata(key: string): any
Parameters
- key
string
Returns
any
Retrieve a value value from the CloudFormation Resource Metadata.
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)
inspect(inspector)
public inspect(inspector: TreeInspector): void
Parameters
- inspector
Tree
— tree inspector to collect and process attributes.Inspector
Examines the CloudFormation resource and discloses attributes.
obtainDependencies()
public obtainDependencies(): Stack | CfnResource[]
Returns
Stack
|
Cfn
Resource []
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
obtainResourceDependencies()
public obtainResourceDependencies(): CfnResource[]
Returns
Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)
public overrideLogicalId(newLogicalId: string): void
Parameters
- newLogicalId
string
— The new logical ID to use for this stack element.
Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)
public removeDependency(target: CfnResource): void
Parameters
- target
Cfn
Resource
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, newTarget)
public replaceDependency(target: CfnResource, newTarget: CfnResource): void
Parameters
- target
Cfn
— The dependency to replace.Resource - newTarget
Cfn
— The new dependency to add.Resource
Replaces one dependency with another.
toString()
public toString(): string
Returns
string
Returns a string representation of this construct.
protected renderProperties(props)
protected renderProperties(props: { [string]: any }): { [string]: any }
Parameters
- props
{ [string]: any }
Returns
{ [string]: any }