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

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

Overview

Represents information about an action declaration.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#action_type_id ⇒ Types::ActionTypeId

Specifies the action type and the provider of the action.

Returns:



310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 310

class ActionDeclaration < Struct.new(
  :name,
  :action_type_id,
  :run_order,
  :configuration,
  :commands,
  :output_artifacts,
  :input_artifacts,
  :output_variables,
  :role_arn,
  :region,
  :namespace,
  :timeout_in_minutes)
  SENSITIVE = []
  include Aws::Structure
end

#commands ⇒ Array<String>

The shell commands to run with your compute action in CodePipeline. All commands are supported except multi-line formats. While CodeBuild logs and permissions are used, you do not need to create any resources in CodeBuild.

Using compute time for this action will incur separate charges in CodeBuild.

Returns:

  • (Array<String>) 


310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 310

class ActionDeclaration < Struct.new(
  :name,
  :action_type_id,
  :run_order,
  :configuration,
  :commands,
  :output_artifacts,
  :input_artifacts,
  :output_variables,
  :role_arn,
  :region,
  :namespace,
  :timeout_in_minutes)
  SENSITIVE = []
  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 CloudFormation action type in CodePipeline, see Configuration Properties Reference in the CloudFormation User Guide. For template snippets with examples, see Using Parameter Override Functions with CodePipeline Pipelines in the 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>) 


310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 310

class ActionDeclaration < Struct.new(
  :name,
  :action_type_id,
  :run_order,
  :configuration,
  :commands,
  :output_artifacts,
  :input_artifacts,
  :output_variables,
  :role_arn,
  :region,
  :namespace,
  :timeout_in_minutes)
  SENSITIVE = []
  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:



310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 310

class ActionDeclaration < Struct.new(
  :name,
  :action_type_id,
  :run_order,
  :configuration,
  :commands,
  :output_artifacts,
  :input_artifacts,
  :output_variables,
  :role_arn,
  :region,
  :namespace,
  :timeout_in_minutes)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The action declaration's name.

Returns:

  • (String) 


310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 310

class ActionDeclaration < Struct.new(
  :name,
  :action_type_id,
  :run_order,
  :configuration,
  :commands,
  :output_artifacts,
  :input_artifacts,
  :output_variables,
  :role_arn,
  :region,
  :namespace,
  :timeout_in_minutes)
  SENSITIVE = []
  include Aws::Structure
end

#namespace ⇒ String

The variable namespace associated with the action. All variables produced as output by this action fall under this namespace.

Returns:

  • (String) 


310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 310

class ActionDeclaration < Struct.new(
  :name,
  :action_type_id,
  :run_order,
  :configuration,
  :commands,
  :output_artifacts,
  :input_artifacts,
  :output_variables,
  :role_arn,
  :region,
  :namespace,
  :timeout_in_minutes)
  SENSITIVE = []
  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:



310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 310

class ActionDeclaration < Struct.new(
  :name,
  :action_type_id,
  :run_order,
  :configuration,
  :commands,
  :output_artifacts,
  :input_artifacts,
  :output_variables,
  :role_arn,
  :region,
  :namespace,
  :timeout_in_minutes)
  SENSITIVE = []
  include Aws::Structure
end

#output_variables ⇒ Array<String>

The list of variables that are to be exported from the compute action. This is specifically CodeBuild environment variables as used for that action.

Returns:

  • (Array<String>) 


310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 310

class ActionDeclaration < Struct.new(
  :name,
  :action_type_id,
  :run_order,
  :configuration,
  :commands,
  :output_artifacts,
  :input_artifacts,
  :output_variables,
  :role_arn,
  :region,
  :namespace,
  :timeout_in_minutes)
  SENSITIVE = []
  include Aws::Structure
end

#region ⇒ String

The action declaration's Amazon Web Services Region, such as us-east-1.

Returns:

  • (String) 


310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 310

class ActionDeclaration < Struct.new(
  :name,
  :action_type_id,
  :run_order,
  :configuration,
  :commands,
  :output_artifacts,
  :input_artifacts,
  :output_variables,
  :role_arn,
  :region,
  :namespace,
  :timeout_in_minutes)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

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

Returns:

  • (String) 


310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 310

class ActionDeclaration < Struct.new(
  :name,
  :action_type_id,
  :run_order,
  :configuration,
  :commands,
  :output_artifacts,
  :input_artifacts,
  :output_variables,
  :role_arn,
  :region,
  :namespace,
  :timeout_in_minutes)
  SENSITIVE = []
  include Aws::Structure
end

#run_order ⇒ Integer

The order in which actions are run.

Returns:

  • (Integer) 


310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 310

class ActionDeclaration < Struct.new(
  :name,
  :action_type_id,
  :run_order,
  :configuration,
  :commands,
  :output_artifacts,
  :input_artifacts,
  :output_variables,
  :role_arn,
  :region,
  :namespace,
  :timeout_in_minutes)
  SENSITIVE = []
  include Aws::Structure
end

#timeout_in_minutes ⇒ Integer

A timeout duration in minutes that can be applied against the ActionType’s default timeout value specified in Quotas for CodePipeline . This attribute is available only to the manual approval ActionType.

Returns:

  • (Integer) 


310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 310

class ActionDeclaration < Struct.new(
  :name,
  :action_type_id,
  :run_order,
  :configuration,
  :commands,
  :output_artifacts,
  :input_artifacts,
  :output_variables,
  :role_arn,
  :region,
  :namespace,
  :timeout_in_minutes)
  SENSITIVE = []
  include Aws::Structure
end