Class: Aws::Amplify::Types::StartDeploymentRequest

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

Overview

The request structure for the start a deployment request.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#app_id ⇒ String

The unique ID for an Amplify app.

Returns:

  • (String) 


2380
2381
2382
2383
2384
2385
2386
2387
2388
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2380

class StartDeploymentRequest < Struct.new(
  :app_id,
  :branch_name,
  :job_id,
  :source_url,
  :source_url_type)
  SENSITIVE = []
  include Aws::Structure
end

#branch_name ⇒ String

The name of the branch to use for the deployment job.

Returns:

  • (String) 


2380
2381
2382
2383
2384
2385
2386
2387
2388
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2380

class StartDeploymentRequest < Struct.new(
  :app_id,
  :branch_name,
  :job_id,
  :source_url,
  :source_url_type)
  SENSITIVE = []
  include Aws::Structure
end

#job_id ⇒ String

The job ID for this deployment that is generated by the CreateDeployment request.

Returns:

  • (String) 


2380
2381
2382
2383
2384
2385
2386
2387
2388
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2380

class StartDeploymentRequest < Struct.new(
  :app_id,
  :branch_name,
  :job_id,
  :source_url,
  :source_url_type)
  SENSITIVE = []
  include Aws::Structure
end

#source_url ⇒ String

The source URL for the deployment that is used when calling StartDeployment without CreateDeployment. The source URL can be either an HTTP GET URL that is publicly accessible and downloads a single .zip file, or an Amazon S3 bucket and prefix.

Returns:

  • (String) 


2380
2381
2382
2383
2384
2385
2386
2387
2388
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2380

class StartDeploymentRequest < Struct.new(
  :app_id,
  :branch_name,
  :job_id,
  :source_url,
  :source_url_type)
  SENSITIVE = []
  include Aws::Structure
end

#source_url_type ⇒ String

The type of source specified by the sourceURL. If the value is ZIP, the source is a .zip file. If the value is BUCKET_PREFIX, the source is an Amazon S3 bucket and prefix. If no value is specified, the default is ZIP.

Returns:

  • (String) 


2380
2381
2382
2383
2384
2385
2386
2387
2388
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2380

class StartDeploymentRequest < Struct.new(
  :app_id,
  :branch_name,
  :job_id,
  :source_url,
  :source_url_type)
  SENSITIVE = []
  include Aws::Structure
end