Struct ActionDeclaration

#[non_exhaustive]
pub struct ActionDeclaration {
    pub name: String,
    pub action_type_id: Option<ActionTypeId>,
    pub run_order: Option<i32>,
    pub configuration: Option<HashMap<String, String>>,
    pub commands: Option<Vec<String>>,
    pub output_artifacts: Option<Vec<OutputArtifact>>,
    pub input_artifacts: Option<Vec<InputArtifact>>,
    pub output_variables: Option<Vec<String>>,
    pub role_arn: Option<String>,
    pub region: Option<String>,
    pub namespace: Option<String>,
    pub timeout_in_minutes: Option<i32>,
}

Represents information about an action declaration.

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 action declaration's name.

action_type_id: Option<ActionTypeId>

Specifies the action type and the provider of the action.

run_order: Option<i32>

The order in which actions are run.

configuration: Option<HashMap<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 },

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

output_artifacts: Option<Vec<OutputArtifact>>

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

input_artifacts: Option<Vec<InputArtifact>>

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

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

role_arn: Option<String>

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

region: Option<String>

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

namespace: Option<String>

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

timeout_in_minutes: Option<i32>

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.

Implementations

impl ActionDeclaration

pub fn name(&self) -> &str

The action declaration's name.

pub fn action_type_id(&self) -> Option<&ActionTypeId>

Specifies the action type and the provider of the action.

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

The order in which actions are run.

pub fn configuration(&self) -> Option<&HashMap<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 },

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

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 output_artifacts(&self) -> &[OutputArtifact]

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

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

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

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

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 output_variables(&self) -> &[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.

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

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

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

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

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

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

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

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

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.

impl ActionDeclaration

pub fn builder() -> ActionDeclarationBuilder

Creates a new builder-style object to manufacture ActionDeclaration.

Trait Implementations

impl Clone for ActionDeclaration

fn clone(&self) -> ActionDeclaration

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ActionDeclaration

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

Formats the value using the given formatter.

impl PartialEq for ActionDeclaration

fn eq(&self, other: &ActionDeclaration) -> 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 ActionDeclaration