Skip to content

Latest commit

 

History

History
1588 lines (992 loc) · 64.6 KB

amplifyBranch.md

File metadata and controls

1588 lines (992 loc) · 64.6 KB

amplifyBranch Submodule

Constructs

AmplifyBranch

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

Initializers 

import { amplifyBranch } from '@cdktf/aws-cdk'

new amplifyBranch.AmplifyBranch(scope: Construct, id: string, config: AmplifyBranchConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config AmplifyBranchConfig No description.
scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

configRequired

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 toString(): string

Returns a string representation of this construct.

addOverride 
public addOverride(path: string, value: any): void
pathRequired
  • Type: string
valueRequired
  • Type: any
overrideLogicalId 
public overrideLogicalId(newLogicalId: string): void

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

newLogicalIdRequired
  • Type: string

The new logical ID to use for this stack element.

resetOverrideLogicalId 
public resetOverrideLogicalId(): void

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

toHclTerraform 
public toHclTerraform(): any
toMetadata 
public toMetadata(): any
toTerraform 
public toTerraform(): any

Adds this resource to the terraform JSON output.

addMoveTarget 
public addMoveTarget(moveTarget: string): void

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: string

The string move target that will correspond to this resource.

getAnyMapAttribute 
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string
getBooleanAttribute 
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
getBooleanMapAttribute 
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string
getListAttribute 
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string
getNumberAttribute 
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string
getNumberListAttribute 
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string
getNumberMapAttribute 
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string
getStringAttribute 
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string
getStringMapAttribute 
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string
hasResourceMove 
public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById
importFrom 
public importFrom(id: string, provider?: TerraformProvider): void
idRequired
  • Type: string
providerOptional
  • Type: cdktf.TerraformProvider
interpolationForAttribute 
public interpolationForAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
moveFromId 
public moveFromId(id: string): void

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: string

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

moveTo 
public moveTo(moveTarget: string, index?: string | number): void

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: string

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

indexOptional
  • Type: string | number

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

moveToId 
public moveToId(id: string): void

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

idRequired
  • Type: string

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

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

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 { amplifyBranch } from '@cdktf/aws-cdk'

amplifyBranch.AmplifyBranch.isConstruct(x: any)

Checks if x is a construct.

xRequired
  • Type: any

Any object.

isTerraformElement 
import { amplifyBranch } from '@cdktf/aws-cdk'

amplifyBranch.AmplifyBranch.isTerraformElement(x: any)
xRequired
  • Type: any
isTerraformResource 
import { amplifyBranch } from '@cdktf/aws-cdk'

amplifyBranch.AmplifyBranch.isTerraformResource(x: any)
xRequired
  • Type: any
generateConfigForImport 
import { amplifyBranch } from '@cdktf/aws-cdk'

amplifyBranch.AmplifyBranch.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

importToIdRequired
  • Type: string

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

importFromIdRequired
  • Type: string

The id of the existing AmplifyBranch that should be imported.

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

providerOptional
  • Type: cdktf.TerraformProvider

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

Properties

Name Type Description
node constructs.Node The tree node.
cdktfStack cdktf.TerraformStack No description.
fqn string No description.
friendlyUniqueId string No description.
terraformMetaArguments {[ key: string ]: any} No description.
terraformResourceType string No description.
terraformGeneratorMetadata cdktf.TerraformProviderGeneratorMetadata No description.
connection cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection No description.
count number | cdktf.TerraformCount No description.
dependsOn string[] No description.
forEach cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[] No description.
arn string No description.
associatedResources string[] No description.
customDomains string[] No description.
destinationBranch string No description.
sourceBranch string No description.
appIdInput string No description.
backendEnvironmentArnInput string No description.
basicAuthCredentialsInput string No description.
branchNameInput string No description.
descriptionInput string No description.
displayNameInput string No description.
enableAutoBuildInput boolean | cdktf.IResolvable No description.
enableBasicAuthInput boolean | cdktf.IResolvable No description.
enableNotificationInput boolean | cdktf.IResolvable No description.
enablePerformanceModeInput boolean | cdktf.IResolvable No description.
enablePullRequestPreviewInput boolean | cdktf.IResolvable No description.
environmentVariablesInput {[ key: string ]: string} No description.
frameworkInput string No description.
idInput string No description.
pullRequestEnvironmentNameInput string No description.
stageInput string No description.
tagsAllInput {[ key: string ]: string} No description.
tagsInput {[ key: string ]: string} No description.
ttlInput string No description.
appId string No description.
backendEnvironmentArn string No description.
basicAuthCredentials string No description.
branchName string No description.
description string No description.
displayName string No description.
enableAutoBuild boolean | cdktf.IResolvable No description.
enableBasicAuth boolean | cdktf.IResolvable No description.
enableNotification boolean | cdktf.IResolvable No description.
enablePerformanceMode boolean | cdktf.IResolvable No description.
enablePullRequestPreview boolean | cdktf.IResolvable No description.
environmentVariables {[ key: string ]: string} No description.
framework string No description.
id string No description.
pullRequestEnvironmentName string No description.
stage string No description.
tags {[ key: string ]: string} No description.
tagsAll {[ key: string ]: string} No description.
ttl string No description.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

cdktfStackRequired 
public readonly cdktfStack: TerraformStack;
  • Type: cdktf.TerraformStack
fqnRequired 
public readonly fqn: string;
  • Type: string
friendlyUniqueIdRequired 
public readonly friendlyUniqueId: string;
  • Type: string
terraformMetaArgumentsRequired 
public readonly terraformMetaArguments: {[ key: string ]: any};
  • Type: {[ key: string ]: any}
terraformResourceTypeRequired 
public readonly terraformResourceType: string;
  • Type: string
terraformGeneratorMetadataOptional 
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
  • Type: cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
countOptional 
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount
dependsOnOptional 
public readonly dependsOn: string[];
  • Type: string[]
forEachOptional 
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider
provisionersOptional 
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
arnRequired 
public readonly arn: string;
  • Type: string
associatedResourcesRequired 
public readonly associatedResources: string[];
  • Type: string[]
customDomainsRequired 
public readonly customDomains: string[];
  • Type: string[]
destinationBranchRequired 
public readonly destinationBranch: string;
  • Type: string
sourceBranchRequired 
public readonly sourceBranch: string;
  • Type: string
appIdInputOptional 
public readonly appIdInput: string;
  • Type: string
backendEnvironmentArnInputOptional 
public readonly backendEnvironmentArnInput: string;
  • Type: string
basicAuthCredentialsInputOptional 
public readonly basicAuthCredentialsInput: string;
  • Type: string
branchNameInputOptional 
public readonly branchNameInput: string;
  • Type: string
descriptionInputOptional 
public readonly descriptionInput: string;
  • Type: string
displayNameInputOptional 
public readonly displayNameInput: string;
  • Type: string
enableAutoBuildInputOptional 
public readonly enableAutoBuildInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
enableBasicAuthInputOptional 
public readonly enableBasicAuthInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
enableNotificationInputOptional 
public readonly enableNotificationInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
enablePerformanceModeInputOptional 
public readonly enablePerformanceModeInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
enablePullRequestPreviewInputOptional 
public readonly enablePullRequestPreviewInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
environmentVariablesInputOptional 
public readonly environmentVariablesInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
frameworkInputOptional 
public readonly frameworkInput: string;
  • Type: string
idInputOptional 
public readonly idInput: string;
  • Type: string
pullRequestEnvironmentNameInputOptional 
public readonly pullRequestEnvironmentNameInput: string;
  • Type: string
stageInputOptional 
public readonly stageInput: string;
  • Type: string
tagsAllInputOptional 
public readonly tagsAllInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
tagsInputOptional 
public readonly tagsInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
ttlInputOptional 
public readonly ttlInput: string;
  • Type: string
appIdRequired 
public readonly appId: string;
  • Type: string
backendEnvironmentArnRequired 
public readonly backendEnvironmentArn: string;
  • Type: string
basicAuthCredentialsRequired 
public readonly basicAuthCredentials: string;
  • Type: string
branchNameRequired 
public readonly branchName: string;
  • Type: string
descriptionRequired 
public readonly description: string;
  • Type: string
displayNameRequired 
public readonly displayName: string;
  • Type: string
enableAutoBuildRequired 
public readonly enableAutoBuild: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
enableBasicAuthRequired 
public readonly enableBasicAuth: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
enableNotificationRequired 
public readonly enableNotification: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
enablePerformanceModeRequired 
public readonly enablePerformanceMode: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
enablePullRequestPreviewRequired 
public readonly enablePullRequestPreview: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
environmentVariablesRequired 
public readonly environmentVariables: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
frameworkRequired 
public readonly framework: string;
  • Type: string
idRequired 
public readonly id: string;
  • Type: string
pullRequestEnvironmentNameRequired 
public readonly pullRequestEnvironmentName: string;
  • Type: string
stageRequired 
public readonly stage: string;
  • Type: string
tagsRequired 
public readonly tags: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
tagsAllRequired 
public readonly tagsAll: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
ttlRequired 
public readonly ttl: string;
  • Type: string

Constants

Name Type Description
tfResourceType string No description.
tfResourceTypeRequired 
public readonly tfResourceType: string;
  • Type: string

Structs

AmplifyBranchConfig

Initializer 

import { amplifyBranch } from '@cdktf/aws-cdk'

const amplifyBranchConfig: amplifyBranch.AmplifyBranchConfig = { ... }

Properties

Name Type Description
connection cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection No description.
count number | cdktf.TerraformCount No description.
dependsOn cdktf.ITerraformDependable[] No description.
forEach cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[] No description.
appId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/amplify_branch#app_id AmplifyBranch#app_id}.
branchName string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/amplify_branch#branch_name AmplifyBranch#branch_name}.
backendEnvironmentArn string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/amplify_branch#backend_environment_arn AmplifyBranch#backend_environment_arn}.
basicAuthCredentials string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/amplify_branch#basic_auth_credentials AmplifyBranch#basic_auth_credentials}.
description string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/amplify_branch#description AmplifyBranch#description}.
displayName string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/amplify_branch#display_name AmplifyBranch#display_name}.
enableAutoBuild boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/amplify_branch#enable_auto_build AmplifyBranch#enable_auto_build}.
enableBasicAuth boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/amplify_branch#enable_basic_auth AmplifyBranch#enable_basic_auth}.
enableNotification boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/amplify_branch#enable_notification AmplifyBranch#enable_notification}.
enablePerformanceMode boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/amplify_branch#enable_performance_mode AmplifyBranch#enable_performance_mode}.
enablePullRequestPreview boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/amplify_branch#enable_pull_request_preview AmplifyBranch#enable_pull_request_preview}.
environmentVariables {[ key: string ]: string} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/amplify_branch#environment_variables AmplifyBranch#environment_variables}.
framework string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/amplify_branch#framework AmplifyBranch#framework}.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/amplify_branch#id AmplifyBranch#id}.
pullRequestEnvironmentName string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/amplify_branch#pull_request_environment_name AmplifyBranch#pull_request_environment_name}.
stage string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/amplify_branch#stage AmplifyBranch#stage}.
tags {[ key: string ]: string} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/amplify_branch#tags AmplifyBranch#tags}.
tagsAll {[ key: string ]: string} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/amplify_branch#tags_all AmplifyBranch#tags_all}.
ttl string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/amplify_branch#ttl AmplifyBranch#ttl}.
connectionOptional 
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
countOptional 
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount
dependsOnOptional 
public readonly dependsOn: ITerraformDependable[];
  • Type: cdktf.ITerraformDependable[]
forEachOptional 
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider
provisionersOptional 
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
appIdRequired 
public readonly appId: string;
  • Type: string

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

branchNameRequired 
public readonly branchName: string;
  • Type: string

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

backendEnvironmentArnOptional 
public readonly backendEnvironmentArn: string;
  • Type: string

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

basicAuthCredentialsOptional 
public readonly basicAuthCredentials: string;
  • Type: string

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

descriptionOptional 
public readonly description: string;
  • Type: string

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

displayNameOptional 
public readonly displayName: string;
  • Type: string

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

enableAutoBuildOptional 
public readonly enableAutoBuild: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

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

enableBasicAuthOptional 
public readonly enableBasicAuth: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

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

enableNotificationOptional 
public readonly enableNotification: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

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

enablePerformanceModeOptional 
public readonly enablePerformanceMode: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

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

enablePullRequestPreviewOptional 
public readonly enablePullRequestPreview: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

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

environmentVariablesOptional 
public readonly environmentVariables: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

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

frameworkOptional 
public readonly framework: string;
  • Type: string

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

idOptional 
public readonly id: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/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 readonly pullRequestEnvironmentName: string;
  • Type: string

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

stageOptional 
public readonly stage: string;
  • Type: string

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

tagsOptional 
public readonly tags: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

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

tagsAllOptional 
public readonly tagsAll: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

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

ttlOptional 
public readonly ttl: string;
  • Type: string

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