Class ActionProperties
Inheritance
Implements
Namespace: Amazon.CDK.AWS.CodePipeline
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class ActionProperties : Object, IActionProperties
Syntax (vb)
Public Class ActionProperties
Inherits Object
Implements 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;
using Amazon.CDK.AWS.CodePipeline;
using Amazon.CDK.AWS.IAM;
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
Constructors
ActionProperties() |
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 |
Constructors
ActionProperties()
public ActionProperties()
Properties
Account
The account the Action is supposed to live in.
public string Account { get; set; }
Property Value
System.String
Remarks
For Actions backed by resources,
this is inferred from the Stack 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 resource
,
or account
- but not both.
ActionName
public string ActionName { get; set; }
Property Value
System.String
ArtifactBounds
Category
The category of the action.
public ActionCategory Category { get; set; }
Property Value
Remarks
The category defines which action type the owner (the entity that performs the action) performs.
Inputs
Outputs
Owner
public string Owner { get; set; }
Property Value
System.String
Provider
The service provider that the action calls.
public string Provider { get; set; }
Property Value
System.String
Region
The AWS region the given Action resides in.
public string Region { get; set; }
Property Value
System.String
Remarks
Note that a cross-region Pipeline requires replication buckets to function correctly.
You can provide their names with the 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.
public IResource Resource { get; set; }
Property Value
Remarks
This is used for automatically handling Actions backed by resources from a different account and/or region.
Role
RunOrder
The order in which AWS CodePipeline runs this action. For more information, see the AWS CodePipeline User Guide.
public Nullable<double> RunOrder { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
VariablesNamespace
The name of the namespace to use for variables emitted by this action.
public string VariablesNamespace { get; set; }
Property Value
System.String
Remarks
Default: - a name will be generated, based on the stage and action names
Version
public string Version { get; set; }
Property Value
System.String