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,
  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",
}

Request structure for a branch create request.

Instance Attribute Summary collapse

Instance Attribute Details

#app_idString

Unique Id for an Amplify App.

Returns:

  • (String)

    Unique Id for an Amplify App.

#backend_environment_arnString

ARN for a Backend Environment, part of an Amplify App.

Returns:

  • (String)

    ARN for a Backend Environment, part of an Amplify App.

#basic_auth_credentialsString

Basic Authorization credentials for the branch.

Returns:

  • (String)

    Basic Authorization credentials for the branch.

#branch_nameString

Name for the branch.

Returns:

  • (String)

    Name for the branch.

#build_specString

BuildSpec for the branch.

Returns:

  • (String)

    BuildSpec for the branch.

#descriptionString

Description for the branch.

Returns:

  • (String)

    Description for the branch.

#display_nameString

Display name for a branch, will use as the default domain prefix.

Returns:

  • (String)

    Display name for a branch, will use as the default domain prefix.

#enable_auto_buildBoolean

Enables auto building for the branch.

Returns:

  • (Boolean)

    Enables auto building for the branch.

#enable_basic_authBoolean

Enables Basic Auth for the branch.

Returns:

  • (Boolean)

    Enables Basic Auth for the branch.

#enable_notificationBoolean

Enables notifications for the branch.

Returns:

  • (Boolean)

    Enables notifications for the branch.

#enable_pull_request_previewBoolean

Enables Pull Request Preview for this branch.

Returns:

  • (Boolean)

    Enables Pull Request Preview for this branch.

#environment_variablesHash<String,String>

Environment Variables for the branch.

Returns:

  • (Hash<String,String>)

    Environment Variables for the branch.

#frameworkString

Framework for the branch.

Returns:

  • (String)

    Framework for the branch.

#pull_request_environment_nameString

The Amplify Environment name for the pull request.

Returns:

  • (String)

    The Amplify Environment name for the pull request.

#stageString

Stage for the branch.

Possible values:

  • PRODUCTION
  • BETA
  • DEVELOPMENT
  • EXPERIMENTAL
  • PULL_REQUEST

Returns:

  • (String)

    Stage for the branch.

#tagsHash<String,String>

Tag for the branch.

Returns:

  • (Hash<String,String>)

    Tag for the branch.

#ttlString

The content TTL for the website in seconds.

Returns:

  • (String)

    The content TTL for the website in seconds.