Package com.hashicorp.cdktf.providers.aws.amplify_branch

Interface AmplifyBranchConfig

  • All Superinterfaces:
    software.amazon.jsii.JsiiSerializable, com.hashicorp.cdktf.TerraformMetaArguments
    All Known Implementing Classes:
    AmplifyBranchConfig.Jsii$Proxy
    @Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-30T04:56:50.167Z")
@Stability(Stable)
public interface AmplifyBranchConfig
extends software.amazon.jsii.JsiiSerializable, com.hashicorp.cdktf.TerraformMetaArguments

    • Method Summary

      All Methods Static Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      static AmplifyBranchConfig.Builder builder()  
      String getAppId()
      Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/amplify_branch#app_id AmplifyBranch#app_id}.
      default String getBackendEnvironmentArn()
      Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/amplify_branch#backend_environment_arn AmplifyBranch#backend_environment_arn}.
      default String getBasicAuthCredentials()
      Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/amplify_branch#basic_auth_credentials AmplifyBranch#basic_auth_credentials}.
      String getBranchName()
      Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/amplify_branch#branch_name AmplifyBranch#branch_name}.
      default String getDescription()
      Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/amplify_branch#description AmplifyBranch#description}.
      default String getDisplayName()
      Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/amplify_branch#display_name AmplifyBranch#display_name}.
      default Object getEnableAutoBuild()
      Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/amplify_branch#enable_auto_build AmplifyBranch#enable_auto_build}.
      default Object getEnableBasicAuth()
      Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/amplify_branch#enable_basic_auth AmplifyBranch#enable_basic_auth}.
      default Object getEnableNotification()
      Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/amplify_branch#enable_notification AmplifyBranch#enable_notification}.
      default Object getEnablePerformanceMode()
      Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/amplify_branch#enable_performance_mode AmplifyBranch#enable_performance_mode}.
      default Object getEnablePullRequestPreview()
      Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/amplify_branch#enable_pull_request_preview AmplifyBranch#enable_pull_request_preview}.
      default Map<String,​String> getEnvironmentVariables()
      Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/amplify_branch#environment_variables AmplifyBranch#environment_variables}.
      default String getFramework()
      Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/amplify_branch#framework AmplifyBranch#framework}.
      default String getId()
      Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/amplify_branch#id AmplifyBranch#id}.
      default String getPullRequestEnvironmentName()
      Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/amplify_branch#pull_request_environment_name AmplifyBranch#pull_request_environment_name}.
      default String getStage()
      Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/amplify_branch#stage AmplifyBranch#stage}.
      default Map<String,​String> getTags()
      Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/amplify_branch#tags AmplifyBranch#tags}.
      default Map<String,​String> getTagsAll()
      Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/amplify_branch#tags_all AmplifyBranch#tags_all}.
      default String getTtl()
      Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/amplify_branch#ttl AmplifyBranch#ttl}.

      • Methods inherited from interface software.amazon.jsii.JsiiSerializable

        $jsii$toJson

      • Methods inherited from interface com.hashicorp.cdktf.TerraformMetaArguments

        getConnection, getCount, getDependsOn, getForEach, getLifecycle, getProvider, getProvisioners

    • Method Detail

      • getAppId

        @Stability(Stable)
@NotNull
String getAppId()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/amplify_branch#app_id AmplifyBranch#app_id}.

      • getBranchName

        @Stability(Stable)
@NotNull
String getBranchName()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/amplify_branch#branch_name AmplifyBranch#branch_name}.

      • getBackendEnvironmentArn

        @Stability(Stable)
@Nullable
default String getBackendEnvironmentArn()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/amplify_branch#backend_environment_arn AmplifyBranch#backend_environment_arn}.

      • getBasicAuthCredentials

        @Stability(Stable)
@Nullable
default String getBasicAuthCredentials()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/amplify_branch#basic_auth_credentials AmplifyBranch#basic_auth_credentials}.

      • getDescription

        @Stability(Stable)
@Nullable
default String getDescription()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/amplify_branch#description AmplifyBranch#description}.

      • getDisplayName

        @Stability(Stable)
@Nullable
default String getDisplayName()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/amplify_branch#display_name AmplifyBranch#display_name}.

      • getEnableAutoBuild

        @Stability(Stable)
@Nullable
default Object getEnableAutoBuild()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/amplify_branch#enable_auto_build AmplifyBranch#enable_auto_build}.

      • getEnableBasicAuth

        @Stability(Stable)
@Nullable
default Object getEnableBasicAuth()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/amplify_branch#enable_basic_auth AmplifyBranch#enable_basic_auth}.

      • getEnableNotification

        @Stability(Stable)
@Nullable
default Object getEnableNotification()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/amplify_branch#enable_notification AmplifyBranch#enable_notification}.

      • getEnablePerformanceMode

        @Stability(Stable)
@Nullable
default Object getEnablePerformanceMode()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/amplify_branch#enable_performance_mode AmplifyBranch#enable_performance_mode}.

      • getEnablePullRequestPreview

        @Stability(Stable)
@Nullable
default Object getEnablePullRequestPreview()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/amplify_branch#enable_pull_request_preview AmplifyBranch#enable_pull_request_preview}.

      • getEnvironmentVariables

        @Stability(Stable)
@Nullable
default Map<String,​String> getEnvironmentVariables()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/amplify_branch#environment_variables AmplifyBranch#environment_variables}.

      • getFramework

        @Stability(Stable)
@Nullable
default String getFramework()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/amplify_branch#framework AmplifyBranch#framework}.

      • getId

        @Stability(Stable)
@Nullable
default String getId()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.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.

      • getPullRequestEnvironmentName

        @Stability(Stable)
@Nullable
default String getPullRequestEnvironmentName()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/amplify_branch#pull_request_environment_name AmplifyBranch#pull_request_environment_name}.

      • getStage

        @Stability(Stable)
@Nullable
default String getStage()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/amplify_branch#stage AmplifyBranch#stage}.

      • getTags

        @Stability(Stable)
@Nullable
default Map<String,​String> getTags()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/amplify_branch#tags AmplifyBranch#tags}.

      • getTagsAll

        @Stability(Stable)
@Nullable
default Map<String,​String> getTagsAll()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/amplify_branch#tags_all AmplifyBranch#tags_all}.

      • getTtl

        @Stability(Stable)
@Nullable
default String getTtl()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/amplify_branch#ttl AmplifyBranch#ttl}.