Interface IActionProperties

Namespace: Amazon.CDK.AWS.CodePipeline

Assembly: Amazon.CDK.AWS.CodePipeline.dll

Syntax (csharp)

public interface IActionProperties

Syntax (vb)

Public Interface IActionProperties

Remarks

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;
using Amazon.CDK.AWS.IAM;
using Amazon.CDK;

Artifact artifact;
Resource resource;
Role role;
var actionProperties = new ActionProperties {
    ActionName = "actionName",
    ArtifactBounds = new ActionArtifactBounds {
        MaxInputs = 123,
        MaxOutputs = 123,
        MinInputs = 123,
        MinOutputs = 123
    },
    Category = ActionCategory.SOURCE,
    Provider = "provider",

    // the properties below are optional
    Account = "account",
    Inputs = new [] { artifact },
    Outputs = new [] { artifact },
    Owner = "owner",
    Region = "region",
    Resource = resource,
    Role = role,
    RunOrder = 123,
    VariablesNamespace = "variablesNamespace",
    Version = "version"
};

Synopsis

Properties

Account	The account the Action is supposed to live in.
ActionName
ArtifactBounds
Category	The category of the action.
Inputs
Outputs
Owner
Provider	The service provider that the action calls.
Region	The AWS region the given Action resides in.
Resource	The optional resource that is backing this Action.
Role
RunOrder	The order in which AWS CodePipeline runs this action. For more information, see the AWS CodePipeline User Guide.
VariablesNamespace	The name of the namespace to use for variables emitted by this action.
Version

Properties

Account

The account the Action is supposed to live in.

virtual string Account { get; }

Property Value

System.String

Remarks

For Actions backed by resources, this is inferred from the Stack {@link resource} is part of. However, some Actions, like the CloudFormation ones, are not backed by any resource, and they still might want to be cross-account. In general, a concrete Action class should specify either {@link resource}, or {@link account} - but not both.

ActionName

string ActionName { get; }

Property Value

System.String

ArtifactBounds

IActionArtifactBounds ArtifactBounds { get; }

Property Value

IActionArtifactBounds

Inputs

virtual Artifact_[] Inputs { get; }

Property Value

Artifact_[]

Outputs

virtual Artifact_[] Outputs { get; }

Property Value

Artifact_[]

Owner

virtual string Owner { get; }

Property Value

System.String

Provider

The service provider that the action calls.

string Provider { get; }

Property Value

System.String

Region

The AWS region the given Action resides in.

virtual string Region { get; }

Property Value

System.String

Remarks

Note that a cross-region Pipeline requires replication buckets to function correctly. You can provide their names with the {@link PipelineProps#crossRegionReplicationBuckets} property. If you don't, the CodePipeline Construct will create new Stacks in your CDK app containing those buckets, that you will need to cdk deploy before deploying the main, Pipeline-containing Stack.

Default: the Action resides in the same region as the Pipeline

Resource

The optional resource that is backing this Action.

virtual IResource Resource { get; }

Property Value

IResource

Remarks

This is used for automatically handling Actions backed by resources from a different account and/or region.

Role

virtual IRole Role { get; }

Property Value

IRole

RunOrder

The order in which AWS CodePipeline runs this action. For more information, see the AWS CodePipeline User Guide.

virtual Nullable<double> RunOrder { get; }

Property Value

System.Nullable<System.Double>

Remarks

https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#action-requirements

VariablesNamespace

The name of the namespace to use for variables emitted by this action.

virtual string VariablesNamespace { get; }

Property Value

System.String

Remarks

Default: - a name will be generated, based on the stage and action names

Version

virtual string Version { get; }

Property Value

System.String