Struct RuleDeclaration

#[non_exhaustive]
pub struct RuleDeclaration {
    pub name: String,
    pub rule_type_id: Option<RuleTypeId>,
    pub configuration: Option<HashMap<String, String>>,
    pub commands: Option<Vec<String>>,
    pub input_artifacts: Option<Vec<InputArtifact>>,
    pub role_arn: Option<String>,
    pub region: Option<String>,
    pub timeout_in_minutes: Option<i32>,
}

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. For more information about rules, see the CodePipeline rule reference.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

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

rule_type_id: Option<RuleTypeId>

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

configuration: Option<HashMap<String, String>>

The action configuration fields for the rule.

commands: Option<Vec<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.

input_artifacts: Option<Vec<InputArtifact>>

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

role_arn: Option<String>

The pipeline role ARN associated with the rule.

region: Option<String>

The Region for the condition associated with the rule.

timeout_in_minutes: Option<i32>

The action timeout for the rule.

Implementations

impl RuleDeclaration

pub fn name(&self) -> &str

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

pub fn rule_type_id(&self) -> Option<&RuleTypeId>

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

pub fn configuration(&self) -> Option<&HashMap<String, String>>

The action configuration fields for the rule.

pub fn commands(&self) -> &[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .commands.is_none().

pub fn input_artifacts(&self) -> &[InputArtifact]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .input_artifacts.is_none().

pub fn role_arn(&self) -> Option<&str>

The pipeline role ARN associated with the rule.

pub fn region(&self) -> Option<&str>

The Region for the condition associated with the rule.

pub fn timeout_in_minutes(&self) -> Option<i32>

The action timeout for the rule.

impl RuleDeclaration

pub fn builder() -> RuleDeclarationBuilder

Creates a new builder-style object to manufacture RuleDeclaration.

Trait Implementations

impl Clone for RuleDeclaration

fn clone(&self) -> RuleDeclaration

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RuleDeclaration

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for RuleDeclaration

fn eq(&self, other: &RuleDeclaration) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for RuleDeclaration