Class S3DeployActionProps
Construction properties of the S3DeployAction S3 deploy Action
.
Inheritance
Namespace: Amazon.CDK.AWS.CodePipeline.Actions
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class S3DeployActionProps : Object, IS3DeployActionProps, ICommonAwsActionProps, ICommonActionProps
Syntax (vb)
Public Class S3DeployActionProps
Inherits Object
Implements IS3DeployActionProps, ICommonAwsActionProps, ICommonActionProps
Remarks
ExampleMetadata: infused
Examples
S3SourceAction sourceAction;
Artifact sourceOutput;
Bucket deployBucket;
new Pipeline(this, "Pipeline", new PipelineProps {
Stages = new [] { new StageProps {
StageName = "Source",
Actions = new [] { sourceAction }
}, new StageProps {
StageName = "Deploy",
Actions = new [] {
new S3DeployAction(new S3DeployActionProps {
ActionName = "DeployAction",
// can reference the variables
ObjectKey = $"{sourceAction.variables.versionId}.txt",
Input = sourceOutput,
Bucket = deployBucket
}) }
} }
});
Synopsis
Constructors
S3DeployActionProps() |
Properties
AccessControl | The specified canned ACL to objects deployed to Amazon S3. |
ActionName | The physical, human-readable name of the Action. |
Bucket | The Amazon S3 bucket that is the deploy target. |
CacheControl | The caching behavior for requests/responses for objects in the bucket. |
EncryptionKey | The AWS KMS encryption key for the host bucket. |
Extract | Should the deploy action extract the artifact before deploying to Amazon S3. |
Input | The input Artifact to deploy to Amazon S3. |
ObjectKey | The key of the target object. |
Role | The Role in which context's this Action will be executing in. |
RunOrder | The runOrder property for this Action. |
VariablesNamespace | The name of the namespace to use for variables emitted by this action. |
Constructors
S3DeployActionProps()
public S3DeployActionProps()
Properties
AccessControl
The specified canned ACL to objects deployed to Amazon S3.
public Nullable<BucketAccessControl> AccessControl { get; set; }
Property Value
System.Nullable<BucketAccessControl>
Remarks
This overwrites any existing ACL that was applied to the object.
Default: - the original object ACL
ActionName
The physical, human-readable name of the Action.
public string ActionName { get; set; }
Property Value
System.String
Remarks
Note that Action names must be unique within a single Stage.
Bucket
The Amazon S3 bucket that is the deploy target.
public IBucket Bucket { get; set; }
Property Value
CacheControl
The caching behavior for requests/responses for objects in the bucket.
public CacheControl[] CacheControl { get; set; }
Property Value
Remarks
The final cache control property will be the result of joining all of the provided array elements with a comma (plus a space after the comma).
Default: - none, decided by the HTTP client
EncryptionKey
The AWS KMS encryption key for the host bucket.
public IKey EncryptionKey { get; set; }
Property Value
Remarks
The encryptionKey parameter encrypts uploaded artifacts with the provided AWS KMS key.
Default: - none
Extract
Should the deploy action extract the artifact before deploying to Amazon S3.
public Nullable<bool> Extract { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: true
Input
The input Artifact to deploy to Amazon S3.
public Artifact_ Input { get; set; }
Property Value
ObjectKey
The key of the target object.
public string ObjectKey { get; set; }
Property Value
System.String
Remarks
This is required if extract is false.
Role
The Role in which context's this Action will be executing in.
public IRole Role { get; set; }
Property Value
Remarks
The Pipeline's Role will assume this Role
(the required permissions for that will be granted automatically)
right before executing this Action.
This Action will be passed into your IAction.bind
method in the ActionBindOptions.role
property.
Default: a new Role will be generated
RunOrder
The runOrder property for this Action.
public Nullable<double> RunOrder { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
RunOrder determines the relative order in which multiple Actions in the same Stage execute.
Default: 1
See: https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html
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, if any of the action's variables were referenced - otherwise, no namespace will be set