interface S3DeployActionProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.CodePipeline.Actions.S3DeployActionProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awscodepipelineactions#S3DeployActionProps |
![]() | software.amazon.awscdk.services.codepipeline.actions.S3DeployActionProps |
![]() | aws_cdk.aws_codepipeline_actions.S3DeployActionProps |
![]() | aws-cdk-lib » aws_codepipeline_actions » S3DeployActionProps |
Construction properties of the S3DeployAction S3 deploy Action
.
Example
declare const sourceArtifact: codepipeline.Artifact;
declare const outputArtifact: codepipeline.Artifact;
const commandsAction = new codepipeline_actions.CommandsAction({
actionName: 'Commands',
commands: [
'export MY_OUTPUT=my-key',
],
input: sourceArtifact,
output: outputArtifact,
outputVariables: ['MY_OUTPUT', 'CODEBUILD_BUILD_ID'], // CODEBUILD_BUILD_ID is a variable defined by CodeBuild
});
// Deploy action
const deployAction = new codepipeline_actions.S3DeployAction({
actionName: 'DeployAction',
extract: true,
input: outputArtifact,
bucket: new s3.Bucket(this, 'DeployBucket'),
objectKey: commandsAction.variable('MY_OUTPUT'), // the variable emitted by the Commands action
});
Properties
Name | Type | Description |
---|---|---|
action | string | The physical, human-readable name of the Action. |
bucket | IBucket | The Amazon S3 bucket that is the deploy target. |
input | Artifact | The input Artifact to deploy to Amazon S3. |
access | Bucket | The specified canned ACL to objects deployed to Amazon S3. |
cache | Cache [] | The caching behavior for requests/responses for objects in the bucket. |
encryption | IKey | The AWS KMS encryption key for the host bucket. |
extract? | boolean | Should the deploy action extract the artifact before deploying to Amazon S3. |
object | string | The key of the target object. |
role? | IRole | The Role in which context's this Action will be executing in. |
run | number | The runOrder property for this Action. |
variables | string | The 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:
Bucket
(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:
Cache
[]
(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.
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.