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

Inherits:

Struct

• Object
• Struct
• Aws::CodePipeline::Types::RuleDeclaration

Includes:

Structure

Defined in:

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].

[1]: docs.aws.amazon.com/codepipeline/latest/userguide/stage-conditions.html [2]: docs.aws.amazon.com/codepipeline/latest/userguide/concepts-how-it-works-conditions.html [3]: docs.aws.amazon.com/codepipeline/latest/userguide/rule-reference.html

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #commands ⇒ Array<String>

  The shell commands to run with your commands rule in CodePipeline.

• #configuration ⇒ Hash<String,String>

  The action configuration fields for the rule.

• #input_artifacts ⇒ Array<Types::InputArtifact>

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

• #name ⇒ String

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

• #region ⇒ String

  The Region for the condition associated with the rule.

• #role_arn ⇒ String

  The pipeline role ARN associated with the rule.

• #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.

• #timeout_in_minutes ⇒ Integer

  The action timeout for the rule.

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.

<note markdown=“1”> Using compute time for this action will incur separate charges in CodeBuild.

</note>

Returns:

• (Array<String>)

# File 'lib/aws-sdk-codepipeline/types.rb', line 4514

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

# File 'lib/aws-sdk-codepipeline/types.rb', line 4514

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:

• (Array<Types::InputArtifact>)

# File 'lib/aws-sdk-codepipeline/types.rb', line 4514

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)

# File 'lib/aws-sdk-codepipeline/types.rb', line 4514

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)

# File 'lib/aws-sdk-codepipeline/types.rb', line 4514

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)

# File 'lib/aws-sdk-codepipeline/types.rb', line 4514

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:

• (Types::RuleTypeId)

# File 'lib/aws-sdk-codepipeline/types.rb', line 4514

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)

# File 'lib/aws-sdk-codepipeline/types.rb', line 4514

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