Package com.pulumi.aws.amplify.inputs

Class BranchState

  • public final class BranchState
extends com.pulumi.resources.ResourceArgs

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  BranchState.Builder  

      • Nested classes/interfaces inherited from class com.pulumi.resources.InputArgs

        com.pulumi.resources.InputArgs.InputArgsInternal

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static BranchState Empty  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> appId()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> arn()  
      java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> associatedResources()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> backendEnvironmentArn()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> basicAuthCredentials()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> branchName()  
      static BranchState.Builder builder()  
      static BranchState.Builder builder​(BranchState defaults)  
      java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> customDomains()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> description()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> destinationBranch()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> displayName()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> enableAutoBuild()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> enableBasicAuth()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> enableNotification()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> enablePerformanceMode()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> enablePullRequestPreview()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> enableSkewProtection()  
      java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> environmentVariables()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> framework()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> pullRequestEnvironmentName()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> region()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> sourceBranch()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> stage()  
      java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tagsAll()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> ttl()  

      • Methods inherited from class com.pulumi.resources.ResourceArgs

        validateMember

      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • appId

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> appId()
        Returns:
        Unique ID for an Amplify app.

      • arn

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> arn()
        Returns:
        ARN for the branch.

      • associatedResources

        public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> associatedResources()
        Returns:
        A list of custom resources that are linked to this branch.

      • backendEnvironmentArn

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> backendEnvironmentArn()
        Returns:
        ARN for a backend environment that is part of an Amplify app.

      • basicAuthCredentials

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> basicAuthCredentials()
        Returns:
        Basic authorization credentials for the branch.

      • branchName

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> branchName()
        Returns:
        Name for the branch.

      • customDomains

        public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> customDomains()
        Returns:
        Custom domains for the branch.

      • description

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> description()
        Returns:
        Description for the branch.

      • destinationBranch

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> destinationBranch()
        Returns:
        Destination branch if the branch is a pull request branch.

      • displayName

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> displayName()
        Returns:
        Display name for a branch. This is used as the default domain prefix.

      • enableAutoBuild

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> enableAutoBuild()
        Returns:
        Enables auto building for the branch.

      • enableBasicAuth

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> enableBasicAuth()
        Returns:
        Enables basic authorization for the branch.

      • enableNotification

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> enableNotification()
        Returns:
        Enables notifications for the branch.

      • enablePerformanceMode

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> enablePerformanceMode()
        Returns:
        Enables performance mode for the branch.

      • enablePullRequestPreview

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> enablePullRequestPreview()
        Returns:
        Enables pull request previews for this branch.

      • enableSkewProtection

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> enableSkewProtection()
        Returns:
        Enables skew protection for the branch.

      • environmentVariables

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> environmentVariables()
        Returns:
        Environment variables for the branch.

      • framework

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> framework()
        Returns:
        Framework for the branch.

      • pullRequestEnvironmentName

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> pullRequestEnvironmentName()
        Returns:
        Amplify environment name for the pull request.

      • region

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • sourceBranch

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> sourceBranch()
        Returns:
        Source branch if the branch is a pull request branch.

      • stage

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> stage()
        Returns:
        Describes the current stage for the branch. Valid values: `PRODUCTION`, `BETA`, `DEVELOPMENT`, `EXPERIMENTAL`, `PULL_REQUEST`.

      • tags

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Key-value mapping of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • tagsAll

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tagsAll()
        Returns:
        Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • ttl

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> ttl()
        Returns:
        Content Time To Live (TTL) for the website in seconds.