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
• Struct
• Aws::CodePipeline::Types::ActionDeclaration

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:

• AWS API Documentation

Instance Attribute Summary

• #action_type_id ⇒ Types::ActionTypeId

  Specifies the action type and the provider of the action.

• #configuration ⇒ Hash<String,String>

  The action's configuration.

• #input_artifacts ⇒ Array<Types::InputArtifact>

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

• #name ⇒ String

  The action declaration's name.

• #output_artifacts ⇒ Array<Types::OutputArtifact>

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

• #region ⇒ String

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

• #role_arn ⇒ String

  The ARN of the IAM service role that will perform the declared action.

• #run_order ⇒ Integer

  The order in which actions are run.

Instance Attribute Details

#action_type_id ⇒ Types::ActionTypeId

Specifies the action type and the provider of the action.

Returns:

• (Types::ActionTypeId)

# 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

#configuration ⇒ Hash<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>)

# 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_artifacts ⇒ Array<Types::InputArtifact>

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

Returns:

• (Array<Types::InputArtifact>)

# 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

#name ⇒ String

The action declaration's name.

Returns:

• (String)

# 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_artifacts ⇒ Array<Types::OutputArtifact>

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

Returns:

• (Array<Types::OutputArtifact>)

# 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

#region ⇒ String

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

Returns:

• (String)

# 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_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)

# 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_order ⇒ Integer

The order in which actions are run.

Returns:

• (Integer)

# 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