software.amazon.awscdk.services.amplify

Class CfnBranch

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.amplify.CfnBranch

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.29.0 (build 41df200)",
           date="2021-06-02T09:54:56.794Z")
 @Stability(value=Stable)
public class CfnBranch
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Amplify::Branch`.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnBranch.BasicAuthConfigProperty
static class	CfnBranch.Builder A fluent builder for CfnBranch.
static interface	CfnBranch.EnvironmentVariableProperty

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnBranch(software.constructs.Construct scope, String id, CfnBranchProps props) Create a new `AWS::Amplify::Branch`.
protected	CfnBranch(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnBranch(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAppId() `AWS::Amplify::Branch.AppId`.
String	getAttrArn()
String	getAttrBranchName()
Object	getBasicAuthConfig() `AWS::Amplify::Branch.BasicAuthConfig`.
String	getBranchName() `AWS::Amplify::Branch.BranchName`.
String	getBuildSpec() `AWS::Amplify::Branch.BuildSpec`.
protected Map<String,Object>	getCfnProperties()
String	getDescription() `AWS::Amplify::Branch.Description`.
Object	getEnableAutoBuild() `AWS::Amplify::Branch.EnableAutoBuild`.
Object	getEnablePerformanceMode() `AWS::Amplify::Branch.EnablePerformanceMode`.
Object	getEnablePullRequestPreview() `AWS::Amplify::Branch.EnablePullRequestPreview`.
Object	getEnvironmentVariables() `AWS::Amplify::Branch.EnvironmentVariables`.
String	getPullRequestEnvironmentName() `AWS::Amplify::Branch.PullRequestEnvironmentName`.
String	getStage() `AWS::Amplify::Branch.Stage`.
TagManager	getTags() `AWS::Amplify::Branch.Tags`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAppId(String value) `AWS::Amplify::Branch.AppId`.
void	setBasicAuthConfig(CfnBranch.BasicAuthConfigProperty value) `AWS::Amplify::Branch.BasicAuthConfig`.
void	setBasicAuthConfig(IResolvable value) `AWS::Amplify::Branch.BasicAuthConfig`.
void	setBranchName(String value) `AWS::Amplify::Branch.BranchName`.
void	setBuildSpec(String value) `AWS::Amplify::Branch.BuildSpec`.
void	setDescription(String value) `AWS::Amplify::Branch.Description`.
void	setEnableAutoBuild(Boolean value) `AWS::Amplify::Branch.EnableAutoBuild`.
void	setEnableAutoBuild(IResolvable value) `AWS::Amplify::Branch.EnableAutoBuild`.
void	setEnablePerformanceMode(Boolean value) `AWS::Amplify::Branch.EnablePerformanceMode`.
void	setEnablePerformanceMode(IResolvable value) `AWS::Amplify::Branch.EnablePerformanceMode`.
void	setEnablePullRequestPreview(Boolean value) `AWS::Amplify::Branch.EnablePullRequestPreview`.
void	setEnablePullRequestPreview(IResolvable value) `AWS::Amplify::Branch.EnablePullRequestPreview`.
void	setEnvironmentVariables(IResolvable value) `AWS::Amplify::Branch.EnvironmentVariables`.
void	setEnvironmentVariables(List<Object> value) `AWS::Amplify::Branch.EnvironmentVariables`.
void	setPullRequestEnvironmentName(String value) `AWS::Amplify::Branch.PullRequestEnvironmentName`.
void	setStage(String value) `AWS::Amplify::Branch.Stage`.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnBranch

protected CfnBranch(software.amazon.jsii.JsiiObjectRef objRef)

CfnBranch

protected CfnBranch(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnBranch

@Stability(value=Stable)
public CfnBranch(@NotNull
                                          software.constructs.Construct scope,
                                          @NotNull
                                          String id,
                                          @NotNull
                                          CfnBranchProps props)

Create a new `AWS::Amplify::Branch`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

getAttrBranchName

@Stability(value=Stable)
 @NotNull
public String getAttrBranchName()

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

`AWS::Amplify::Branch.Tags`.

getAppId

@Stability(value=Stable)
 @NotNull
public String getAppId()

`AWS::Amplify::Branch.AppId`.

setAppId

@Stability(value=Stable)
public void setAppId(@NotNull
                                              String value)

`AWS::Amplify::Branch.AppId`.

getBranchName

@Stability(value=Stable)
 @NotNull
public String getBranchName()

`AWS::Amplify::Branch.BranchName`.

setBranchName

@Stability(value=Stable)
public void setBranchName(@NotNull
                                                   String value)

`AWS::Amplify::Branch.BranchName`.

getBasicAuthConfig

@Stability(value=Stable)
 @Nullable
public Object getBasicAuthConfig()

`AWS::Amplify::Branch.BasicAuthConfig`.

setBasicAuthConfig

@Stability(value=Stable)
public void setBasicAuthConfig(@Nullable
                                                        CfnBranch.BasicAuthConfigProperty value)

`AWS::Amplify::Branch.BasicAuthConfig`.

setBasicAuthConfig

@Stability(value=Stable)
public void setBasicAuthConfig(@Nullable
                                                        IResolvable value)

`AWS::Amplify::Branch.BasicAuthConfig`.

getBuildSpec

@Stability(value=Stable)
 @Nullable
public String getBuildSpec()

`AWS::Amplify::Branch.BuildSpec`.

setBuildSpec

@Stability(value=Stable)
public void setBuildSpec(@Nullable
                                                  String value)

`AWS::Amplify::Branch.BuildSpec`.

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

`AWS::Amplify::Branch.Description`.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

`AWS::Amplify::Branch.Description`.

getEnableAutoBuild

@Stability(value=Stable)
 @Nullable
public Object getEnableAutoBuild()

`AWS::Amplify::Branch.EnableAutoBuild`.

setEnableAutoBuild

@Stability(value=Stable)
public void setEnableAutoBuild(@Nullable
                                                        Boolean value)

`AWS::Amplify::Branch.EnableAutoBuild`.

setEnableAutoBuild

@Stability(value=Stable)
public void setEnableAutoBuild(@Nullable
                                                        IResolvable value)

`AWS::Amplify::Branch.EnableAutoBuild`.

getEnablePerformanceMode

@Stability(value=Stable)
 @Nullable
public Object getEnablePerformanceMode()

`AWS::Amplify::Branch.EnablePerformanceMode`.

setEnablePerformanceMode

@Stability(value=Stable)
public void setEnablePerformanceMode(@Nullable
                                                              Boolean value)

`AWS::Amplify::Branch.EnablePerformanceMode`.

setEnablePerformanceMode

@Stability(value=Stable)
public void setEnablePerformanceMode(@Nullable
                                                              IResolvable value)

`AWS::Amplify::Branch.EnablePerformanceMode`.

getEnablePullRequestPreview

@Stability(value=Stable)
 @Nullable
public Object getEnablePullRequestPreview()

`AWS::Amplify::Branch.EnablePullRequestPreview`.

setEnablePullRequestPreview

@Stability(value=Stable)
public void setEnablePullRequestPreview(@Nullable
                                                                 Boolean value)

`AWS::Amplify::Branch.EnablePullRequestPreview`.

setEnablePullRequestPreview

@Stability(value=Stable)
public void setEnablePullRequestPreview(@Nullable
                                                                 IResolvable value)

`AWS::Amplify::Branch.EnablePullRequestPreview`.

getEnvironmentVariables

@Stability(value=Stable)
 @Nullable
public Object getEnvironmentVariables()

`AWS::Amplify::Branch.EnvironmentVariables`.

setEnvironmentVariables

@Stability(value=Stable)
public void setEnvironmentVariables(@Nullable
                                                             IResolvable value)

`AWS::Amplify::Branch.EnvironmentVariables`.

setEnvironmentVariables

@Stability(value=Stable)
public void setEnvironmentVariables(@Nullable
                                                             List<Object> value)

`AWS::Amplify::Branch.EnvironmentVariables`.

getPullRequestEnvironmentName

@Stability(value=Stable)
 @Nullable
public String getPullRequestEnvironmentName()

`AWS::Amplify::Branch.PullRequestEnvironmentName`.

setPullRequestEnvironmentName

@Stability(value=Stable)
public void setPullRequestEnvironmentName(@Nullable
                                                                   String value)

`AWS::Amplify::Branch.PullRequestEnvironmentName`.

getStage

@Stability(value=Stable)
 @Nullable
public String getStage()

`AWS::Amplify::Branch.Stage`.

setStage

@Stability(value=Stable)
public void setStage(@Nullable
                                              String value)

`AWS::Amplify::Branch.Stage`.