ActionProperties
- class aws_cdk.aws_codepipeline.ActionProperties(*, action_name, artifact_bounds, category, provider, account=None, inputs=None, outputs=None, owner=None, region=None, resource=None, role=None, run_order=None, variables_namespace=None, version=None)
Bases:
object
- Parameters:
action_name (
str
)artifact_bounds (
Union
[ActionArtifactBounds
,Dict
[str
,Any
]])category (
ActionCategory
) – The category of the action. The category defines which action type the owner (the entity that performs the action) performs.provider (
str
) – The service provider that the action calls.account (
Optional
[str
]) – The account the Action is supposed to live in. For Actions backed by resources, this is inferred from the Stackresource
is part of. However, some Actions, like the CloudFormation ones, are not backed by any resource, and they still might want to be cross-account. In general, a concrete Action class should specify eitherresource
, oraccount
- but not both.inputs (
Optional
[Sequence
[Artifact
]])outputs (
Optional
[Sequence
[Artifact
]])owner (
Optional
[str
])region (
Optional
[str
]) – The AWS region the given Action resides in. Note that a cross-region Pipeline requires replication buckets to function correctly. You can provide their names with thePipelineProps#crossRegionReplicationBuckets
property. If you don’t, the CodePipeline Construct will create new Stacks in your CDK app containing those buckets, that you will need tocdk deploy
before deploying the main, Pipeline-containing Stack. Default: the Action resides in the same region as the Pipelineresource (
Optional
[IResource
]) – The optional resource that is backing this Action. This is used for automatically handling Actions backed by resources from a different account and/or region.role (
Optional
[IRole
])run_order (
Union
[int
,float
,None
]) – The order in which AWS CodePipeline runs this action. For more information, see the AWS CodePipeline User Guide. https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#action-requirementsvariables_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 namesversion (
Optional
[str
])
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk as cdk from aws_cdk import aws_codepipeline as codepipeline from aws_cdk import aws_iam as iam # artifact: codepipeline.Artifact # resource: cdk.Resource # role: iam.Role action_properties = codepipeline.ActionProperties( action_name="actionName", artifact_bounds=codepipeline.ActionArtifactBounds( max_inputs=123, max_outputs=123, min_inputs=123, min_outputs=123 ), category=codepipeline.ActionCategory.SOURCE, provider="provider", # the properties below are optional account="account", inputs=[artifact], outputs=[artifact], owner="owner", region="region", resource=resource, role=role, run_order=123, variables_namespace="variablesNamespace", version="version" )
Attributes
- account
The account the Action is supposed to live in.
For Actions backed by resources, this is inferred from the Stack
resource
is part of. However, some Actions, like the CloudFormation ones, are not backed by any resource, and they still might want to be cross-account. In general, a concrete Action class should specify eitherresource
, oraccount
- but not both.
- action_name
- artifact_bounds
- category
The category of the action.
The category defines which action type the owner (the entity that performs the action) performs.
- inputs
- outputs
- owner
- provider
The service provider that the action calls.
- region
The AWS region the given Action resides in.
Note that a cross-region Pipeline requires replication buckets to function correctly. You can provide their names with the
PipelineProps#crossRegionReplicationBuckets
property. If you don’t, the CodePipeline Construct will create new Stacks in your CDK app containing those buckets, that you will need tocdk deploy
before deploying the main, Pipeline-containing Stack.- Default:
the Action resides in the same region as the Pipeline
- resource
The optional resource that is backing this Action.
This is used for automatically handling Actions backed by resources from a different account and/or region.
- role
- run_order
The order in which AWS CodePipeline runs this action. For more information, see the AWS CodePipeline User Guide.
- 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
- version