CfnCustomActionTypeProps

class aws_cdk.aws_codepipeline.CfnCustomActionTypeProps(*, category, input_artifact_details, output_artifact_details, provider, version, configuration_properties=None, settings=None, tags=None)

Bases: object

Properties for defining a CfnCustomActionType.

Parameters
  • category (str) – The category of the custom action, such as a build action or a test action.

  • input_artifact_details (Union[ArtifactDetailsProperty, Dict[str, Any], IResolvable]) – The details of the input artifact for the action, such as its commit ID.

  • output_artifact_details (Union[ArtifactDetailsProperty, Dict[str, Any], IResolvable]) – The details of the output artifact of the action, such as its commit ID.

  • provider (str) – The provider of the service used in the custom action, such as CodeDeploy.

  • version (str) – The version identifier of the custom action.

  • configuration_properties (Union[IResolvable, Sequence[Union[IResolvable, ConfigurationPropertiesProperty, Dict[str, Any]]], None]) – The configuration properties for the custom action. .. epigraph:: You can refer to a name in the configuration properties of the custom action within the URL templates by following the format of {Config:name}, as long as the configuration property is both required and not secret. For more information, see Create a Custom Action for a Pipeline .

  • settings (Union[IResolvable, SettingsProperty, Dict[str, Any], None]) – URLs that provide users information about this custom action.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The tags for the custom action.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html

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

cfn_custom_action_type_props = codepipeline.CfnCustomActionTypeProps(
    category="category",
    input_artifact_details=codepipeline.CfnCustomActionType.ArtifactDetailsProperty(
        maximum_count=123,
        minimum_count=123
    ),
    output_artifact_details=codepipeline.CfnCustomActionType.ArtifactDetailsProperty(
        maximum_count=123,
        minimum_count=123
    ),
    provider="provider",
    version="version",

    # the properties below are optional
    configuration_properties=[codepipeline.CfnCustomActionType.ConfigurationPropertiesProperty(
        key=False,
        name="name",
        required=False,
        secret=False,

        # the properties below are optional
        description="description",
        queryable=False,
        type="type"
    )],
    settings=codepipeline.CfnCustomActionType.SettingsProperty(
        entity_url_template="entityUrlTemplate",
        execution_url_template="executionUrlTemplate",
        revision_url_template="revisionUrlTemplate",
        third_party_configuration_url="thirdPartyConfigurationUrl"
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

category

The category of the custom action, such as a build action or a test action.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-category

Return type

str

configuration_properties

The configuration properties for the custom action.

You can refer to a name in the configuration properties of the custom action within the URL templates by following the format of {Config:name}, as long as the configuration property is both required and not secret. For more information, see Create a Custom Action for a Pipeline .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-configurationproperties

Return type

Union[IResolvable, List[Union[IResolvable, ConfigurationPropertiesProperty]], None]

input_artifact_details

The details of the input artifact for the action, such as its commit ID.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-inputartifactdetails

Return type

Union[ArtifactDetailsProperty, IResolvable]

output_artifact_details

The details of the output artifact of the action, such as its commit ID.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-outputartifactdetails

Return type

Union[ArtifactDetailsProperty, IResolvable]

provider

The provider of the service used in the custom action, such as CodeDeploy.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-provider

Return type

str

settings

URLs that provide users information about this custom action.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-settings

Return type

Union[IResolvable, SettingsProperty, None]

tags

The tags for the custom action.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-tags

Return type

Optional[List[CfnTag]]

version

The version identifier of the custom action.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-version

Return type

str