You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Amplify::Types::CreateBranchRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateBranchRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  app_id: "AppId", # required
  branch_name: "BranchName", # required
  description: "Description",
  stage: "PRODUCTION", # accepts PRODUCTION, BETA, DEVELOPMENT, EXPERIMENTAL, PULL_REQUEST
  framework: "Framework",
  enable_notification: false,
  enable_auto_build: false,
  environment_variables: {
    "EnvKey" => "EnvValue",
  },
  basic_auth_credentials: "BasicAuthCredentials",
  enable_basic_auth: false,
  enable_performance_mode: false,
  tags: {
    "TagKey" => "TagValue",
  },
  build_spec: "BuildSpec",
  ttl: "TTL",
  display_name: "DisplayName",
  enable_pull_request_preview: false,
  pull_request_environment_name: "PullRequestEnvironmentName",
  backend_environment_arn: "BackendEnvironmentArn",
}

The request structure for the create branch request.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#app_id ⇒ String

The unique ID for an Amplify app.

Returns:

  • (String) —

    The unique ID for an Amplify app.

#backend_environment_arn ⇒ String

The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.

Returns:

  • (String) —

    The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.

#basic_auth_credentials ⇒ String

The basic authorization credentials for the branch.

Returns:

  • (String) —

    The basic authorization credentials for the branch.

#branch_name ⇒ String

The name for the branch.

Returns:

  • (String) —

    The name for the branch.

#build_spec ⇒ String

The build specification (build spec) for the branch.

Returns:

  • (String) —

    The build specification (build spec) for the branch.

#description ⇒ String

The description for the branch.

Returns:

  • (String) —

    The description for the branch.

#display_name ⇒ String

The display name for a branch. This is used as the default domain prefix.

Returns:

  • (String) —

    The display name for a branch.

#enable_auto_build ⇒ Boolean

Enables auto building for the branch.

Returns:

  • (Boolean) —

    Enables auto building for the branch.

#enable_basic_auth ⇒ Boolean

Enables basic authorization for the branch.

Returns:

  • (Boolean) —

    Enables basic authorization for the branch.

#enable_notification ⇒ Boolean

Enables notifications for the branch.

Returns:

  • (Boolean) —

    Enables notifications for the branch.

#enable_performance_mode ⇒ Boolean

Enables performance mode for the branch.

Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.

Returns:

  • (Boolean) —

    Enables performance mode for the branch.

#enable_pull_request_preview ⇒ Boolean

Enables pull request previews for this branch.

Returns:

  • (Boolean) —

    Enables pull request previews for this branch.

#environment_variables ⇒ Hash<String,String>

The environment variables for the branch.

Returns:

  • (Hash<String,String>) —

    The environment variables for the branch.

#framework ⇒ String

The framework for the branch.

Returns:

  • (String) —

    The framework for the branch.

#pull_request_environment_name ⇒ String

The Amplify environment name for the pull request.

Returns:

  • (String) —

    The Amplify environment name for the pull request.

#stage ⇒ String

Describes the current stage for the branch.

Possible values:

  • PRODUCTION
  • BETA
  • DEVELOPMENT
  • EXPERIMENTAL
  • PULL_REQUEST

Returns:

  • (String) —

    Describes the current stage for the branch.

#tags ⇒ Hash<String,String>

The tag for the branch.

Returns:

  • (Hash<String,String>) —

    The tag for the branch.

#ttl ⇒ String

The content Time To Live (TTL) for the website in seconds.

Returns:

  • (String) —

    The content Time To Live (TTL) for the website in seconds.