Class CfnBranch
The AWS::Amplify::Branch resource specifies a new branch within an app.
Inherited Members
Namespace: Amazon.CDK.AWS.Amplify
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnBranch : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnBranch
Inherits CfnResource
Implements IInspectable, 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",
Description = "description",
EnableAutoBuild = false,
EnablePerformanceMode = false,
EnablePullRequestPreview = 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(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnBranch(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnBranch(Construct, String, ICfnBranchProps) |
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 | Specifies the backend for a |
BasicAuthConfig | The basic authorization credentials for a branch of an Amplify app. |
BranchName | The name for the branch. |
BuildSpec | The build specification (build spec) for the branch. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
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. |
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>) |
Constructors
CfnBranch(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnBranch(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnBranch(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnBranch(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnBranch(Construct, String, ICfnBranchProps)
public CfnBranch(Construct scope, string id, ICfnBranchProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnBranchProps
Resource properties.
Properties
AppId
The unique ID for an Amplify app.
public virtual string AppId { get; set; }
Property Value
System.String
AttrArn
ARN for a branch, part of an Amplify App.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrBranchName
Name for a branch, part of an Amplify App.
public virtual string AttrBranchName { get; }
Property Value
System.String
Remarks
CloudformationAttribute: BranchName
Backend
Specifies the backend for a Branch
of an Amplify app.
public virtual object Backend { get; set; }
Property Value
System.Object
BasicAuthConfig
The basic authorization credentials for a branch of an Amplify app.
public virtual object BasicAuthConfig { get; set; }
Property Value
System.Object
BranchName
The name for the branch.
public virtual string BranchName { get; set; }
Property Value
System.String
BuildSpec
The build specification (build spec) for the branch.
public virtual string BuildSpec { get; set; }
Property Value
System.String
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Description
The description for the branch that is part of an Amplify app.
public virtual string Description { get; set; }
Property Value
System.String
EnableAutoBuild
Enables auto building for the branch.
public virtual object EnableAutoBuild { get; set; }
Property Value
System.Object
EnablePerformanceMode
Enables performance mode for the branch.
public virtual object EnablePerformanceMode { get; set; }
Property Value
System.Object
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
System.Object
EnvironmentVariables
The environment variables for the branch.
public virtual object EnvironmentVariables { get; set; }
Property Value
System.Object
Framework
The framework for the branch.
public virtual string Framework { get; set; }
Property Value
System.String
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
System.String
Stage
Describes the current stage for the branch.
public virtual string Stage { get; set; }
Property Value
System.String
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
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.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>