Class CfnBranch

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

Inheritance
object
CfnElement
CfnRefElement
CfnResource
CfnBranch
Implements
IConstruct
IDependable
Inherited Members
Namespace: Amazon.CDK.AWS.Amplify
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnBranch : CfnResource, IInspectable, IBranchRef, IConstruct, IDependable, IEnvironmentAware, ITaggable
Syntax (vb)
Public Class CfnBranch Inherits CfnResource Implements IInspectable, IBranchRef, IConstruct, IDependable, IEnvironmentAware, ITaggable
Remarks

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

CloudformationResource: AWS::Amplify::Branch

ExampleMetadata: fixture=_generated

Examples
// 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"
                 } }
             });

Synopsis

Constructors

CfnBranch(Construct, string, ICfnBranchProps)

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

Properties

AppId

The unique ID for an Amplify app.
AttrArn

ARN for a branch, part of an Amplify App.
AttrBranchName

Name for a branch, part of an Amplify App.
Backend

The backend for a Branch of an Amplify app.
BasicAuthConfig

The basic authorization credentials for a branch of an Amplify app.
BranchName

The name for the branch.
BranchRef

A reference to a Branch resource.
BuildSpec

The build specification (build spec) for the branch.
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CfnProperties

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

The Amazon Resource Name (ARN) of the IAM role to assign to a branch of an SSR app.
Description

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

Enables auto building for the branch.
EnablePerformanceMode

Enables performance mode for the branch.
EnablePullRequestPreview

Specifies whether Amplify Hosting creates a preview for each pull request that is made for this branch.
EnableSkewProtection

Specifies whether the skew protection feature is enabled for the branch.
EnvironmentVariables

The environment variables for the branch.
Framework

The framework for the branch.
PullRequestEnvironmentName

If pull request previews are enabled for this branch, you can use this property to specify a dedicated backend environment for your previews.
Stage

Describes the current stage for the branch.
Tags

Tag Manager which manages the tags for this resource.
TagsRaw

The tag for the branch.

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<string, object>)

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

Constructors

CfnBranch(Construct, string, ICfnBranchProps)

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

public CfnBranch(Construct scope, string id, ICfnBranchProps props)
Parameters
scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnBranchProps

Resource properties.

Remarks

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

CloudformationResource: AWS::Amplify::Branch

ExampleMetadata: fixture=_generated

Properties

AppId

The unique ID for an Amplify app.

public virtual string AppId { get; set; }
Property Value

string

Remarks

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

CloudformationResource: AWS::Amplify::Branch

ExampleMetadata: fixture=_generated

AttrArn

ARN for a branch, part of an Amplify App.

public virtual string AttrArn { get; }
Property Value

string

Remarks

CloudformationAttribute: Arn

AttrBranchName

Name for a branch, part of an Amplify App.

public virtual string AttrBranchName { get; }
Property Value

string

Remarks

CloudformationAttribute: BranchName

Backend

The backend for a Branch of an Amplify app.

public virtual object? Backend { get; set; }
Property Value

object

Remarks

Use for a backend created from an AWS CloudFormation stack.

Type union: either IResolvable or CfnBranch.IBackendProperty

BasicAuthConfig

The basic authorization credentials for a branch of an Amplify app.

public virtual object? BasicAuthConfig { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or CfnBranch.IBasicAuthConfigProperty

BranchName

The name for the branch.

public virtual string BranchName { get; set; }
Property Value

string

Remarks

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

CloudformationResource: AWS::Amplify::Branch

ExampleMetadata: fixture=_generated

BranchRef

A reference to a Branch resource.

public virtual IBranchReference BranchRef { get; }
Property Value

IBranchReference

Remarks

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

CloudformationResource: AWS::Amplify::Branch

ExampleMetadata: fixture=_generated

BuildSpec

The build specification (build spec) for the branch.

public virtual string? BuildSpec { get; set; }
Property Value

string

Remarks

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

CloudformationResource: AWS::Amplify::Branch

ExampleMetadata: fixture=_generated

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

string

Remarks

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

CloudformationResource: AWS::Amplify::Branch

ExampleMetadata: fixture=_generated

CfnProperties

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

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

IDictionary<string, object>

Overrides
Remarks

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

CloudformationResource: AWS::Amplify::Branch

ExampleMetadata: fixture=_generated

ComputeRoleArn

The Amazon Resource Name (ARN) of the IAM role to assign to a branch of an SSR app.

public virtual string? ComputeRoleArn { get; set; }
Property Value

string

Remarks

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

CloudformationResource: AWS::Amplify::Branch

ExampleMetadata: fixture=_generated

Description

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

public virtual string? Description { get; set; }
Property Value

string

Remarks

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

CloudformationResource: AWS::Amplify::Branch

ExampleMetadata: fixture=_generated

EnableAutoBuild

Enables auto building for the branch.

public virtual object? EnableAutoBuild { get; set; }
Property Value

object

Remarks

Type union: either bool or IResolvable

EnablePerformanceMode

Enables performance mode for the branch.

public virtual object? EnablePerformanceMode { get; set; }
Property Value

object

Remarks

Type union: either bool or IResolvable

EnablePullRequestPreview

Specifies whether Amplify Hosting creates a preview for each pull request that is made for this branch.

public virtual object? EnablePullRequestPreview { get; set; }
Property Value

object

Remarks

Type union: either bool or IResolvable

EnableSkewProtection

Specifies whether the skew protection feature is enabled for the branch.

public virtual object? EnableSkewProtection { get; set; }
Property Value

object

Remarks

Type union: either bool or IResolvable

EnvironmentVariables

The environment variables for the branch.

public virtual object? EnvironmentVariables { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or (either IResolvable or CfnBranch.IEnvironmentVariableProperty)[]

Framework

The framework for the branch.

public virtual string? Framework { get; set; }
Property Value

string

Remarks

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

CloudformationResource: AWS::Amplify::Branch

ExampleMetadata: fixture=_generated

PullRequestEnvironmentName

If pull request previews are enabled for this branch, you can use this property to specify a dedicated backend environment for your previews.

public virtual string? PullRequestEnvironmentName { get; set; }
Property Value

string

Remarks

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

CloudformationResource: AWS::Amplify::Branch

ExampleMetadata: fixture=_generated

Stage

Describes the current stage for the branch.

public virtual string? Stage { get; set; }
Property Value

string

Remarks

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

CloudformationResource: AWS::Amplify::Branch

ExampleMetadata: fixture=_generated

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }
Property Value

TagManager

Remarks

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

CloudformationResource: AWS::Amplify::Branch

ExampleMetadata: fixture=_generated

TagsRaw

The tag for the branch.

public virtual ICfnTag[]? TagsRaw { get; set; }
Property Value

ICfnTag[]

Remarks

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

CloudformationResource: AWS::Amplify::Branch

ExampleMetadata: fixture=_generated

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)
Parameters
inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

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

CloudformationResource: AWS::Amplify::Branch

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

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

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props IDictionary<string, object>
Returns

IDictionary<string, object>

Overrides
Remarks

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

CloudformationResource: AWS::Amplify::Branch

ExampleMetadata: fixture=_generated

Implements

Constructs.IConstruct
Constructs.IDependable