Skip to content

Latest commit

 

History

History
1892 lines (1199 loc) · 89.3 KB

amplifyBranch.java.md

File metadata and controls

1892 lines (1199 loc) · 89.3 KB
Raw

amplifyBranch Submodule

Constructs

AmplifyBranch

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch aws_amplify_branch}.

Initializers 

import com.hashicorp.cdktf.providers.aws.amplify_branch.AmplifyBranch;

AmplifyBranch.Builder.create(Construct scope, java.lang.String id)
//  .connection(SSHProvisionerConnection)
//  .connection(WinrmProvisionerConnection)
//  .count(java.lang.Number)
//  .count(TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner)
//  .provisioners(LocalExecProvisioner)
//  .provisioners(RemoteExecProvisioner>)
    .appId(java.lang.String)
    .branchName(java.lang.String)
//  .backendEnvironmentArn(java.lang.String)
//  .basicAuthCredentials(java.lang.String)
//  .description(java.lang.String)
//  .displayName(java.lang.String)
//  .enableAutoBuild(java.lang.Boolean)
//  .enableAutoBuild(IResolvable)
//  .enableBasicAuth(java.lang.Boolean)
//  .enableBasicAuth(IResolvable)
//  .enableNotification(java.lang.Boolean)
//  .enableNotification(IResolvable)
//  .enablePerformanceMode(java.lang.Boolean)
//  .enablePerformanceMode(IResolvable)
//  .enablePullRequestPreview(java.lang.Boolean)
//  .enablePullRequestPreview(IResolvable)
//  .environmentVariables(java.util.Map<java.lang.String, java.lang.String>)
//  .framework(java.lang.String)
//  .id(java.lang.String)
//  .pullRequestEnvironmentName(java.lang.String)
//  .stage(java.lang.String)
//  .tags(java.util.Map<java.lang.String, java.lang.String>)
//  .tagsAll(java.util.Map<java.lang.String, java.lang.String>)
//  .ttl(java.lang.String)
    .build();
Name Type Description
scope software.constructs.Construct The scope in which to define this construct.
id java.lang.String The scoped construct ID.
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
appId java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#app_id AmplifyBranch#app_id}.
branchName java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#branch_name AmplifyBranch#branch_name}.
backendEnvironmentArn java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#backend_environment_arn AmplifyBranch#backend_environment_arn}.
basicAuthCredentials java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#basic_auth_credentials AmplifyBranch#basic_auth_credentials}.
description java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#description AmplifyBranch#description}.
displayName java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#display_name AmplifyBranch#display_name}.
enableAutoBuild java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#enable_auto_build AmplifyBranch#enable_auto_build}.
enableBasicAuth java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#enable_basic_auth AmplifyBranch#enable_basic_auth}.
enableNotification java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#enable_notification AmplifyBranch#enable_notification}.
enablePerformanceMode java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#enable_performance_mode AmplifyBranch#enable_performance_mode}.
enablePullRequestPreview java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#enable_pull_request_preview AmplifyBranch#enable_pull_request_preview}.
environmentVariables java.util.Map<java.lang.String, java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#environment_variables AmplifyBranch#environment_variables}.
framework java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#framework AmplifyBranch#framework}.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#id AmplifyBranch#id}.
pullRequestEnvironmentName java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#pull_request_environment_name AmplifyBranch#pull_request_environment_name}.
stage java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#stage AmplifyBranch#stage}.
tags java.util.Map<java.lang.String, java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#tags AmplifyBranch#tags}.
tagsAll java.util.Map<java.lang.String, java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#tags_all AmplifyBranch#tags_all}.
ttl java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#ttl AmplifyBranch#ttl}.
scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: java.lang.String

The scoped construct ID.

Must be unique amongst siblings in the same scope

connectionOptional
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional
  • Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>
forEachOptional
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
appIdRequired
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#app_id AmplifyBranch#app_id}.

branchNameRequired
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#branch_name AmplifyBranch#branch_name}.

backendEnvironmentArnOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#backend_environment_arn AmplifyBranch#backend_environment_arn}.

basicAuthCredentialsOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#basic_auth_credentials AmplifyBranch#basic_auth_credentials}.

descriptionOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#description AmplifyBranch#description}.

displayNameOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#display_name AmplifyBranch#display_name}.

enableAutoBuildOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#enable_auto_build AmplifyBranch#enable_auto_build}.

enableBasicAuthOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#enable_basic_auth AmplifyBranch#enable_basic_auth}.

enableNotificationOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#enable_notification AmplifyBranch#enable_notification}.

enablePerformanceModeOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#enable_performance_mode AmplifyBranch#enable_performance_mode}.

enablePullRequestPreviewOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#enable_pull_request_preview AmplifyBranch#enable_pull_request_preview}.

environmentVariablesOptional
  • Type: java.util.Map<java.lang.String, java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#environment_variables AmplifyBranch#environment_variables}.

frameworkOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#framework AmplifyBranch#framework}.

idOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#id AmplifyBranch#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

pullRequestEnvironmentNameOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#pull_request_environment_name AmplifyBranch#pull_request_environment_name}.

stageOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#stage AmplifyBranch#stage}.

tagsOptional
  • Type: java.util.Map<java.lang.String, java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#tags AmplifyBranch#tags}.

tagsAllOptional
  • Type: java.util.Map<java.lang.String, java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#tags_all AmplifyBranch#tags_all}.

ttlOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#ttl AmplifyBranch#ttl}.

Methods

Name Description
toString Returns a string representation of this construct.
addOverride No description.
overrideLogicalId Overrides the auto-generated logical ID with a specific ID.
resetOverrideLogicalId Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform No description.
toMetadata No description.
toTerraform Adds this resource to the terraform JSON output.
addMoveTarget Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
hasResourceMove No description.
importFrom No description.
interpolationForAttribute No description.
moveFromId Move the resource corresponding to "id" to this resource.
moveTo Moves this resource to the target resource given by moveTarget.
moveToId Moves this resource to the resource corresponding to "id".
resetBackendEnvironmentArn No description.
resetBasicAuthCredentials No description.
resetDescription No description.
resetDisplayName No description.
resetEnableAutoBuild No description.
resetEnableBasicAuth No description.
resetEnableNotification No description.
resetEnablePerformanceMode No description.
resetEnablePullRequestPreview No description.
resetEnvironmentVariables No description.
resetFramework No description.
resetId No description.
resetPullRequestEnvironmentName No description.
resetStage No description.
resetTags No description.
resetTagsAll No description.
resetTtl No description.
toString 
public java.lang.String toString()

Returns a string representation of this construct.

addOverride 
public void addOverride(java.lang.String path, java.lang.Object value)
pathRequired
  • Type: java.lang.String
valueRequired
  • Type: java.lang.Object
overrideLogicalId 
public void overrideLogicalId(java.lang.String newLogicalId)

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

newLogicalIdRequired
  • Type: java.lang.String

The new logical ID to use for this stack element.

resetOverrideLogicalId 
public void resetOverrideLogicalId()

Resets a previously passed logical Id to use the auto-generated logical id again.

toHclTerraform 
public java.lang.Object toHclTerraform()
toMetadata 
public java.lang.Object toMetadata()
toTerraform 
public java.lang.Object toTerraform()

Adds this resource to the terraform JSON output.

addMoveTarget 
public void addMoveTarget(java.lang.String moveTarget)

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

moveTargetRequired
  • Type: java.lang.String

The string move target that will correspond to this resource.

getAnyMapAttribute 
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanAttribute 
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanMapAttribute 
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getListAttribute 
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberAttribute 
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberListAttribute 
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberMapAttribute 
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringAttribute 
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringMapAttribute 
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
hasResourceMove 
public TerraformResourceMoveByTarget OR TerraformResourceMoveById hasResourceMove()
importFrom 
public void importFrom(java.lang.String id)
public void importFrom(java.lang.String id, TerraformProvider provider)
idRequired
  • Type: java.lang.String
providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider
interpolationForAttribute 
public IResolvable interpolationForAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
moveFromId 
public void moveFromId(java.lang.String id)

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

idRequired
  • Type: java.lang.String

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

moveTo 
public void moveTo(java.lang.String moveTarget)
public void moveTo(java.lang.String moveTarget, java.lang.String OR java.lang.Number index)

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: java.lang.String

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

indexOptional
  • Type: java.lang.String OR java.lang.Number

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

moveToId 
public void moveToId(java.lang.String id)

