aws-cdk-lib.aws_codepipeline_actions.S3DeployActionProps

interface S3DeployActionProps

LanguageType name
.NETAmazon.CDK.AWS.CodePipeline.Actions.S3DeployActionProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awscodepipelineactions#S3DeployActionProps
Javasoftware.amazon.awscdk.services.codepipeline.actions.S3DeployActionProps
Pythonaws_cdk.aws_codepipeline_actions.S3DeployActionProps
TypeScript (source)aws-cdk-lib » aws_codepipeline_actions » S3DeployActionProps

Construction properties of the S3DeployAction S3 deploy Action.

Example

const sourceOutput = new codepipeline.Artifact();
const targetBucket = new s3.Bucket(this, 'MyBucket');
const key: kms.IKey = new kms.Key(stack, 'EnvVarEncryptKey', {
  description: 'sample key',
});

const pipeline = new codepipeline.Pipeline(this, 'MyPipeline');
const deployAction = new codepipeline_actions.S3DeployAction({
  actionName: 'S3Deploy',
  bucket: targetBucket,
  input: sourceOutput,
  encryptionKey: key,
});
const deployStage = pipeline.addStage({
  stageName: 'Deploy',
  actions: [deployAction],
});

Properties

NameTypeDescription
actionNamestringThe physical, human-readable name of the Action.
bucketIBucketThe Amazon S3 bucket that is the deploy target.
inputArtifactThe input Artifact to deploy to Amazon S3.
accessControl?BucketAccessControlThe specified canned ACL to objects deployed to Amazon S3.
cacheControl?CacheControl[]The caching behavior for requests/responses for objects in the bucket.
encryptionKey?IKeyThe AWS KMS encryption key for the host bucket.
extract?booleanShould the deploy action extract the artifact before deploying to Amazon S3.
objectKey?stringThe key of the target object.
role?IRoleThe Role in which context's this Action will be executing in.
runOrder?numberThe runOrder property for this Action.
variablesNamespace?stringThe name of the namespace to use for variables emitted by this action.

actionName

Type: string

The physical, human-readable name of the Action.

Note that Action names must be unique within a single Stage.


bucket

Type: IBucket

The Amazon S3 bucket that is the deploy target.


input

Type: Artifact

The input Artifact to deploy to Amazon S3.


accessControl?

Type: BucketAccessControl (optional, default: the original object ACL)

The specified canned ACL to objects deployed to Amazon S3.

This overwrites any existing ACL that was applied to the object.


cacheControl?

Type: CacheControl[] (optional, default: none, decided by the HTTP client)

The caching behavior for requests/responses for objects in the bucket.

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).


encryptionKey?

Type: IKey (optional, default: none)

The AWS KMS encryption key for the host bucket.

The encryptionKey parameter encrypts uploaded artifacts with the provided AWS KMS key.


extract?

Type: boolean (optional, default: true)

Should the deploy action extract the artifact before deploying to Amazon S3.


objectKey?

Type: string (optional)

The key of the target object.

This is required if extract is false.


role?

Type: IRole (optional, default: a new Role will be generated)

The Role in which context's this Action will be executing in.

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.


runOrder?

Type: number (optional, default: 1)

The runOrder property for this Action.

RunOrder determines the relative order in which multiple Actions in the same Stage execute.

See also: https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html


variablesNamespace?

Type: string (optional, 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)

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