Class: Aws::CodePipeline::Types::RuleDeclaration

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

Overview

Represents information about the rule to be created for an associated condition. An example would be creating a new rule for an entry condition, such as a rule that checks for a test result before allowing the run to enter the deployment stage. For more information about conditions, see Stage conditions and How do stage conditions work?. For more information about rules, see the CodePipeline rule reference.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#commands ⇒ Array<String>

The shell commands to run with your commands rule 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>) 


4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 4496

class RuleDeclaration < Struct.new(
  :name,
  :rule_type_id,
  :configuration,
  :commands,
  :input_artifacts,
  :role_arn,
  :region,
  :timeout_in_minutes)
  SENSITIVE = []
  include Aws::Structure
end

#configuration ⇒ Hash<String,String>

The action configuration fields for the rule.

Returns:

  • (Hash<String,String>) 


4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 4496

class RuleDeclaration < Struct.new(
  :name,
  :rule_type_id,
  :configuration,
  :commands,
  :input_artifacts,
  :role_arn,
  :region,
  :timeout_in_minutes)
  SENSITIVE = []
  include Aws::Structure
end

#input_artifacts ⇒ Array<Types::InputArtifact>

The input artifacts fields for the rule, such as specifying an input file for the rule.

Returns:



4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 4496

class RuleDeclaration < Struct.new(
  :name,
  :rule_type_id,
  :configuration,
  :commands,
  :input_artifacts,
  :role_arn,
  :region,
  :timeout_in_minutes)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the rule that is created for the condition, such as VariableCheck.

Returns:

  • (String) 


4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 4496

class RuleDeclaration < Struct.new(
  :name,
  :rule_type_id,
  :configuration,
  :commands,
  :input_artifacts,
  :role_arn,
  :region,
  :timeout_in_minutes)
  SENSITIVE = []
  include Aws::Structure
end

#region ⇒ String

The Region for the condition associated with the rule.

Returns:

  • (String) 


4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 4496

class RuleDeclaration < Struct.new(
  :name,
  :rule_type_id,
  :configuration,
  :commands,
  :input_artifacts,
  :role_arn,
  :region,
  :timeout_in_minutes)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

The pipeline role ARN associated with the rule.

Returns:

  • (String) 


4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 4496

class RuleDeclaration < Struct.new(
  :name,
  :rule_type_id,
  :configuration,
  :commands,
  :input_artifacts,
  :role_arn,
  :region,
  :timeout_in_minutes)
  SENSITIVE = []
  include Aws::Structure
end

#rule_type_id ⇒ Types::RuleTypeId

The ID for the rule type, which is made up of the combined values for category, owner, provider, and version.

Returns:



4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 4496

class RuleDeclaration < Struct.new(
  :name,
  :rule_type_id,
  :configuration,
  :commands,
  :input_artifacts,
  :role_arn,
  :region,
  :timeout_in_minutes)
  SENSITIVE = []
  include Aws::Structure
end

#timeout_in_minutes ⇒ Integer

The action timeout for the rule.

Returns:

  • (Integer) 


4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 4496

class RuleDeclaration < Struct.new(
  :name,
  :rule_type_id,
  :configuration,
  :commands,
  :input_artifacts,
  :role_arn,
  :region,
  :timeout_in_minutes)
  SENSITIVE = []
  include Aws::Structure
end