AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

Class: Aws::Amplify::Types::AutoBranchCreationConfig

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

Overview

Note:

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

{
  stage: "PRODUCTION", # accepts PRODUCTION, BETA, DEVELOPMENT, EXPERIMENTAL, PULL_REQUEST
  framework: "Framework",
  enable_auto_build: false,
  environment_variables: {
    "EnvKey" => "EnvValue",
  },
  basic_auth_credentials: "BasicAuthCredentials",
  enable_basic_auth: false,
  enable_performance_mode: false,
  build_spec: "BuildSpec",
  enable_pull_request_preview: false,
  pull_request_environment_name: "PullRequestEnvironmentName",
}

Describes the automated branch creation configuration.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#basic_auth_credentialsString

The basic authorization credentials for the autocreated branch.

Returns:

  • (String)

    The basic authorization credentials for the autocreated branch.

#build_specString

The build specification (build spec) for the autocreated branch.

Returns:

  • (String)

    The build specification (build spec) for the autocreated branch.

#enable_auto_buildBoolean

Enables auto building for the autocreated branch.

Returns:

  • (Boolean)

    Enables auto building for the autocreated branch.

#enable_basic_authBoolean

Enables basic authorization for the autocreated branch.

Returns:

  • (Boolean)

    Enables basic authorization for the autocreated branch.

#enable_performance_modeBoolean

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_previewBoolean

Enables pull request previews for the autocreated branch.

Returns:

  • (Boolean)

    Enables pull request previews for the autocreated branch.

#environment_variablesHash<String,String>

The environment variables for the autocreated branch.

Returns:

  • (Hash<String,String>)

    The environment variables for the autocreated branch.

#frameworkString

The framework for the autocreated branch.

Returns:

  • (String)

    The framework for the autocreated branch.

#pull_request_environment_nameString

The Amplify environment name for the pull request.

Returns:

  • (String)

    The Amplify environment name for the pull request.

#stageString

Describes the current stage for the autocreated branch.

Possible values:

  • PRODUCTION
  • BETA
  • DEVELOPMENT
  • EXPERIMENTAL
  • PULL_REQUEST

Returns:

  • (String)

    Describes the current stage for the autocreated branch.