Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/5.83.0/docs/resources/amplify_branch aws_amplify_branch}.
using HashiCorp.Cdktf.Providers.Aws;
new AmplifyBranch(Construct Scope, string Id, AmplifyBranchConfig Config);
Name | Type | Description |
---|---|---|
Scope |
Constructs.Construct |
The scope in which to define this construct. |
Id |
string |
The scoped construct ID. |
Config |
AmplifyBranchConfig |
No description. |
- Type: Constructs.Construct
The scope in which to define this construct.
- Type: string
The scoped construct ID.
Must be unique amongst siblings in the same scope
- Type: AmplifyBranchConfig
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. |
private string ToString()
Returns a string representation of this construct.
private void AddOverride(string Path, object Value)
- Type: string
- Type: object
private void OverrideLogicalId(string NewLogicalId)
Overrides the auto-generated logical ID with a specific ID.
- Type: string
The new logical ID to use for this stack element.
private void ResetOverrideLogicalId()
Resets a previously passed logical Id to use the auto-generated logical id again.
private object ToHclTerraform()
private object ToMetadata()
private object ToTerraform()
Adds this resource to the terraform JSON output.
private void AddMoveTarget(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.
- Type: string
The string move target that will correspond to this resource.
private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)
- Type: string
private IResolvable GetBooleanAttribute(string TerraformAttribute)
- Type: string
private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)
- Type: string
private string[] GetListAttribute(string TerraformAttribute)
- Type: string
private double GetNumberAttribute(string TerraformAttribute)
- Type: string
private double[] GetNumberListAttribute(string TerraformAttribute)
- Type: string
private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)
- Type: string
private string GetStringAttribute(string TerraformAttribute)
- Type: string
private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)
- Type: string
private object HasResourceMove()
private void ImportFrom(string Id, TerraformProvider Provider = null)
- Type: string
- Type: HashiCorp.Cdktf.TerraformProvider
private IResolvable InterpolationForAttribute(string TerraformAttribute)
- Type: string
private void MoveFromId(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.
- Type: string
Full id of resource being moved from, e.g. "aws_s3_bucket.example".
private void MoveTo(string MoveTarget, object Index = null)
Moves this resource to the target resource given by moveTarget.
- Type: string
The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.
- Type: object
Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.
private void MoveToId(string Id)
Moves this resource to the resource corresponding to "id".
- Type: string
Full id of resource to move to, e.g. "aws_s3_bucket.example".
private void ResetBackendEnvironmentArn()
private void ResetBasicAuthCredentials()
private void ResetDescription()
private void ResetDisplayName()
private void ResetEnableAutoBuild()
private void ResetEnableBasicAuth()
private void ResetEnableNotification()
private void ResetEnablePerformanceMode()
private void ResetEnablePullRequestPreview()
private void ResetEnvironmentVariables()
private void ResetFramework()
private void ResetId()
private void ResetPullRequestEnvironmentName()
private void ResetStage()
private void ResetTags()
private void ResetTagsAll()
private void ResetTtl()
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 ". |
using HashiCorp.Cdktf.Providers.Aws;
AmplifyBranch.IsConstruct(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.
- Type: object
Any object.
using HashiCorp.Cdktf.Providers.Aws;
AmplifyBranch.IsTerraformElement(object X);
- Type: object
using HashiCorp.Cdktf.Providers.Aws;
AmplifyBranch.IsTerraformResource(object X);
- Type: object
using HashiCorp.Cdktf.Providers.Aws;
AmplifyBranch.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null);
Generates CDKTF code for importing a AmplifyBranch resource upon running "cdktf plan ".
- Type: Constructs.Construct
The scope in which to define this construct.
- Type: string
The construct id used in the generated config for the AmplifyBranch to import.
- Type: string
The id of the existing AmplifyBranch that should be imported.
Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/5.83.0/docs/resources/amplify_branch#import import section} in the documentation of this resource for the id to use
- Type: HashiCorp.Cdktf.TerraformProvider
? Optional instance of the provider where the AmplifyBranch to import is found.
Name | Type | Description |
---|---|---|
Node |
Constructs.Node |
The tree node. |
CdktfStack |
HashiCorp.Cdktf.TerraformStack |
No description. |
Fqn |
string |
No description. |
FriendlyUniqueId |
string |
No description. |
TerraformMetaArguments |
System.Collections.Generic.IDictionary<string, object> |
No description. |
TerraformResourceType |
string |
No description. |
TerraformGeneratorMetadata |
HashiCorp.Cdktf.TerraformProviderGeneratorMetadata |
No description. |
Connection |
object |
No description. |
Count |
object |
No description. |
DependsOn |
string[] |
No description. |
ForEach |
HashiCorp.Cdktf.ITerraformIterator |
No description. |
Lifecycle |
HashiCorp.Cdktf.TerraformResourceLifecycle |
No description. |
Provider |
HashiCorp.Cdktf.TerraformProvider |
No description. |
Provisioners |
object[] |
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 |
object |
No description. |
EnableBasicAuthInput |
object |
No description. |
EnableNotificationInput |
object |
No description. |
EnablePerformanceModeInput |
object |
No description. |
EnablePullRequestPreviewInput |
object |
No description. |
EnvironmentVariablesInput |
System.Collections.Generic.IDictionary<string, string> |
No description. |
FrameworkInput |
string |
No description. |
IdInput |
string |
No description. |
PullRequestEnvironmentNameInput |
string |
No description. |
StageInput |
string |
No description. |
TagsAllInput |
System.Collections.Generic.IDictionary<string, string> |
No description. |
TagsInput |
System.Collections.Generic.IDictionary<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 |
object |
No description. |
EnableBasicAuth |
object |
No description. |
EnableNotification |
object |
No description. |
EnablePerformanceMode |
object |
No description. |
EnablePullRequestPreview |
object |
No description. |
EnvironmentVariables |
System.Collections.Generic.IDictionary<string, string> |
No description. |
Framework |
string |
No description. |
Id |
string |
No description. |
PullRequestEnvironmentName |
string |
No description. |
Stage |
string |
No description. |
Tags |
System.Collections.Generic.IDictionary<string, string> |
No description. |
TagsAll |
System.Collections.Generic.IDictionary<string, string> |
No description. |
Ttl |
string |
No description. |
public Node Node { get; }
- Type: Constructs.Node
The tree node.
public TerraformStack CdktfStack { get; }
- Type: HashiCorp.Cdktf.TerraformStack
public string Fqn { get; }
- Type: string
public string FriendlyUniqueId { get; }
- Type: string
public System.Collections.Generic.IDictionary<string, object> TerraformMetaArguments { get; }
- Type: System.Collections.Generic.IDictionary<string, object>
public string TerraformResourceType { get; }
- Type: string
public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }
- Type: HashiCorp.Cdktf.TerraformProviderGeneratorMetadata
public object Connection { get; }
- Type: object
public object Count { get; }
- Type: object
public string[] DependsOn { get; }
- Type: string[]
public ITerraformIterator ForEach { get; }
- Type: HashiCorp.Cdktf.ITerraformIterator
public TerraformResourceLifecycle Lifecycle { get; }
- Type: HashiCorp.Cdktf.TerraformResourceLifecycle
public TerraformProvider Provider { get; }
- Type: HashiCorp.Cdktf.TerraformProvider
public object[] Provisioners { get; }
- Type: object[]
public string Arn { get; }
- Type: string
public string[] AssociatedResources { get; }
- Type: string[]
public string[] CustomDomains { get; }
- Type: string[]
public string DestinationBranch { get; }
- Type: string
public string SourceBranch { get; }
- Type: string
public string AppIdInput { get; }
- Type: string
public string BackendEnvironmentArnInput { get; }
- Type: string
public string BasicAuthCredentialsInput { get; }
- Type: string
public string BranchNameInput { get; }
- Type: string
public string DescriptionInput { get; }
- Type: string
public string DisplayNameInput { get; }
- Type: string
public object EnableAutoBuildInput { get; }
- Type: object
public object EnableBasicAuthInput { get; }
- Type: object
public object EnableNotificationInput { get; }
- Type: object
public object EnablePerformanceModeInput { get; }
- Type: object
public object EnablePullRequestPreviewInput { get; }
- Type: object
public System.Collections.Generic.IDictionary<string, string> EnvironmentVariablesInput { get; }
- Type: System.Collections.Generic.IDictionary<string, string>
public string FrameworkInput { get; }
- Type: string
public string IdInput { get; }
- Type: string
public string PullRequestEnvironmentNameInput { get; }
- Type: string
public string StageInput { get; }
- Type: string
public System.Collections.Generic.IDictionary<string, string> TagsAllInput { get; }
- Type: System.Collections.Generic.IDictionary<string, string>
public System.Collections.Generic.IDictionary<string, string> TagsInput { get; }
- Type: System.Collections.Generic.IDictionary<string, string>
public string TtlInput { get; }
- Type: string
public string AppId { get; }
- Type: string
public string BackendEnvironmentArn { get; }
- Type: string
public string BasicAuthCredentials { get; }
- Type: string
public string BranchName { get; }
- Type: string
public string Description { get; }
- Type: string
public string DisplayName { get; }
- Type: string
public object EnableAutoBuild { get; }
- Type: object
public object EnableBasicAuth { get; }
- Type: object
public object EnableNotification { get; }
- Type: object
public object EnablePerformanceMode { get; }
- Type: object
public object EnablePullRequestPreview { get; }
- Type: object
public System.Collections.Generic.IDictionary<string, string> EnvironmentVariables { get; }
- Type: System.Collections.Generic.IDictionary<string, string>
public string Framework { get; }
- Type: string
public string Id { get; }
- Type: string
public string PullRequestEnvironmentName { get; }
- Type: string
public string Stage { get; }
- Type: string
public System.Collections.Generic.IDictionary<string, string> Tags { get; }
- Type: System.Collections.Generic.IDictionary<string, string>
public System.Collections.Generic.IDictionary<string, string> TagsAll { get; }
- Type: System.Collections.Generic.IDictionary<string, string>
public string Ttl { get; }
- Type: string
Name | Type | Description |
---|---|---|
TfResourceType |
string |
No description. |
public string TfResourceType { get; }
- Type: string
using HashiCorp.Cdktf.Providers.Aws;
new AmplifyBranchConfig {
object Connection = null,
object Count = null,
ITerraformDependable[] DependsOn = null,
ITerraformIterator ForEach = null,
TerraformResourceLifecycle Lifecycle = null,
TerraformProvider Provider = null,
object[] Provisioners = null,
string AppId,
string BranchName,
string BackendEnvironmentArn = null,
string BasicAuthCredentials = null,
string Description = null,
string DisplayName = null,
object EnableAutoBuild = null,
object EnableBasicAuth = null,
object EnableNotification = null,
object EnablePerformanceMode = null,
object EnablePullRequestPreview = null,
System.Collections.Generic.IDictionary<string, string> EnvironmentVariables = null,
string Framework = null,
string Id = null,
string PullRequestEnvironmentName = null,
string Stage = null,
System.Collections.Generic.IDictionary<string, string> Tags = null,
System.Collections.Generic.IDictionary<string, string> TagsAll = null,
string Ttl = null
};
public object Connection { get; set; }
- Type: object
public object Count { get; set; }
- Type: object
public ITerraformDependable[] DependsOn { get; set; }
- Type: HashiCorp.Cdktf.ITerraformDependable[]
public ITerraformIterator ForEach { get; set; }
- Type: HashiCorp.Cdktf.ITerraformIterator
public TerraformResourceLifecycle Lifecycle { get; set; }
- Type: HashiCorp.Cdktf.TerraformResourceLifecycle
public TerraformProvider Provider { get; set; }
- Type: HashiCorp.Cdktf.TerraformProvider
public object[] Provisioners { get; set; }
- Type: object[]
public string AppId { get; set; }
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.83.0/docs/resources/amplify_branch#app_id AmplifyBranch#app_id}.
public string BranchName { get; set; }
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.83.0/docs/resources/amplify_branch#branch_name AmplifyBranch#branch_name}.
public string BackendEnvironmentArn { get; set; }
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.83.0/docs/resources/amplify_branch#backend_environment_arn AmplifyBranch#backend_environment_arn}.
public string BasicAuthCredentials { get; set; }
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.83.0/docs/resources/amplify_branch#basic_auth_credentials AmplifyBranch#basic_auth_credentials}.
public string Description { get; set; }
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.83.0/docs/resources/amplify_branch#description AmplifyBranch#description}.
public string DisplayName { get; set; }
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.83.0/docs/resources/amplify_branch#display_name AmplifyBranch#display_name}.
public object EnableAutoBuild { get; set; }
- Type: object
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.83.0/docs/resources/amplify_branch#enable_auto_build AmplifyBranch#enable_auto_build}.
public object EnableBasicAuth { get; set; }
- Type: object
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.83.0/docs/resources/amplify_branch#enable_basic_auth AmplifyBranch#enable_basic_auth}.
public object EnableNotification { get; set; }
- Type: object
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.83.0/docs/resources/amplify_branch#enable_notification AmplifyBranch#enable_notification}.
public object EnablePerformanceMode { get; set; }
- Type: object
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.83.0/docs/resources/amplify_branch#enable_performance_mode AmplifyBranch#enable_performance_mode}.
public object EnablePullRequestPreview { get; set; }
- Type: object
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.83.0/docs/resources/amplify_branch#enable_pull_request_preview AmplifyBranch#enable_pull_request_preview}.
public System.Collections.Generic.IDictionary<string, string> EnvironmentVariables { get; set; }
- Type: System.Collections.Generic.IDictionary<string, string>
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.83.0/docs/resources/amplify_branch#environment_variables AmplifyBranch#environment_variables}.
public string Framework { get; set; }
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.83.0/docs/resources/amplify_branch#framework AmplifyBranch#framework}.
public string Id { get; set; }
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.83.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.
public string PullRequestEnvironmentName { get; set; }
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.83.0/docs/resources/amplify_branch#pull_request_environment_name AmplifyBranch#pull_request_environment_name}.
public string Stage { get; set; }
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.83.0/docs/resources/amplify_branch#stage AmplifyBranch#stage}.
public System.Collections.Generic.IDictionary<string, string> Tags { get; set; }
- Type: System.Collections.Generic.IDictionary<string, string>
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.83.0/docs/resources/amplify_branch#tags AmplifyBranch#tags}.
public System.Collections.Generic.IDictionary<string, string> TagsAll { get; set; }
- Type: System.Collections.Generic.IDictionary<string, string>
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.83.0/docs/resources/amplify_branch#tags_all AmplifyBranch#tags_all}.
public string Ttl { get; set; }
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.83.0/docs/resources/amplify_branch#ttl AmplifyBranch#ttl}.