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

Class: Aws::CodePipeline::Types::ActionDeclaration

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

Overview

Note:

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

{
  name: "ActionName", # required
  action_type_id: { # required
    category: "Source", # required, accepts Source, Build, Deploy, Test, Invoke, Approval
    owner: "AWS", # required, accepts AWS, ThirdParty, Custom
    provider: "ActionProvider", # required
    version: "Version", # required
  },
  run_order: 1,
  configuration: {
    "ActionConfigurationKey" => "ActionConfigurationValue",
  },
  output_artifacts: [
    {
      name: "ArtifactName", # required
    },
  ],
  input_artifacts: [
    {
      name: "ArtifactName", # required
    },
  ],
  role_arn: "RoleArn",
  region: "AWSRegionName",
}

Represents information about an action declaration.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#action_type_id ⇒ Types::ActionTypeId

The configuration information for the action type.

Returns:



298
299
300
301
302
303
304
305
306
307
308
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 298

class ActionDeclaration < Struct.new(
  :name,
  :action_type_id,
  :run_order,
  :configuration,
  :output_artifacts,
  :input_artifacts,
  :role_arn,
  :region)
  include Aws::Structure
end

#configuration ⇒ Hash<String,String>

The action declaration's configuration.

Returns:

  • (Hash<String,String>) 


298
299
300
301
302
303
304
305
306
307
308
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 298

class ActionDeclaration < Struct.new(
  :name,
  :action_type_id,
  :run_order,
  :configuration,
  :output_artifacts,
  :input_artifacts,
  :role_arn,
  :region)
  include Aws::Structure
end

#input_artifacts ⇒ Array<Types::InputArtifact>

The name or ID of the artifact consumed by the action, such as a test or build artifact.

Returns:



298
299
300
301
302
303
304
305
306
307
308
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 298

class ActionDeclaration < Struct.new(
  :name,
  :action_type_id,
  :run_order,
  :configuration,
  :output_artifacts,
  :input_artifacts,
  :role_arn,
  :region)
  include Aws::Structure
end

#name ⇒ String

The action declaration's name.

Returns:

  • (String) 


298
299
300
301
302
303
304
305
306
307
308
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 298

class ActionDeclaration < Struct.new(
  :name,
  :action_type_id,
  :run_order,
  :configuration,
  :output_artifacts,
  :input_artifacts,
  :role_arn,
  :region)
  include Aws::Structure
end

#output_artifacts ⇒ Array<Types::OutputArtifact>

The name or ID of the result of the action declaration, such as a test or build artifact.

Returns:



298
299
300
301
302
303
304
305
306
307
308
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 298

class ActionDeclaration < Struct.new(
  :name,
  :action_type_id,
  :run_order,
  :configuration,
  :output_artifacts,
  :input_artifacts,
  :role_arn,
  :region)
  include Aws::Structure
end

#region ⇒ String

The action declaration's AWS Region, such as us-east-1.

Returns:

  • (String) 


298
299
300
301
302
303
304
305
306
307
308
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 298

class ActionDeclaration < Struct.new(
  :name,
  :action_type_id,
  :run_order,
  :configuration,
  :output_artifacts,
  :input_artifacts,
  :role_arn,
  :region)
  include Aws::Structure
end

#role_arn ⇒ String

The ARN of the IAM service role that will perform the declared action. This is assumed through the roleArn for the pipeline.

Returns:

  • (String) 


298
299
300
301
302
303
304
305
306
307
308
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 298

class ActionDeclaration < Struct.new(
  :name,
  :action_type_id,
  :run_order,
  :configuration,
  :output_artifacts,
  :input_artifacts,
  :role_arn,
  :region)
  include Aws::Structure
end

#run_order ⇒ Integer

The order in which actions are run.

Returns:

  • (Integer) 


298
299
300
301
302
303
304
305
306
307
308
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 298

class ActionDeclaration < Struct.new(
  :name,
  :action_type_id,
  :run_order,
  :configuration,
  :output_artifacts,
  :input_artifacts,
  :role_arn,
  :region)
  include Aws::Structure
end