S3DeployActionProps

class aws_cdk.aws_codepipeline_actions.S3DeployActionProps(*, action_name, run_order=None, variables_namespace=None, role=None, bucket, input, access_control=None, cache_control=None, encryption_key=None, extract=None, object_key=None)

Bases: CommonAwsActionProps

Construction properties of the S3DeployAction S3 deploy Action.

Parameters:

action_name (str) – The physical, human-readable name of the Action. Note that Action names must be unique within a single Stage.
run_order (Union[int, float, None]) – The runOrder property for this Action. RunOrder determines the relative order in which multiple Actions in the same Stage execute. Default: 1
variables_namespace (Optional[str]) – The name of the namespace to use for variables emitted by this action. 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
role (Optional[IRole]) – 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. Default: a new Role will be generated
bucket (IBucket) – The Amazon S3 bucket that is the deploy target.
input (Artifact) – The input Artifact to deploy to Amazon S3.
access_control (Optional[BucketAccessControl]) – The specified canned ACL to objects deployed to Amazon S3. This overwrites any existing ACL that was applied to the object. Default: - the original object ACL
cache_control (Optional[Sequence[CacheControl]]) – 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). Default: - none, decided by the HTTP client
encryption_key (Optional[IKey]) – The AWS KMS encryption key for the host bucket. The encryptionKey parameter encrypts uploaded artifacts with the provided AWS KMS key. Default: - none
extract (Optional[bool]) – Should the deploy action extract the artifact before deploying to Amazon S3. Default: true
object_key (Optional[str]) – The key of the target object. This is required if extract is false.

ExampleMetadata:

infused

Example:

# source_action: codepipeline_actions.S3SourceAction
# source_output: codepipeline.Artifact
# deploy_bucket: s3.Bucket


codepipeline.Pipeline(self, "Pipeline",
    stages=[codepipeline.StageProps(
        stage_name="Source",
        actions=[source_action]
    ), codepipeline.StageProps(
        stage_name="Deploy",
        actions=[
            codepipeline_actions.S3DeployAction(
                action_name="DeployAction",
                # can reference the variables
                object_key=f"{sourceAction.variables.versionId}.txt",
                input=source_output,
                bucket=deploy_bucket
            )
        ]
    )
    ]
)

Attributes

access_control

The specified canned ACL to objects deployed to Amazon S3.

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

Default:

the original object ACL

action_name

The physical, human-readable name of the Action.

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

bucket: The Amazon S3 bucket that is the deploy target.

cache_control

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

Default:

none, decided by the HTTP client

encryption_key

The AWS KMS encryption key for the host bucket.

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.

Default:: true

input: The input Artifact to deploy to Amazon S3.

object_key

The key of the target object.

This is required if extract is false.

role

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.

Default:: a new Role will be generated

run_order

The runOrder property for this Action.

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

variables_namespace

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

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