CfnBranch

class aws_cdk.aws_amplify.CfnBranch(scope, id, *, app_id, branch_name, basic_auth_config=None, build_spec=None, description=None, enable_auto_build=None, enable_performance_mode=None, enable_pull_request_preview=None, environment_variables=None, pull_request_environment_name=None, stage=None, tags=None)

Bases: CfnResource

A CloudFormation AWS::Amplify::Branch.

The AWS::Amplify::Branch resource creates a new branch within an app.

CloudformationResource

AWS::Amplify::Branch

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html

ExampleMetadata

fixture=_generated

Example:

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

cfn_branch = amplify.CfnBranch(self, "MyCfnBranch",
    app_id="appId",
    branch_name="branchName",

    # the properties below are optional
    basic_auth_config=amplify.CfnBranch.BasicAuthConfigProperty(
        password="password",
        username="username",

        # the properties below are optional
        enable_basic_auth=False
    ),
    build_spec="buildSpec",
    description="description",
    enable_auto_build=False,
    enable_performance_mode=False,
    enable_pull_request_preview=False,
    environment_variables=[amplify.CfnBranch.EnvironmentVariableProperty(
        name="name",
        value="value"
    )],
    pull_request_environment_name="pullRequestEnvironmentName",
    stage="stage",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Create a new AWS::Amplify::Branch.

Parameters
  • scope (Construct) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

  • app_id (str) – The unique ID for an Amplify app. Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: d[a-z0-9]+

  • branch_name (str) – The name for the branch. Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: (?s).+

  • basic_auth_config (Union[IResolvable, BasicAuthConfigProperty, Dict[str, Any], None]) – 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 .

  • build_spec (Optional[str]) – The build specification (build spec) for the branch. Length Constraints: Minimum length of 1. Maximum length of 25000. Pattern: (?s).+

  • description (Optional[str]) – The description for the branch that is part of an Amplify app. Length Constraints: Maximum length of 1000. Pattern: (?s).*

  • enable_auto_build (Union[bool, IResolvable, None]) – Enables auto building for the branch.

  • enable_performance_mode (Union[bool, IResolvable, None]) – 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.

  • enable_pull_request_preview (Union[bool, IResolvable, None]) – Sets whether the Amplify Console creates a preview for each pull request that is made for this branch. If this property is enabled, the Amplify Console 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, the Amplify Console 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 .

  • environment_variables (Union[IResolvable, Sequence[Union[IResolvable, EnvironmentVariableProperty, Dict[str, Any]]], None]) – The environment variables for the branch.

  • pull_request_environment_name (Optional[str]) – 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, the Amplify Console provides backend support for each preview by automatically provisioning a temporary backend environment. Amplify Console 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 . Length Constraints: Maximum length of 20. Pattern: (?s).*

  • stage (Optional[str]) – Describes the current stage for the branch. Valid Values: PRODUCTION | BETA | DEVELOPMENT | EXPERIMENTAL | PULL_REQUEST

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The tag for the branch.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters

path (str) – The path of the value to delete.

Return type

None

add_depends_on(target)

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.

Parameters

target (CfnResource) –

Return type

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters
  • key (str) –

  • value (Any) –

See

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.

Return type

None

add_override(path, 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:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"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
  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type

None

add_property_deletion_override(property_path)

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

Parameters

property_path (str) – The path to the property.

Return type

None

add_property_override(property_path, value)

Adds an override to a resource property.

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

Parameters
  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

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

Parameters
  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type

None

get_att(attribute_name)

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.

Parameters

attribute_name (str) – The name of the attribute.

Return type

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters

key (str) –

See

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.

Return type

Any

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

Return type

None

override_logical_id(new_logical_id)

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

Parameters

new_logical_id (str) – The new logical ID to use for this stack element.

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Returns

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::Amplify::Branch'
app_id

The unique ID for an Amplify app.

Length Constraints: Minimum length of 1. Maximum length of 20.

Pattern: d[a-z0-9]+

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-appid

Return type

str

attr_arn

ARN for a branch, part of an Amplify App.

CloudformationAttribute

Arn

Return type

str

attr_branch_name

Name for a branch, part of an Amplify App.

CloudformationAttribute

BranchName

Return type

str

basic_auth_config

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 .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-basicauthconfig

Return type

Union[IResolvable, BasicAuthConfigProperty, None]

branch_name

The name for the branch.

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: (?s).+

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-branchname

Return type

str

build_spec

The build specification (build spec) for the branch.

Length Constraints: Minimum length of 1. Maximum length of 25000.

Pattern: (?s).+

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-buildspec

Return type

Optional[str]

cfn_options

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

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

Return type

str

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

Return type

List[str]

description

The description for the branch that is part of an Amplify app.

Length Constraints: Maximum length of 1000.

Pattern: (?s).*

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-description

Return type

Optional[str]

enable_auto_build

Enables auto building for the branch.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-enableautobuild

Return type

Union[bool, IResolvable, None]

enable_performance_mode

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-enableperformancemode

Return type

Union[bool, IResolvable, None]

enable_pull_request_preview

Sets whether the Amplify Console creates a preview for each pull request that is made for this branch.

If this property is enabled, the Amplify Console 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, the Amplify Console 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 .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-enablepullrequestpreview

Return type

Union[bool, IResolvable, None]

environment_variables

The environment variables for the branch.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-environmentvariables

Return type

Union[IResolvable, List[Union[IResolvable, EnvironmentVariableProperty]], None]

logical_id

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

Return type

str

Returns

the logical ID as a stringified token. This value will only get resolved during synthesis.

node

The construct tree node associated with this construct.

Return type

ConstructNode

pull_request_environment_name

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, the Amplify Console provides backend support for each preview by automatically provisioning a temporary backend environment. Amplify Console 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 .

Length Constraints: Maximum length of 20.

Pattern: (?s).*

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-pullrequestenvironmentname

Return type

Optional[str]

ref

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 }).

