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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb

Overview

Note:

When making an API call, you may pass CreateBranchRequest data as a hash:

{
  app_id: "AppId", # required
  branch_name: "BranchName", # required
  description: "Description",
  stage: "PRODUCTION", # accepts PRODUCTION, BETA, DEVELOPMENT, EXPERIMENTAL
  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",
}

Request structure for a branch create request.

Instance Attribute Summary collapse

Instance Attribute Details

#app_idString

Unique Id for an Amplify App.

Returns:

  • (String)


548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 548

class CreateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :stage,
  :framework,
  :enable_notification,
  :enable_auto_build,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :tags,
  :build_spec,
  :ttl,
  :display_name)
  include Aws::Structure
end

#basic_auth_credentialsString

Basic Authorization credentials for the branch.

Returns:

  • (String)


548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 548

class CreateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :stage,
  :framework,
  :enable_notification,
  :enable_auto_build,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :tags,
  :build_spec,
  :ttl,
  :display_name)
  include Aws::Structure
end

#branch_nameString

Name for the branch.

Returns:

  • (String)


548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 548

class CreateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :stage,
  :framework,
  :enable_notification,
  :enable_auto_build,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :tags,
  :build_spec,
  :ttl,
  :display_name)
  include Aws::Structure
end

#build_specString

BuildSpec for the branch.

Returns:

  • (String)


548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 548

class CreateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :stage,
  :framework,
  :enable_notification,
  :enable_auto_build,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :tags,
  :build_spec,
  :ttl,
  :display_name)
  include Aws::Structure
end

#descriptionString

Description for the branch.

Returns:

  • (String)


548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 548

class CreateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :stage,
  :framework,
  :enable_notification,
  :enable_auto_build,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :tags,
  :build_spec,
  :ttl,
  :display_name)
  include Aws::Structure
end

#display_nameString

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

Returns:

  • (String)


548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 548

class CreateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :stage,
  :framework,
  :enable_notification,
  :enable_auto_build,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :tags,
  :build_spec,
  :ttl,
  :display_name)
  include Aws::Structure
end

#enable_auto_buildBoolean

Enables auto building for the branch.

Returns:

  • (Boolean)


548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 548

class CreateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :stage,
  :framework,
  :enable_notification,
  :enable_auto_build,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :tags,
  :build_spec,
  :ttl,
  :display_name)
  include Aws::Structure
end

#enable_basic_authBoolean

Enables Basic Auth for the branch.

Returns:

  • (Boolean)


548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 548

class CreateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :stage,
  :framework,
  :enable_notification,
  :enable_auto_build,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :tags,
  :build_spec,
  :ttl,
  :display_name)
  include Aws::Structure
end

#enable_notificationBoolean

Enables notifications for the branch.

Returns:

  • (Boolean)


548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 548

class CreateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :stage,
  :framework,
  :enable_notification,
  :enable_auto_build,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :tags,
  :build_spec,
  :ttl,
  :display_name)
  include Aws::Structure
end

#environment_variablesHash<String,String>

Environment Variables for the branch.

Returns:

  • (Hash<String,String>)


548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 548

class CreateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :stage,
  :framework,
  :enable_notification,
  :enable_auto_build,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :tags,
  :build_spec,
  :ttl,
  :display_name)
  include Aws::Structure
end

#frameworkString

Framework for the branch.

Returns:

  • (String)


548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 548

class CreateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :stage,
  :framework,
  :enable_notification,
  :enable_auto_build,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :tags,
  :build_spec,
  :ttl,
  :display_name)
  include Aws::Structure
end

#stageString

Stage for the branch.

Returns:

  • (String)


548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 548

class CreateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :stage,
  :framework,
  :enable_notification,
  :enable_auto_build,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :tags,
  :build_spec,
  :ttl,
  :display_name)
  include Aws::Structure
end

#tagsHash<String,String>

Tag for the branch.

Returns:

  • (Hash<String,String>)


548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 548

class CreateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :stage,
  :framework,
  :enable_notification,
  :enable_auto_build,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :tags,
  :build_spec,
  :ttl,
  :display_name)
  include Aws::Structure
end

#ttlString

The content TTL for the website in seconds.

Returns:

  • (String)


548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 548

class CreateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :stage,
  :framework,
  :enable_notification,
  :enable_auto_build,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :tags,
  :build_spec,
  :ttl,
  :display_name)
  include Aws::Structure
end