CfnPipeline
- class aws_cdk.aws_codepipeline.CfnPipeline(scope, id, *, role_arn, stages, artifact_store=None, artifact_stores=None, disable_inbound_stage_transitions=None, name=None, restart_execution_on_update=None, tags=None)
Bases:
CfnResourceA CloudFormation
AWS::CodePipeline::Pipeline.The
AWS::CodePipeline::Pipelineresource creates a CodePipeline pipeline that describes how software changes go through a release process. For more information, see What Is CodePipeline? in the AWS CodePipeline User Guide .- CloudformationResource:
AWS::CodePipeline::Pipeline
- Link:
- 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.aws_codepipeline as codepipeline # configuration: Any cfn_pipeline = codepipeline.CfnPipeline(self, "MyCfnPipeline", role_arn="roleArn", stages=[codepipeline.CfnPipeline.StageDeclarationProperty( actions=[codepipeline.CfnPipeline.ActionDeclarationProperty( action_type_id=codepipeline.CfnPipeline.ActionTypeIdProperty( category="category", owner="owner", provider="provider", version="version" ), name="name", # the properties below are optional configuration=configuration, input_artifacts=[codepipeline.CfnPipeline.InputArtifactProperty( name="name" )], namespace="namespace", output_artifacts=[codepipeline.CfnPipeline.OutputArtifactProperty( name="name" )], region="region", role_arn="roleArn", run_order=123 )], name="name", # the properties below are optional blockers=[codepipeline.CfnPipeline.BlockerDeclarationProperty( name="name", type="type" )] )], # the properties below are optional artifact_store=codepipeline.CfnPipeline.ArtifactStoreProperty( location="location", type="type", # the properties below are optional encryption_key=codepipeline.CfnPipeline.EncryptionKeyProperty( id="id", type="type" ) ), artifact_stores=[codepipeline.CfnPipeline.ArtifactStoreMapProperty( artifact_store=codepipeline.CfnPipeline.ArtifactStoreProperty( location="location", type="type", # the properties below are optional encryption_key=codepipeline.CfnPipeline.EncryptionKeyProperty( id="id", type="type" ) ), region="region" )], disable_inbound_stage_transitions=[codepipeline.CfnPipeline.StageTransitionProperty( reason="reason", stage_name="stageName" )], name="name", restart_execution_on_update=False, tags=[CfnTag( key="key", value="value" )] )
Create a new
AWS::CodePipeline::Pipeline.- Parameters:
scope (
Construct) –scope in which this resource is defined.
id (
str) –scoped id of the resource.
role_arn (
str) – The Amazon Resource Name (ARN) for CodePipeline to use to either perform actions with noactionRoleArn, or to use to assume roles for actions with anactionRoleArn.stages (
Union[IResolvable,Sequence[Union[IResolvable,StageDeclarationProperty,Dict[str,Any]]]]) – Represents information about a stage and its definition.artifact_store (
Union[IResolvable,ArtifactStoreProperty,Dict[str,Any],None]) – The S3 bucket where artifacts for the pipeline are stored. .. epigraph:: You must include eitherartifactStoreorartifactStoresin your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must useartifactStores.artifact_stores (
Union[IResolvable,Sequence[Union[IResolvable,ArtifactStoreMapProperty,Dict[str,Any]]],None]) – A mapping ofartifactStoreobjects and their corresponding AWS Regions. There must be an artifact store for the pipeline Region and for each cross-region action in the pipeline. .. epigraph:: You must include eitherartifactStoreorartifactStoresin your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must useartifactStores.disable_inbound_stage_transitions (
Union[IResolvable,Sequence[Union[IResolvable,StageTransitionProperty,Dict[str,Any]]],None]) – Represents the input of aDisableStageTransitionaction.name (
Optional[str]) – The name of the pipeline.restart_execution_on_update (
Union[bool,IResolvable,None]) – Indicates whether to rerun the CodePipeline pipeline after you update it.tags (
Optional[Sequence[Union[CfnTag,Dict[str,Any]]]]) – Specifies the tags applied to the pipeline.
Methods
- add_deletion_override(path)
Syntactic sugar for
addOverride(path, undefined).- Parameters:
path (
str) – The path of the value to delete.- Return type:
None
- add_depends_on(target)
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
- Parameters:
target (
CfnResource)- Return type:
None
- add_metadata(key, value)
Add a value to the CloudFormation Resource Metadata.
- Parameters:
key (
str)value (
Any)
- See:
- Return type:
None
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- add_override(path, value)
Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverrideor prefixpathwith “Properties.” (i.e.Properties.TopicName).If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal
.in the property name, prefix with a\. In most programming languages you will need to write this as"\\."because the\itself will need to be escaped.For example:
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"]) cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides Example:
"Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... }
The
valueargument toaddOverridewill not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.- Parameters:
path (
str) –The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
value (
Any) –The value. Could be primitive or complex.
- Return type:
None
- add_property_deletion_override(property_path)
Adds an override that deletes the value of a property from the resource definition.
- Parameters:
property_path (
str) – The path to the property.- Return type:
None
- add_property_override(property_path, value)
Adds an override to a resource property.
Syntactic sugar for
addOverride("Properties.<...>", value).- Parameters:
property_path (
str) – The path of the property.value (
Any) – The value.
- Return type:
None
- apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)
Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.
The resource can be deleted (
RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).- Parameters:
policy (
Optional[RemovalPolicy])apply_to_update_replace_policy (
Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.
- Return type:
None
- get_att(attribute_name)
Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g.
resource.arn), but this can be used for future compatibility in case there is no generated attribute.- Parameters:
attribute_name (
str) – The name of the attribute.- Return type:
- get_metadata(key)
Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters:
key (
str)- See:
- Return type:
Any
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- inspect(inspector)
Examines the CloudFormation resource and discloses attributes.
- Parameters:
inspector (
TreeInspector) –tree inspector to collect and process attributes.
- Return type:
None
- override_logical_id(new_logical_id)
Overrides the auto-generated logical ID with a specific ID.
- Parameters:
new_logical_id (
str) – The new logical ID to use for this stack element.- Return type:
None
- to_string()
Returns a string representation of this construct.
- Return type:
str- Returns:
a string representation of this resource
Attributes
- CFN_RESOURCE_TYPE_NAME = 'AWS::CodePipeline::Pipeline'
- artifact_store
The S3 bucket where artifacts for the pipeline are stored.
You must include either
artifactStoreorartifactStoresin your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must useartifactStores.
- artifact_stores
A mapping of
artifactStoreobjects and their corresponding AWS Regions.There must be an artifact store for the pipeline Region and for each cross-region action in the pipeline. .. epigraph:
You must include either ``artifactStore`` or ``artifactStores`` in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use ``artifactStores`` .
- attr_version
The version of the pipeline.
A new pipeline is always assigned a version number of 1. This number increments when a pipeline is updated.
- CloudformationAttribute:
Version
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- creation_stack
return:
the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.
- disable_inbound_stage_transitions
Represents the input of a
DisableStageTransitionaction.
- logical_id
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use
overrideLogicalId(newLogicalId).- Returns:
the logical ID as a stringified token. This value will only get resolved during synthesis.
- name
The name of the pipeline.
- node
The construct tree node associated with this construct.
- ref
Return a string that will be resolved to a CloudFormation
{ Ref }for this element.If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through
Lazy.any({ produce: resource.ref }).
- restart_execution_on_update
Indicates whether to rerun the CodePipeline pipeline after you update it.
- role_arn
The Amazon Resource Name (ARN) for CodePipeline to use to either perform actions with no
actionRoleArn, or to use to assume roles for actions with anactionRoleArn.
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- stages
Represents information about a stage and its definition.
- tags
Specifies the tags applied to the pipeline.
Static Methods
- classmethod is_cfn_element(x)
Returns
trueif a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceofto allow stack elements from different versions of this library to be included in the same stack.- Parameters:
x (
Any)- Return type:
bool- Returns:
The construct as a stack element or undefined if it is not a stack element.
- classmethod is_cfn_resource(construct)
Check whether the given construct is a CfnResource.
- Parameters:
construct (
IConstruct)- Return type:
bool
- classmethod is_construct(x)
Return whether the given object is a Construct.
- Parameters:
x (
Any)- Return type:
bool
ActionDeclarationProperty
- class CfnPipeline.ActionDeclarationProperty(*, action_type_id, name, configuration=None, input_artifacts=None, namespace=None, output_artifacts=None, region=None, role_arn=None, run_order=None)
Bases:
objectRepresents information about an action declaration.
- Parameters:
action_type_id (
Union[IResolvable,ActionTypeIdProperty,Dict[str,Any]]) – Specifies the action type and the provider of the action.name (
str) – The action declaration’s name.configuration (
Optional[Any]) – The action’s configuration. These are key-value pairs that specify input values for an action. For more information, see Action Structure Requirements in CodePipeline . For the list of configuration properties for the AWS CloudFormation action type in CodePipeline, see Configuration Properties Reference in the AWS CloudFormation User Guide . For template snippets with examples, see Using Parameter Override Functions with CodePipeline Pipelines in the AWS CloudFormation User Guide . The values can be represented in either JSON or YAML format. For example, the JSON configuration item format is as follows: JSON:"Configuration" : { Key : Value },input_artifacts (
Union[IResolvable,Sequence[Union[IResolvable,InputArtifactProperty,Dict[str,Any]]],None]) – The name or ID of the artifact consumed by the action, such as a test or build artifact. While the field is not a required parameter, most actions have an action configuration that requires a specified quantity of input artifacts. To refer to the action configuration specification by action provider, see the Action structure reference in the AWS CodePipeline User Guide . .. epigraph:: For a CodeBuild action with multiple input artifacts, one of your input sources must be designated the PrimarySource. For more information, see the CodeBuild action reference page in the AWS CodePipeline User Guide .namespace (
Optional[str]) – The variable namespace associated with the action. All variables produced as output by this action fall under this namespace.output_artifacts (
Union[IResolvable,Sequence[Union[IResolvable,OutputArtifactProperty,Dict[str,Any]]],None]) –The name or ID of the result of the action declaration, such as a test or build artifact. While the field is not a required parameter, most actions have an action configuration that requires a specified quantity of output artifacts. To refer to the action configuration specification by action provider, see the Action structure reference in the AWS CodePipeline User Guide .
region (
Optional[str]) – The action declaration’s AWS Region, such as us-east-1.role_arn (
Optional[str]) – The ARN of the IAM service role that performs the declared action. This is assumed through the roleArn for the pipeline.run_order (
Union[int,float,None]) – The order in which actions are run.
- Link:
- 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.aws_codepipeline as codepipeline # configuration: Any action_declaration_property = codepipeline.CfnPipeline.ActionDeclarationProperty( action_type_id=codepipeline.CfnPipeline.ActionTypeIdProperty( category="category", owner="owner", provider="provider", version="version" ), name="name", # the properties below are optional configuration=configuration, input_artifacts=[codepipeline.CfnPipeline.InputArtifactProperty( name="name" )], namespace="namespace", output_artifacts=[codepipeline.CfnPipeline.OutputArtifactProperty( name="name" )], region="region", role_arn="roleArn", run_order=123 )
Attributes
- action_type_id
Specifies the action type and the provider of the action.
- configuration
The action’s configuration.
These are key-value pairs that specify input values for an action. For more information, see Action Structure Requirements in CodePipeline . For the list of configuration properties for the AWS CloudFormation action type in CodePipeline, see Configuration Properties Reference in the AWS CloudFormation User Guide . For template snippets with examples, see Using Parameter Override Functions with CodePipeline Pipelines in the AWS CloudFormation User Guide .
The values can be represented in either JSON or YAML format. For example, the JSON configuration item format is as follows:
JSON:
"Configuration" : { Key : Value },
- input_artifacts
The name or ID of the artifact consumed by the action, such as a test or build artifact.
While the field is not a required parameter, most actions have an action configuration that requires a specified quantity of input artifacts. To refer to the action configuration specification by action provider, see the Action structure reference in the AWS CodePipeline User Guide . .. epigraph:
For a CodeBuild action with multiple input artifacts, one of your input sources must be designated the PrimarySource. For more information, see the `CodeBuild action reference page <https://docs.aws.amazon.com/codepipeline/latest/userguide/action-reference-CodeBuild.html>`_ in the *AWS CodePipeline User Guide* .
- name
The action declaration’s name.
- namespace
The variable namespace associated with the action.
All variables produced as output by this action fall under this namespace.
- output_artifacts
The name or ID of the result of the action declaration, such as a test or build artifact.
While the field is not a required parameter, most actions have an action configuration that requires a specified quantity of output artifacts. To refer to the action configuration specification by action provider, see the Action structure reference in the AWS CodePipeline User Guide .
- region
The action declaration’s AWS Region, such as us-east-1.
- role_arn
The ARN of the IAM service role that performs the declared action.
This is assumed through the roleArn for the pipeline.
- run_order
The order in which actions are run.
ActionTypeIdProperty
- class CfnPipeline.ActionTypeIdProperty(*, category, owner, provider, version)
Bases:
objectRepresents information about an action type.
- Parameters:
category (
str) – A category defines what kind of action can be taken in the stage, and constrains the provider type for the action. Valid categories are limited to one of the values below. -Source-Build-Test-Deploy-Invoke-Approvalowner (
str) – The creator of the action being called. There are three valid values for theOwnerfield in the action category section within your pipeline structure:AWS,ThirdParty, andCustom. For more information, see Valid Action Types and Providers in CodePipeline .provider (
str) –The provider of the service being called by the action. Valid providers are determined by the action category. For example, an action in the Deploy category type might have a provider of CodeDeploy, which would be specified as
CodeDeploy. For more information, see Valid Action Types and Providers in CodePipeline .version (
str) – A string that describes the action version.
- Link:
- 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.aws_codepipeline as codepipeline action_type_id_property = codepipeline.CfnPipeline.ActionTypeIdProperty( category="category", owner="owner", provider="provider", version="version" )
Attributes
- category
A category defines what kind of action can be taken in the stage, and constrains the provider type for the action.
Valid categories are limited to one of the values below.
SourceBuildTestDeployInvokeApproval
- owner
The creator of the action being called.
There are three valid values for the
Ownerfield in the action category section within your pipeline structure:AWS,ThirdParty, andCustom. For more information, see Valid Action Types and Providers in CodePipeline .
- provider
The provider of the service being called by the action.
Valid providers are determined by the action category. For example, an action in the Deploy category type might have a provider of CodeDeploy, which would be specified as
CodeDeploy. For more information, see Valid Action Types and Providers in CodePipeline .
- version
A string that describes the action version.
ArtifactStoreMapProperty
- class CfnPipeline.ArtifactStoreMapProperty(*, artifact_store, region)
Bases:
objectA mapping of
artifactStoreobjects and their corresponding AWS Regions.There must be an artifact store for the pipeline Region and for each cross-region action in the pipeline. .. epigraph:
You must include either ``artifactStore`` or ``artifactStores`` in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use ``artifactStores`` .
- Parameters:
artifact_store (
Union[IResolvable,ArtifactStoreProperty,Dict[str,Any]]) – Represents information about the S3 bucket where artifacts are stored for the pipeline. .. epigraph:: You must include eitherartifactStoreorartifactStoresin your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must useartifactStores.region (
str) – The action declaration’s AWS Region, such as us-east-1.
- Link:
- 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.aws_codepipeline as codepipeline artifact_store_map_property = codepipeline.CfnPipeline.ArtifactStoreMapProperty( artifact_store=codepipeline.CfnPipeline.ArtifactStoreProperty( location="location", type="type", # the properties below are optional encryption_key=codepipeline.CfnPipeline.EncryptionKeyProperty( id="id", type="type" ) ), region="region" )
Attributes
- artifact_store
Represents information about the S3 bucket where artifacts are stored for the pipeline.
You must include either
artifactStoreorartifactStoresin your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must useartifactStores.
- region
The action declaration’s AWS Region, such as us-east-1.
ArtifactStoreProperty
- class CfnPipeline.ArtifactStoreProperty(*, location, type, encryption_key=None)
Bases:
objectThe S3 bucket where artifacts for the pipeline are stored.
You must include either
artifactStoreorartifactStoresin your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must useartifactStores.- Parameters:
location (
str) – The S3 bucket used for storing the artifacts for a pipeline. You can specify the name of an S3 bucket but not a folder in the bucket. A folder to contain the pipeline artifacts is created for you based on the name of the pipeline. You can use any S3 bucket in the same AWS Region as the pipeline to store your pipeline artifacts.type (
str) – The type of the artifact store, such as S3.encryption_key (
Union[IResolvable,EncryptionKeyProperty,Dict[str,Any],None]) – The encryption key used to encrypt the data in the artifact store, such as an AWS Key Management Service ( AWS KMS) key. If this is undefined, the default key for Amazon S3 is used. To see an example artifact store encryption key field, see the example structure here: AWS::CodePipeline::Pipeline .
- Link:
- 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.aws_codepipeline as codepipeline artifact_store_property = codepipeline.CfnPipeline.ArtifactStoreProperty( location="location", type="type", # the properties below are optional encryption_key=codepipeline.CfnPipeline.EncryptionKeyProperty( id="id", type="type" ) )
Attributes
- encryption_key
The encryption key used to encrypt the data in the artifact store, such as an AWS Key Management Service ( AWS KMS) key.
If this is undefined, the default key for Amazon S3 is used. To see an example artifact store encryption key field, see the example structure here: AWS::CodePipeline::Pipeline .
- location
The S3 bucket used for storing the artifacts for a pipeline.
You can specify the name of an S3 bucket but not a folder in the bucket. A folder to contain the pipeline artifacts is created for you based on the name of the pipeline. You can use any S3 bucket in the same AWS Region as the pipeline to store your pipeline artifacts.
- type
The type of the artifact store, such as S3.
BlockerDeclarationProperty
- class CfnPipeline.BlockerDeclarationProperty(*, name, type)
Bases:
objectReserved for future use.
- Parameters:
name (
str) – Reserved for future use.type (
str) – Reserved for future use.
- Link:
- 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.aws_codepipeline as codepipeline blocker_declaration_property = codepipeline.CfnPipeline.BlockerDeclarationProperty( name="name", type="type" )
Attributes
- name
Reserved for future use.
EncryptionKeyProperty
- class CfnPipeline.EncryptionKeyProperty(*, id, type)
Bases:
objectRepresents information about the key used to encrypt data in the artifact store, such as an AWS Key Management Service ( AWS KMS) key.
EncryptionKeyis a property of the ArtifactStore property type.- Parameters:
id (
str) – The ID used to identify the key. For an AWS KMS key, you can use the key ID, the key ARN, or the alias ARN. .. epigraph:: Aliases are recognized only in the account that created the AWS KMS key. For cross-account actions, you can only use the key ID or key ARN to identify the key. Cross-account actions involve using the role from the other account (AccountB), so specifying the key ID will use the key from the other account (AccountB).type (
str) – The type of encryption key, such as an AWS KMS key. When creating or updating a pipeline, the value must be set to ‘KMS’.
- Link:
- 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.aws_codepipeline as codepipeline encryption_key_property = codepipeline.CfnPipeline.EncryptionKeyProperty( id="id", type="type" )
Attributes
- id
The ID used to identify the key.
For an AWS KMS key, you can use the key ID, the key ARN, or the alias ARN. .. epigraph:
Aliases are recognized only in the account that created the AWS KMS key. For cross-account actions, you can only use the key ID or key ARN to identify the key. Cross-account actions involve using the role from the other account (AccountB), so specifying the key ID will use the key from the other account (AccountB).
- type
The type of encryption key, such as an AWS KMS key.
When creating or updating a pipeline, the value must be set to ‘KMS’.
InputArtifactProperty
- class CfnPipeline.InputArtifactProperty(*, name)
Bases:
objectRepresents information about an artifact to be worked on, such as a test or build artifact.
- Parameters:
name (
str) – The name of the artifact to be worked on (for example, “My App”). Artifacts are the files that are worked on by actions in the pipeline. See the action configuration for each action for details about artifact parameters. For example, the S3 source action input artifact is a file name (or file path), and the files are generally provided as a ZIP file. Example artifact name: SampleApp_Windows.zip The input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions.- Link:
- 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.aws_codepipeline as codepipeline input_artifact_property = codepipeline.CfnPipeline.InputArtifactProperty( name="name" )
Attributes
- name
The name of the artifact to be worked on (for example, “My App”).
Artifacts are the files that are worked on by actions in the pipeline. See the action configuration for each action for details about artifact parameters. For example, the S3 source action input artifact is a file name (or file path), and the files are generally provided as a ZIP file. Example artifact name: SampleApp_Windows.zip
The input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions.
OutputArtifactProperty
- class CfnPipeline.OutputArtifactProperty(*, name)
Bases:
objectRepresents information about the output of an action.
- Parameters:
name (
str) – The name of the output of an artifact, such as “My App”. The output artifact name must exactly match the input artifact declared for a downstream action. However, the downstream action’s input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions. Output artifact names must be unique within a pipeline.- Link:
- 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.aws_codepipeline as codepipeline output_artifact_property = codepipeline.CfnPipeline.OutputArtifactProperty( name="name" )
Attributes
- name
The name of the output of an artifact, such as “My App”.
The output artifact name must exactly match the input artifact declared for a downstream action. However, the downstream action’s input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions.
Output artifact names must be unique within a pipeline.
StageDeclarationProperty
- class CfnPipeline.StageDeclarationProperty(*, actions, name, blockers=None)
Bases:
objectRepresents information about a stage and its definition.
- Parameters:
actions (
Union[IResolvable,Sequence[Union[IResolvable,ActionDeclarationProperty,Dict[str,Any]]]]) – The actions included in a stage.name (
str) – The name of the stage.blockers (
Union[IResolvable,Sequence[Union[IResolvable,BlockerDeclarationProperty,Dict[str,Any]]],None]) – Reserved for future use.
- Link:
- 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.aws_codepipeline as codepipeline # configuration: Any stage_declaration_property = codepipeline.CfnPipeline.StageDeclarationProperty( actions=[codepipeline.CfnPipeline.ActionDeclarationProperty( action_type_id=codepipeline.CfnPipeline.ActionTypeIdProperty( category="category", owner="owner", provider="provider", version="version" ), name="name", # the properties below are optional configuration=configuration, input_artifacts=[codepipeline.CfnPipeline.InputArtifactProperty( name="name" )], namespace="namespace", output_artifacts=[codepipeline.CfnPipeline.OutputArtifactProperty( name="name" )], region="region", role_arn="roleArn", run_order=123 )], name="name", # the properties below are optional blockers=[codepipeline.CfnPipeline.BlockerDeclarationProperty( name="name", type="type" )] )
Attributes
- actions
The actions included in a stage.
- blockers
Reserved for future use.
StageTransitionProperty
- class CfnPipeline.StageTransitionProperty(*, reason, stage_name)
Bases:
objectThe name of the pipeline in which you want to disable the flow of artifacts from one stage to another.
- Parameters:
reason (
str) – The reason given to the user that a stage is disabled, such as waiting for manual approval or manual tests. This message is displayed in the pipeline console UI.stage_name (
str) – The name of the stage where you want to disable the inbound or outbound transition of artifacts.
- Link:
- 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.aws_codepipeline as codepipeline stage_transition_property = codepipeline.CfnPipeline.StageTransitionProperty( reason="reason", stage_name="stageName" )
Attributes
- reason
The reason given to the user that a stage is disabled, such as waiting for manual approval or manual tests.
This message is displayed in the pipeline console UI.
- stage_name
The name of the stage where you want to disable the inbound or outbound transition of artifacts.