1. Packages
  2. AWS Native
  3. API Docs
  4. amplify
  5. Branch

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.96.0 published on Friday, Feb 9, 2024 by Pulumi

aws-native.amplify.Branch

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.96.0 published on Friday, Feb 9, 2024 by Pulumi

    The AWS::Amplify::Branch resource creates a new branch within an app.

    Create Branch Resource

    new Branch(name: string, args: BranchArgs, opts?: CustomResourceOptions);
    @overload
    def Branch(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               app_id: Optional[str] = None,
               backend: Optional[BranchBackendArgs] = None,
               basic_auth_config: Optional[BranchBasicAuthConfigArgs] = None,
               branch_name: Optional[str] = None,
               build_spec: Optional[str] = None,
               description: Optional[str] = None,
               enable_auto_build: Optional[bool] = None,
               enable_performance_mode: Optional[bool] = None,
               enable_pull_request_preview: Optional[bool] = None,
               environment_variables: Optional[Sequence[BranchEnvironmentVariableArgs]] = None,
               framework: Optional[str] = None,
               pull_request_environment_name: Optional[str] = None,
               stage: Optional[BranchStage] = None,
               tags: Optional[Sequence[BranchTagArgs]] = None)
    @overload
    def Branch(resource_name: str,
               args: BranchArgs,
               opts: Optional[ResourceOptions] = None)
    func NewBranch(ctx *Context, name string, args BranchArgs, opts ...ResourceOption) (*Branch, error)
    public Branch(string name, BranchArgs args, CustomResourceOptions? opts = null)
    public Branch(String name, BranchArgs args)
    public Branch(String name, BranchArgs args, CustomResourceOptions options)
    
    type: aws-native:amplify:Branch
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args BranchArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args BranchArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args BranchArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BranchArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BranchArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Branch Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Branch resource accepts the following input properties:

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Branch resource produces the following output properties:

    Arn string
    Id string
    The provider-assigned unique ID for this managed resource.
    Arn string
    Id string
    The provider-assigned unique ID for this managed resource.
    arn String
    id String
    The provider-assigned unique ID for this managed resource.
    arn string
    id string
    The provider-assigned unique ID for this managed resource.
    arn str
    id str
    The provider-assigned unique ID for this managed resource.
    arn String
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    BranchBackend, BranchBackendArgs

    StackArn string
    StackArn string
    stackArn String
    stackArn string
    stackArn String

    BranchBasicAuthConfig, BranchBasicAuthConfigArgs

    password String
    username String
    enableBasicAuth Boolean
    password string
    username string
    enableBasicAuth boolean
    password String
    username String
    enableBasicAuth Boolean

    BranchEnvironmentVariable, BranchEnvironmentVariableArgs

    Name string
    Value string
    Name string
    Value string
    name String
    value String
    name string
    value string
    name str
    value str
    name String
    value String

    BranchStage, BranchStageArgs

    Experimental
    EXPERIMENTAL
    Beta
    BETA
    PullRequest
    PULL_REQUEST
    Production
    PRODUCTION
    Development
    DEVELOPMENT
    BranchStageExperimental
    EXPERIMENTAL
    BranchStageBeta
    BETA
    BranchStagePullRequest
    PULL_REQUEST
    BranchStageProduction
    PRODUCTION
    BranchStageDevelopment
    DEVELOPMENT
    Experimental
    EXPERIMENTAL
    Beta
    BETA
    PullRequest
    PULL_REQUEST
    Production
    PRODUCTION
    Development
    DEVELOPMENT
    Experimental
    EXPERIMENTAL
    Beta
    BETA
    PullRequest
    PULL_REQUEST
    Production
    PRODUCTION
    Development
    DEVELOPMENT
    EXPERIMENTAL
    EXPERIMENTAL
    BETA
    BETA
    PULL_REQUEST
    PULL_REQUEST
    PRODUCTION
    PRODUCTION
    DEVELOPMENT
    DEVELOPMENT
    "EXPERIMENTAL"
    EXPERIMENTAL
    "BETA"
    BETA
    "PULL_REQUEST"
    PULL_REQUEST
    "PRODUCTION"
    PRODUCTION
    "DEVELOPMENT"
    DEVELOPMENT

    BranchTag, BranchTagArgs

    Key string
    Value string
    Key string
    Value string
    key String
    value String
    key string
    value string
    key str
    value str
    key String
    value String

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.96.0 published on Friday, Feb 9, 2024 by Pulumi