PublishAssetsActionProps

class aws_cdk.pipelines.PublishAssetsActionProps(*, action_name, asset_type, cloud_assembly_input, build_spec=None, cdk_cli_version=None, create_buildspec_file=None, dependable=None, pre_install_commands=None, project_name=None, role=None, subnet_selection=None, vpc=None)

Bases: object

(deprecated) Props for a PublishAssetsAction.

Parameters
  • action_name (str) – (deprecated) Name of publishing action.

  • asset_type (AssetType) – (deprecated) AssetType we’re publishing.

  • cloud_assembly_input (Artifact) – (deprecated) The CodePipeline artifact that holds the Cloud Assembly.

  • build_spec (Optional[BuildSpec]) – (deprecated) Custom BuildSpec that is merged with generated one. Default: - none

  • cdk_cli_version (Optional[str]) – (deprecated) Version of CDK CLI to ‘npm install’. Default: - Latest version

  • create_buildspec_file (Optional[bool]) – (deprecated) Use a file buildspec written to the cloud assembly instead of an inline buildspec. This prevents size limitation errors as inline specs have a max length of 25600 characters Default: false

  • dependable (Optional[IDependable]) – (deprecated) Any Dependable construct that the CodeBuild project needs to take a dependency on. Default: - none

  • pre_install_commands (Optional[Sequence[str]]) – (deprecated) Additional commands to run before installing cdk-assert Use this to setup proxies or npm mirrors. Default: -

  • project_name (Optional[str]) – (deprecated) Name of the CodeBuild project. Default: - Automatically generated

  • role (Optional[IRole]) – (deprecated) Role to use for CodePipeline and CodeBuild to build and publish the assets. Default: - Automatically generated

  • subnet_selection (Union[SubnetSelection, Dict[str, Any], None]) – (deprecated) Which subnets to use. Only used if ‘vpc’ is supplied. Default: - All private subnets.

  • vpc (Optional[IVpc]) – (deprecated) The VPC where to execute the PublishAssetsAction. Default: - No VPC

Deprecated

This class is part of the old API. Use the API based on the CodePipeline class instead

Stability

deprecated

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_codebuild as codebuild
import aws_cdk.aws_codepipeline as codepipeline
import aws_cdk.aws_ec2 as ec2
import aws_cdk.aws_iam as iam
import aws_cdk.core as cdk
import aws_cdk.pipelines as pipelines

# artifact: codepipeline.Artifact
# build_spec: codebuild.BuildSpec
# dependable: cdk.IDependable
# role: iam.Role
# subnet: ec2.Subnet
# subnet_filter: ec2.SubnetFilter
# vpc: ec2.Vpc

publish_assets_action_props = pipelines.PublishAssetsActionProps(
    action_name="actionName",
    asset_type=pipelines.AssetType.FILE,
    cloud_assembly_input=artifact,

    # the properties below are optional
    build_spec=build_spec,
    cdk_cli_version="cdkCliVersion",
    create_buildspec_file=False,
    dependable=dependable,
    pre_install_commands=["preInstallCommands"],
    project_name="projectName",
    role=role,
    subnet_selection=ec2.SubnetSelection(
        availability_zones=["availabilityZones"],
        one_per_az=False,
        subnet_filters=[subnet_filter],
        subnet_group_name="subnetGroupName",
        subnet_name="subnetName",
        subnets=[subnet],
        subnet_type=ec2.SubnetType.ISOLATED
    ),
    vpc=vpc
)

Attributes

action_name

(deprecated) Name of publishing action.

Stability

deprecated

Return type

str

asset_type

(deprecated) AssetType we’re publishing.

Stability

deprecated

Return type

AssetType

build_spec

(deprecated) Custom BuildSpec that is merged with generated one.

Default
  • none

Stability

deprecated

Return type

Optional[BuildSpec]

cdk_cli_version

(deprecated) Version of CDK CLI to ‘npm install’.

Default
  • Latest version

Stability

deprecated

Return type

Optional[str]

cloud_assembly_input

(deprecated) The CodePipeline artifact that holds the Cloud Assembly.

Stability

deprecated

Return type

Artifact

create_buildspec_file

(deprecated) Use a file buildspec written to the cloud assembly instead of an inline buildspec.

This prevents size limitation errors as inline specs have a max length of 25600 characters

Default

false

Stability

deprecated

Return type

Optional[bool]

dependable

(deprecated) Any Dependable construct that the CodeBuild project needs to take a dependency on.

Default
  • none

Stability

deprecated

Return type

Optional[IDependable]

pre_install_commands

(deprecated) Additional commands to run before installing cdk-assert Use this to setup proxies or npm mirrors.

Default
Stability

deprecated

Return type

Optional[List[str]]

project_name

(deprecated) Name of the CodeBuild project.

Default
  • Automatically generated

Stability

deprecated

Return type

Optional[str]

role

(deprecated) Role to use for CodePipeline and CodeBuild to build and publish the assets.

Default
  • Automatically generated

Stability

deprecated

Return type

Optional[IRole]

subnet_selection

(deprecated) Which subnets to use.

Only used if ‘vpc’ is supplied.

Default
  • All private subnets.

Stability

deprecated

Return type

Optional[SubnetSelection]

vpc

(deprecated) The VPC where to execute the PublishAssetsAction.

Default
  • No VPC

Stability

deprecated

Return type

Optional[IVpc]