Interface IS3DeployActionProps
Construction properties of the S3DeployAction S3 deploy Action
.
Inherited Members
Namespace: Amazon.CDK.AWS.CodePipeline.Actions
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IS3DeployActionProps : ICommonAwsActionProps, ICommonActionProps
Syntax (vb)
Public Interface IS3DeployActionProps
Inherits 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
Properties
AccessControl | The specified canned ACL to objects deployed to Amazon S3. |
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. |
Properties
AccessControl
The specified canned ACL to objects deployed to Amazon S3.
virtual Nullable<BucketAccessControl> AccessControl { get; }
Property Value
System.Nullable<BucketAccessControl>
Remarks
This overwrites any existing ACL that was applied to the object.
Default: - the original object ACL
Bucket
CacheControl
The caching behavior for requests/responses for objects in the bucket.
virtual CacheControl[] CacheControl { get; }
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.
virtual IKey EncryptionKey { get; }
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.
virtual Nullable<bool> Extract { get; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: true
Input
ObjectKey
The key of the target object.
virtual string ObjectKey { get; }
Property Value
System.String
Remarks
This is required if extract is false.