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

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

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 AutoBranchCreationConfig data as a 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,
  build_spec: "BuildSpec",
  enable_pull_request_preview: false,
  pull_request_environment_name: "PullRequestEnvironmentName",
}

Structure with auto branch creation config.

Instance Attribute Summary collapse

Instance Attribute Details

#basic_auth_credentialsString

Basic Authorization credentials for the auto created branch.

Returns:

  • (String)


200
201
202
203
204
205
206
207
208
209
210
211
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 200

class AutoBranchCreationConfig < Struct.new(
  :stage,
  :framework,
  :enable_auto_build,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :build_spec,
  :enable_pull_request_preview,
  :pull_request_environment_name)
  include Aws::Structure
end

#build_specString

BuildSpec for the auto created branch.

Returns:

  • (String)


200
201
202
203
204
205
206
207
208
209
210
211
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 200

class AutoBranchCreationConfig < Struct.new(
  :stage,
  :framework,
  :enable_auto_build,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :build_spec,
  :enable_pull_request_preview,
  :pull_request_environment_name)
  include Aws::Structure
end

#enable_auto_buildBoolean

Enables auto building for the auto created branch.

Returns:

  • (Boolean)


200
201
202
203
204
205
206
207
208
209
210
211
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 200

class AutoBranchCreationConfig < Struct.new(
  :stage,
  :framework,
  :enable_auto_build,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :build_spec,
  :enable_pull_request_preview,
  :pull_request_environment_name)
  include Aws::Structure
end

#enable_basic_authBoolean

Enables Basic Auth for the auto created branch.

Returns:

  • (Boolean)


200
201
202
203
204
205
206
207
208
209
210
211
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 200

class AutoBranchCreationConfig < Struct.new(
  :stage,
  :framework,
  :enable_auto_build,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :build_spec,
  :enable_pull_request_preview,
  :pull_request_environment_name)
  include Aws::Structure
end

#enable_pull_request_previewBoolean

Enables Pull Request Preview for auto created branch.

Returns:

  • (Boolean)


200
201
202
203
204
205
206
207
208
209
210
211
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 200

class AutoBranchCreationConfig < Struct.new(
  :stage,
  :framework,
  :enable_auto_build,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :build_spec,
  :enable_pull_request_preview,
  :pull_request_environment_name)
  include Aws::Structure
end

#environment_variablesHash<String,String>

Environment Variables for the auto created branch.

Returns:

  • (Hash<String,String>)


200
201
202
203
204
205
206
207
208
209
210
211
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 200

class AutoBranchCreationConfig < Struct.new(
  :stage,
  :framework,
  :enable_auto_build,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :build_spec,
  :enable_pull_request_preview,
  :pull_request_environment_name)
  include Aws::Structure
end

#frameworkString

Framework for the auto created branch.

Returns:

  • (String)


200
201
202
203
204
205
206
207
208
209
210
211
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 200

class AutoBranchCreationConfig < Struct.new(
  :stage,
  :framework,
  :enable_auto_build,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :build_spec,
  :enable_pull_request_preview,
  :pull_request_environment_name)
  include Aws::Structure
end

#pull_request_environment_nameString

The Amplify Environment name for the pull request.

Returns:

  • (String)


200
201
202
203
204
205
206
207
208
209
210
211
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 200

class AutoBranchCreationConfig < Struct.new(
  :stage,
  :framework,
  :enable_auto_build,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :build_spec,
  :enable_pull_request_preview,
  :pull_request_environment_name)
  include Aws::Structure
end

#stageString

Stage for the auto created branch.

Returns:

  • (String)


200
201
202
203
204
205
206
207
208
209
210
211
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 200

class AutoBranchCreationConfig < Struct.new(
  :stage,
  :framework,
  :enable_auto_build,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :build_spec,
  :enable_pull_request_preview,
  :pull_request_environment_name)
  include Aws::Structure
end