Return type

str

stack

The stack in which this element is defined.

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

Return type

Stack

stage

Describes the current stage for the branch.

Valid Values: PRODUCTION | BETA | DEVELOPMENT | EXPERIMENTAL | PULL_REQUEST

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-stage

Return type

Optional[str]

tags

The tag for the branch.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-tags

Return type

TagManager

Static Methods

classmethod is_cfn_element(x)

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.

Parameters

x (Any) –

Return type

bool

Returns

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

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters

construct (IConstruct) –

Return type

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

BasicAuthConfigProperty

class CfnBranch.BasicAuthConfigProperty(*, password, username, enable_basic_auth=None)

Bases: object

Use the BasicAuthConfig property type to set password protection for a specific branch.

Parameters
  • password (str) – The password for basic authorization. Length Constraints: Minimum length of 1. Maximum length of 255.

  • username (str) – The user name for basic authorization. Length Constraints: Minimum length of 1. Maximum length of 255.

  • enable_basic_auth (Union[bool, IResolvable, None]) – Enables basic authorization for the branch.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-branch-basicauthconfig.html

ExampleMetadata

fixture=_generated

Example:

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

basic_auth_config_property = amplify.CfnBranch.BasicAuthConfigProperty(
    password="password",
    username="username",

    # the properties below are optional
    enable_basic_auth=False
)

Attributes

enable_basic_auth

Enables basic authorization for the branch.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-branch-basicauthconfig.html#cfn-amplify-branch-basicauthconfig-enablebasicauth

Return type

Union[bool, IResolvable, None]

password

The password for basic authorization.

Length Constraints: Minimum length of 1. Maximum length of 255.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-branch-basicauthconfig.html#cfn-amplify-branch-basicauthconfig-password

Return type

str

username

The user name for basic authorization.

Length Constraints: Minimum length of 1. Maximum length of 255.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-branch-basicauthconfig.html#cfn-amplify-branch-basicauthconfig-username

Return type

str

EnvironmentVariableProperty

class CfnBranch.EnvironmentVariableProperty(*, name, value)

Bases: object

The EnvironmentVariable property type sets environment variables for a specific branch.

Environment variables are key-value pairs that are available at build time.

Parameters
  • name (str) – The environment variable name. Length Constraints: Maximum length of 255. Pattern: (?s).*

  • value (str) – The environment variable value. Length Constraints: Maximum length of 5500. Pattern: (?s).*

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-branch-environmentvariable.html

ExampleMetadata

fixture=_generated

Example:

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

environment_variable_property = amplify.CfnBranch.EnvironmentVariableProperty(
    name="name",
    value="value"
)

Attributes

name

The environment variable name.

Length Constraints: Maximum length of 255.

Pattern: (?s).*

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-branch-environmentvariable.html#cfn-amplify-branch-environmentvariable-name

Return type

str

value

The environment variable value.

Length Constraints: Maximum length of 5500.

Pattern: (?s).*

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-branch-environmentvariable.html#cfn-amplify-branch-environmentvariable-value

Return type

str