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.

Instance Attribute Summary collapse

Instance Attribute Details

#action_type_idTypes::ActionTypeId

Specifies the action type and the provider of the action.

Returns:



325
326
327
328
329
330
331
332
333
334
335
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 325

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

#configurationHash<String,String>

The action's configuration. These are key-value pairs that specify input values for an action. For more information, see Action Structure Requirements in CodePipeline. For the list of configuration properties for the AWS CloudFormation action type in CodePipeline, see Configuration Properties Reference in the AWS CloudFormation User Guide. For template snippets with examples, see Using Parameter Override Functions with CodePipeline Pipelines in the AWS CloudFormation User Guide.

The values can be represented in either JSON or YAML format. For example, the JSON configuration item format is as follows:

JSON:

"Configuration" : \{ Key : Value \},

Returns:

  • (Hash<String,String>)


325
326
327
328
329
330
331
332
333
334
335
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 325

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

#input_artifactsArray<Types::InputArtifact>

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

Returns:



325
326
327
328
329
330
331
332
333
334
335
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 325

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

#nameString

The action declaration's name.

Returns:

  • (String)


325
326
327
328
329
330
331
332
333
334
335
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 325

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

#output_artifactsArray<Types::OutputArtifact>

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

Returns:



325
326
327
328
329
330
331
332
333
334
335
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 325

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

#regionString

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

Returns:

  • (String)


325
326
327
328
329
330
331
332
333
334
335
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 325

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

#role_arnString

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

Returns:

  • (String)


325
326
327
328
329
330
331
332
333
334
335
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 325

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

#run_orderInteger

The order in which actions are run.

Returns:

  • (Integer)


325
326
327
328
329
330
331
332
333
334
335
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 325

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