Interface CfnPipeline.IActionDeclarationProperty

Represents information about an action declaration.

Namespace: Amazon.CDK.AWS.CodePipeline

Assembly: Amazon.CDK.AWS.CodePipeline.dll

Syntax (csharp)

public interface IActionDeclarationProperty

Syntax (vb)

Public Interface IActionDeclarationProperty

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.CodePipeline;

var configuration;

ActionDeclarationProperty actionDeclarationProperty = new ActionDeclarationProperty {
    ActionTypeId = new ActionTypeIdProperty {
        Category = "category",
        Owner = "owner",
        Provider = "provider",
        Version = "version"
    },
    Name = "name",

    // the properties below are optional
    Configuration = configuration,
    InputArtifacts = new [] { new InputArtifactProperty {
        Name = "name"
    } },
    Namespace = "namespace",
    OutputArtifacts = new [] { new OutputArtifactProperty {
        Name = "name"
    } },
    Region = "region",
    RoleArn = "roleArn",
    RunOrder = 123
};

Synopsis

Properties

ActionTypeId	Specifies the action type and the provider of the action.
Configuration	The action's configuration.
InputArtifacts	The name or ID of the artifact consumed by the action, such as a test or build artifact.
Name	The action declaration's name.
Namespace	The variable namespace associated with the action.
OutputArtifacts	The name or ID of the result of the action declaration, such as a test or build artifact.
Region	The action declaration's AWS Region, such as us-east-1.
RoleArn	The ARN of the IAM service role that performs the declared action.
RunOrder	The order in which actions are run.

Properties

ActionTypeId

Specifies the action type and the provider of the action.

object ActionTypeId { get; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions.html#cfn-codepipeline-pipeline-stages-actions-actiontypeid

Configuration

The action's configuration.

virtual object Configuration { get; }

Property Value

System.Object

Remarks

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 AWS CloudFormation action type in CodePipeline, see Configuration Properties Reference in the AWS CloudFormation User Guide . For template snippets with examples, see Using Parameter Override Functions with CodePipeline Pipelines in the AWS 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 },

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions.html#cfn-codepipeline-pipeline-stages-actions-configuration

InputArtifacts

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

virtual object InputArtifacts { get; }

Property Value

System.Object

Remarks

For a CodeBuild action with multiple input artifacts, one of your input sources must be designated the PrimarySource. For more information, see the CodeBuild action reference page in the AWS CodePipeline User Guide .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions.html#cfn-codepipeline-pipeline-stages-actions-inputartifacts

Name

The action declaration's name.

string Name { get; }

Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions.html#cfn-codepipeline-pipeline-stages-actions-name

Namespace

The variable namespace associated with the action.

virtual string Namespace { get; }

Property Value

System.String

Remarks

All variables produced as output by this action fall under this namespace.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions.html#cfn-codepipeline-pipeline-actiondeclaration-namespace

OutputArtifacts

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

virtual object OutputArtifacts { get; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions.html#cfn-codepipeline-pipeline-stages-actions-outputartifacts

Region

The action declaration's AWS Region, such as us-east-1.

virtual string Region { get; }

Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions.html#cfn-codepipeline-pipeline-stages-actions-region

RoleArn

The ARN of the IAM service role that performs the declared action.

virtual string RoleArn { get; }

Property Value

System.String

Remarks

This is assumed through the roleArn for the pipeline.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions.html#cfn-codepipeline-pipeline-stages-actions-rolearn

RunOrder

The order in which actions are run.

virtual Nullable<double> RunOrder { get; }

Property Value

System.Nullable<System.Double>

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions.html#cfn-codepipeline-pipeline-stages-actions-runorder