S3SourceActionProps

class aws_cdk.aws_codepipeline_actions.S3SourceActionProps(*, action_name, run_order=None, variables_namespace=None, role=None, bucket, bucket_key, output, trigger=None)

Bases: aws_cdk.aws_codepipeline.CommonAwsActionProps

Construction properties of the {@link S3SourceAction S3 source 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 {@link IAction.bind} method in the {@link ActionBindOptions.role} property. Default: a new Role will be generated

  • bucket (IBucket) – The Amazon S3 bucket that stores the source code.

  • bucket_key (str) – The key within the S3 bucket that stores the source code.

  • output (Artifact) –

  • trigger (Optional[S3Trigger]) – How should CodePipeline detect source changes for this Action. Note that if this is S3Trigger.EVENTS, you need to make sure to include the source Bucket in a CloudTrail Trail, as otherwise the CloudWatch Events will not be emitted. Default: S3Trigger.POLL

Attributes

action_name

The physical, human-readable name of the Action.

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

Return type

str

bucket

The Amazon S3 bucket that stores the source code.

Return type

IBucket

bucket_key

The key within the S3 bucket that stores the source code.

Example:

# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
"path/to/file.zip"
Return type

str

output
Return type

Artifact

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 {@link IAction.bind} method in the {@link ActionBindOptions.role} property.

Default

a new Role will be generated

Return type

Optional[IRole]

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

Return type

Union[int, float, None]

trigger

How should CodePipeline detect source changes for this Action.

Note that if this is S3Trigger.EVENTS, you need to make sure to include the source Bucket in a CloudTrail Trail, as otherwise the CloudWatch Events will not be emitted.

Default

S3Trigger.POLL

See

https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/log-s3-data-events.html

Return type

Optional[S3Trigger]

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

Return type

Optional[str]