Moves this resource to the resource corresponding to "id".

idRequired
  • Type: java.lang.String

Full id of resource to move to, e.g. "aws_s3_bucket.example".

resetBackendEnvironmentArn 
public void resetBackendEnvironmentArn()
resetBasicAuthCredentials 
public void resetBasicAuthCredentials()
resetDescription 
public void resetDescription()
resetDisplayName 
public void resetDisplayName()
resetEnableAutoBuild 
public void resetEnableAutoBuild()
resetEnableBasicAuth 
public void resetEnableBasicAuth()
resetEnableNotification 
public void resetEnableNotification()
resetEnablePerformanceMode 
public void resetEnablePerformanceMode()
resetEnablePullRequestPreview 
public void resetEnablePullRequestPreview()
resetEnvironmentVariables 
public void resetEnvironmentVariables()
resetFramework 
public void resetFramework()
resetId 
public void resetId()
resetPullRequestEnvironmentName 
public void resetPullRequestEnvironmentName()
resetStage 
public void resetStage()
resetTags 
public void resetTags()
resetTagsAll 
public void resetTagsAll()
resetTtl 
public void resetTtl()

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformResource No description.
generateConfigForImport Generates CDKTF code for importing a AmplifyBranch resource upon running "cdktf plan ".
isConstruct 
import com.hashicorp.cdktf.providers.aws.amplify_branch.AmplifyBranch;

AmplifyBranch.isConstruct(java.lang.Object x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

xRequired
  • Type: java.lang.Object

Any object.

isTerraformElement 
import com.hashicorp.cdktf.providers.aws.amplify_branch.AmplifyBranch;

AmplifyBranch.isTerraformElement(java.lang.Object x)
xRequired
  • Type: java.lang.Object
isTerraformResource 
import com.hashicorp.cdktf.providers.aws.amplify_branch.AmplifyBranch;

AmplifyBranch.isTerraformResource(java.lang.Object x)
xRequired
  • Type: java.lang.Object
generateConfigForImport 
import com.hashicorp.cdktf.providers.aws.amplify_branch.AmplifyBranch;

AmplifyBranch.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),AmplifyBranch.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider)

Generates CDKTF code for importing a AmplifyBranch resource upon running "cdktf plan ".

scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.

importToIdRequired
  • Type: java.lang.String

The construct id used in the generated config for the AmplifyBranch to import.

importFromIdRequired
  • Type: java.lang.String

The id of the existing AmplifyBranch that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#import import section} in the documentation of this resource for the id to use

providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider

? Optional instance of the provider where the AmplifyBranch to import is found.

Properties

Name Type Description
node software.constructs.Node The tree node.
cdktfStack com.hashicorp.cdktf.TerraformStack No description.
fqn java.lang.String No description.
friendlyUniqueId java.lang.String No description.
terraformMetaArguments java.util.Map<java.lang.String, java.lang.Object> No description.
terraformResourceType java.lang.String No description.
terraformGeneratorMetadata com.hashicorp.cdktf.TerraformProviderGeneratorMetadata No description.
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<java.lang.String> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
arn java.lang.String No description.
associatedResources java.util.List<java.lang.String> No description.
customDomains java.util.List<java.lang.String> No description.
destinationBranch java.lang.String No description.
sourceBranch java.lang.String No description.
appIdInput java.lang.String No description.
backendEnvironmentArnInput java.lang.String No description.
basicAuthCredentialsInput java.lang.String No description.
branchNameInput java.lang.String No description.
descriptionInput java.lang.String No description.
displayNameInput java.lang.String No description.
enableAutoBuildInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
enableBasicAuthInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
enableNotificationInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
enablePerformanceModeInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
enablePullRequestPreviewInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
environmentVariablesInput java.util.Map<java.lang.String, java.lang.String> No description.
frameworkInput java.lang.String No description.
idInput java.lang.String No description.
pullRequestEnvironmentNameInput java.lang.String No description.
stageInput java.lang.String No description.
tagsAllInput java.util.Map<java.lang.String, java.lang.String> No description.
tagsInput java.util.Map<java.lang.String, java.lang.String> No description.
ttlInput java.lang.String No description.
appId java.lang.String No description.
backendEnvironmentArn java.lang.String No description.
basicAuthCredentials java.lang.String No description.
branchName java.lang.String No description.
description java.lang.String No description.
displayName java.lang.String No description.
enableAutoBuild java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
enableBasicAuth java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
enableNotification java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
enablePerformanceMode java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
enablePullRequestPreview java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
environmentVariables java.util.Map<java.lang.String, java.lang.String> No description.
framework java.lang.String No description.
id java.lang.String No description.
pullRequestEnvironmentName java.lang.String No description.
stage java.lang.String No description.
tags java.util.Map<java.lang.String, java.lang.String> No description.
tagsAll java.util.Map<java.lang.String, java.lang.String> No description.
ttl java.lang.String No description.
nodeRequired 
public Node getNode();
  • Type: software.constructs.Node

