S3DeployAction

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

Bases: Action

Deploys the sourceArtifact to Amazon S3.

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
            )
        ]
    )
    ]
)
Parameters:

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

  • 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

  • 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

Methods

bind(scope, stage, *, bucket, role)

The callback invoked when this Action is added to a Pipeline.

Parameters:
Return type:

ActionConfig

on_state_change(name, target=None, *, enabled=None, event_bus=None, schedule=None, targets=None, cross_stack_scope=None, description=None, event_pattern=None, rule_name=None)

Creates an Event that will be triggered whenever the state of this Action changes.

Parameters:

  • name (str) –

  • target (Optional[IRuleTarget]) –

  • enabled (Optional[bool]) – Indicates whether the rule is enabled. Default: true

  • event_bus (Optional[IEventBus]) – The event bus to associate with this rule. Default: - The default event bus.

  • schedule (Optional[Schedule]) – The schedule or rate (frequency) that determines when EventBridge runs the rule. You must specify this property, the eventPattern property, or both. For more information, see Schedule Expression Syntax for Rules in the Amazon EventBridge User Guide. Default: - None.

  • targets (Optional[Sequence[IRuleTarget]]) – Targets to invoke when this rule matches an event. Input will be the full matched event. If you wish to specify custom target input, use addTarget(target[, inputOptions]). Default: - No targets.

  • cross_stack_scope (Optional[Construct]) – The scope to use if the source of the rule and its target are in different Stacks (but in the same account & region). This helps dealing with cycles that often arise in these situations. Default: - none (the main scope will be used, even for cross-stack Events)

  • description (Optional[str]) – A description of the rule’s purpose. Default: - No description

  • event_pattern (Union[EventPattern, Dict[str, Any], None]) – Additional restrictions for the event to route to the specified target. The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. Default: - No additional filtering based on an event pattern.

  • rule_name (Optional[str]) – A name for the rule. Default: AWS CloudFormation generates a unique physical ID.

Return type:

Rule

Attributes

action_properties

The simple properties of the Action, like its Owner, name, etc.

Note that this accessor will be called before the bind callback.