aws-native.amplify.Branch

Explore with Pulumi AI

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

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi

pulumi/pulumi-aws-native

Create Branch Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Branch(name: string, args: BranchArgs, opts?: CustomResourceOptions);

@overload
def Branch(resource_name: str,
           args: BranchArgs,
           opts: Optional[ResourceOptions] = None)

@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[_root_inputs.TagArgs]] = 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.

Parameters

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.

Example

The following reference example uses placeholder values for all input properties.

Coming soon!

Coming soon!

Coming soon!

Coming soon!

const branchResource = new aws_native.amplify.Branch("branchResource", {
    appId: "string",
    backend: {
        stackArn: "string",
    },
    basicAuthConfig: {
        password: "string",
        username: "string",
        enableBasicAuth: false,
    },
    branchName: "string",
    buildSpec: "string",
    description: "string",
    enableAutoBuild: false,
    enablePerformanceMode: false,
    enablePullRequestPreview: false,
    environmentVariables: [{
        name: "string",
        value: "string",
    }],
    framework: "string",
    pullRequestEnvironmentName: "string",
    stage: aws_native.amplify.BranchStage.Experimental,
    tags: [{
        key: "string",
        value: "string",
    }],
});