The tree node.

cdktfStackRequired 
public TerraformStack getCdktfStack();
  • Type: com.hashicorp.cdktf.TerraformStack
fqnRequired 
public java.lang.String getFqn();
  • Type: java.lang.String
friendlyUniqueIdRequired 
public java.lang.String getFriendlyUniqueId();
  • Type: java.lang.String
terraformMetaArgumentsRequired 
public java.util.Map<java.lang.String, java.lang.Object> getTerraformMetaArguments();
  • Type: java.util.Map<java.lang.String, java.lang.Object>
terraformResourceTypeRequired 
public java.lang.String getTerraformResourceType();
  • Type: java.lang.String
terraformGeneratorMetadataOptional 
public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata();
  • Type: com.hashicorp.cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
public java.lang.Object getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional 
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional 
public java.util.List<java.lang.String> getDependsOn();
  • Type: java.util.List<java.lang.String>
forEachOptional 
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional 
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional 
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional 
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
arnRequired 
public java.lang.String getArn();
  • Type: java.lang.String
associatedResourcesRequired 
public java.util.List<java.lang.String> getAssociatedResources();
  • Type: java.util.List<java.lang.String>
customDomainsRequired 
public java.util.List<java.lang.String> getCustomDomains();
  • Type: java.util.List<java.lang.String>
destinationBranchRequired 
public java.lang.String getDestinationBranch();
  • Type: java.lang.String
sourceBranchRequired 
public java.lang.String getSourceBranch();
  • Type: java.lang.String
appIdInputOptional 
public java.lang.String getAppIdInput();
  • Type: java.lang.String
backendEnvironmentArnInputOptional 
public java.lang.String getBackendEnvironmentArnInput();
  • Type: java.lang.String
basicAuthCredentialsInputOptional 
public java.lang.String getBasicAuthCredentialsInput();
  • Type: java.lang.String
branchNameInputOptional 
public java.lang.String getBranchNameInput();
  • Type: java.lang.String
descriptionInputOptional 
public java.lang.String getDescriptionInput();
  • Type: java.lang.String
displayNameInputOptional 
public java.lang.String getDisplayNameInput();
  • Type: java.lang.String
enableAutoBuildInputOptional 
public java.lang.Object getEnableAutoBuildInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
enableBasicAuthInputOptional 
public java.lang.Object getEnableBasicAuthInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
enableNotificationInputOptional 
public java.lang.Object getEnableNotificationInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
enablePerformanceModeInputOptional 
public java.lang.Object getEnablePerformanceModeInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
enablePullRequestPreviewInputOptional 
public java.lang.Object getEnablePullRequestPreviewInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
environmentVariablesInputOptional 
public java.util.Map<java.lang.String, java.lang.String> getEnvironmentVariablesInput();
  • Type: java.util.Map<java.lang.String, java.lang.String>
frameworkInputOptional 
public java.lang.String getFrameworkInput();
  • Type: java.lang.String
idInputOptional 
public java.lang.String getIdInput();
  • Type: java.lang.String
pullRequestEnvironmentNameInputOptional 
public java.lang.String getPullRequestEnvironmentNameInput();
  • Type: java.lang.String
stageInputOptional 
public java.lang.String getStageInput();
  • Type: java.lang.String
tagsAllInputOptional 
public java.util.Map<java.lang.String, java.lang.String> getTagsAllInput();
  • Type: java.util.Map<java.lang.String, java.lang.String>
