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, extract=None, object_key=None)¶ Bases:
aws_cdk.aws_codepipeline.CommonAwsActionProps
Construction properties of the {@link 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: 1variables_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 setrole (
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 generatedbucket (
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 ACLcache_control (
Optional
[List
[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 clientextract (
Optional
[bool
]) – Should the deploy action extract the artifact before deploying to Amazon S3. Default: trueobject_key (
Optional
[str
]) – The key of the target object. This is required if extract is false.
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
- Return type
Optional
[BucketAccessControl
]
-
action_name
¶ The physical, human-readable name of the Action.
Note that Action names must be unique within a single Stage.
- Return type
str
-
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
- Return type
Optional
[List
[CacheControl
]]
-
extract
¶ Should the deploy action extract the artifact before deploying to Amazon S3.
- Default
true
- Return type
Optional
[bool
]
-
object_key
¶ The key of the target object.
This is required if extract is false.
- Return type
Optional
[str
]
-
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
]
-
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
]