tagsInputOptional 
public java.util.Map<java.lang.String, java.lang.String> getTagsInput();
  • Type: java.util.Map<java.lang.String, java.lang.String>
ttlInputOptional 
public java.lang.String getTtlInput();
  • Type: java.lang.String
appIdRequired 
public java.lang.String getAppId();
  • Type: java.lang.String
backendEnvironmentArnRequired 
public java.lang.String getBackendEnvironmentArn();
  • Type: java.lang.String
basicAuthCredentialsRequired 
public java.lang.String getBasicAuthCredentials();
  • Type: java.lang.String
branchNameRequired 
public java.lang.String getBranchName();
  • Type: java.lang.String
descriptionRequired 
public java.lang.String getDescription();
  • Type: java.lang.String
displayNameRequired 
public java.lang.String getDisplayName();
  • Type: java.lang.String
enableAutoBuildRequired 
public java.lang.Object getEnableAutoBuild();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
enableBasicAuthRequired 
public java.lang.Object getEnableBasicAuth();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
enableNotificationRequired 
public java.lang.Object getEnableNotification();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
enablePerformanceModeRequired 
public java.lang.Object getEnablePerformanceMode();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
enablePullRequestPreviewRequired 
public java.lang.Object getEnablePullRequestPreview();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
environmentVariablesRequired 
public java.util.Map<java.lang.String, java.lang.String> getEnvironmentVariables();
  • Type: java.util.Map<java.lang.String, java.lang.String>
frameworkRequired 
public java.lang.String getFramework();
  • Type: java.lang.String
idRequired 
public java.lang.String getId();
  • Type: java.lang.String
pullRequestEnvironmentNameRequired 
public java.lang.String getPullRequestEnvironmentName();
  • Type: java.lang.String
stageRequired 
public java.lang.String getStage();
  • Type: java.lang.String
tagsRequired 
public java.util.Map<java.lang.String, java.lang.String> getTags();
  • Type: java.util.Map<java.lang.String, java.lang.String>
tagsAllRequired 
public java.util.Map<java.lang.String, java.lang.String> getTagsAll();
  • Type: java.util.Map<java.lang.String, java.lang.String>
ttlRequired 
public java.lang.String getTtl();
  • Type: java.lang.String

Constants

Name Type Description
tfResourceType java.lang.String No description.
tfResourceTypeRequired 
public java.lang.String getTfResourceType();
  • Type: java.lang.String

Structs

AmplifyBranchConfig

Initializer 

import com.hashicorp.cdktf.providers.aws.amplify_branch.AmplifyBranchConfig;

AmplifyBranchConfig.builder()
//  .connection(SSHProvisionerConnection)
//  .connection(WinrmProvisionerConnection)
//  .count(java.lang.Number)
//  .count(TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner)
//  .provisioners(LocalExecProvisioner)
//  .provisioners(RemoteExecProvisioner>)
    .appId(java.lang.String)
    .branchName(java.lang.String)
//  .backendEnvironmentArn(java.lang.String)
//  .basicAuthCredentials(java.lang.String)
//  .description(java.lang.String)
//  .displayName(java.lang.String)
//  .enableAutoBuild(java.lang.Boolean)
//  .enableAutoBuild(IResolvable)
//  .enableBasicAuth(java.lang.Boolean)
//  .enableBasicAuth(IResolvable)
//  .enableNotification(java.lang.Boolean)
//  .enableNotification(IResolvable)
//  .enablePerformanceMode(java.lang.Boolean)
//  .enablePerformanceMode(IResolvable)
//  .enablePullRequestPreview(java.lang.Boolean)
//  .enablePullRequestPreview(IResolvable)
//  .environmentVariables(java.util.Map<java.lang.String, java.lang.String>)
//  .framework(java.lang.String)
//  .id(java.lang.String)
//  .pullRequestEnvironmentName(java.lang.String)
//  .stage(java.lang.String)
//  .tags(java.util.Map<java.lang.String, java.lang.String>)
//  .tagsAll(java.util.Map<java.lang.String, java.lang.String>)
//  .ttl(java.lang.String)
    .build();

Properties

Name Type Description
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
appId java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#app_id AmplifyBranch#app_id}.
branchName java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#branch_name AmplifyBranch#branch_name}.
backendEnvironmentArn java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#backend_environment_arn AmplifyBranch#backend_environment_arn}.
basicAuthCredentials java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#basic_auth_credentials AmplifyBranch#basic_auth_credentials}.
description java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#description AmplifyBranch#description}.
displayName java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#display_name AmplifyBranch#display_name}.
enableAutoBuild java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#enable_auto_build AmplifyBranch#enable_auto_build}.
enableBasicAuth java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#enable_basic_auth AmplifyBranch#enable_basic_auth}.
enableNotification java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#enable_notification AmplifyBranch#enable_notification}.
enablePerformanceMode java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#enable_performance_mode AmplifyBranch#enable_performance_mode}.
enablePullRequestPreview java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#enable_pull_request_preview AmplifyBranch#enable_pull_request_preview}.
environmentVariables java.util.Map<java.lang.String, java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#environment_variables AmplifyBranch#environment_variables}.
framework java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#framework AmplifyBranch#framework}.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#id AmplifyBranch#id}.
pullRequestEnvironmentName java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#pull_request_environment_name AmplifyBranch#pull_request_environment_name}.
stage java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#stage AmplifyBranch#stage}.
tags java.util.Map<java.lang.String, java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#tags AmplifyBranch#tags}.
tagsAll java.util.Map<java.lang.String, java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#tags_all AmplifyBranch#tags_all}.
ttl java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#ttl AmplifyBranch#ttl}.
connectionOptional 
public java.lang.Object getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional 
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional 
public java.util.List<ITerraformDependable> getDependsOn();
  • Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>
forEachOptional 
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional 
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional 
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional 
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
appIdRequired 
public java.lang.String getAppId();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#app_id AmplifyBranch#app_id}.

branchNameRequired 
public java.lang.String getBranchName();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#branch_name AmplifyBranch#branch_name}.

backendEnvironmentArnOptional 
public java.lang.String getBackendEnvironmentArn();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#backend_environment_arn AmplifyBranch#backend_environment_arn}.

basicAuthCredentialsOptional 
public java.lang.String getBasicAuthCredentials();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#basic_auth_credentials AmplifyBranch#basic_auth_credentials}.

descriptionOptional 
public java.lang.String getDescription();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#description AmplifyBranch#description}.

displayNameOptional 
public java.lang.String getDisplayName();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#display_name AmplifyBranch#display_name}.

enableAutoBuildOptional 
public java.lang.Object getEnableAutoBuild();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#enable_auto_build AmplifyBranch#enable_auto_build}.

enableBasicAuthOptional 
public java.lang.Object getEnableBasicAuth();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#enable_basic_auth AmplifyBranch#enable_basic_auth}.

enableNotificationOptional 
public java.lang.Object getEnableNotification();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#enable_notification AmplifyBranch#enable_notification}.

enablePerformanceModeOptional 
public java.lang.Object getEnablePerformanceMode();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#enable_performance_mode AmplifyBranch#enable_performance_mode}.

enablePullRequestPreviewOptional 
public java.lang.Object getEnablePullRequestPreview();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#enable_pull_request_preview AmplifyBranch#enable_pull_request_preview}.

environmentVariablesOptional 
public java.util.Map<java.lang.String, java.lang.String> getEnvironmentVariables();
  • Type: java.util.Map<java.lang.String, java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#environment_variables AmplifyBranch#environment_variables}.

frameworkOptional 
public java.lang.String getFramework();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#framework AmplifyBranch#framework}.

idOptional 
public java.lang.String getId();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#id AmplifyBranch#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

pullRequestEnvironmentNameOptional 
public java.lang.String getPullRequestEnvironmentName();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#pull_request_environment_name AmplifyBranch#pull_request_environment_name}.

stageOptional 
public java.lang.String getStage();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#stage AmplifyBranch#stage}.

tagsOptional 
public java.util.Map<java.lang.String, java.lang.String> getTags();
  • Type: java.util.Map<java.lang.String, java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#tags AmplifyBranch#tags}.

tagsAllOptional 
public java.util.Map<java.lang.String, java.lang.String> getTagsAll();
  • Type: java.util.Map<java.lang.String, java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#tags_all AmplifyBranch#tags_all}.

ttlOptional 
public java.lang.String getTtl();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/amplify_branch#ttl AmplifyBranch#ttl}.