ActionDeclaration ¶

class ActionDeclaration(TypedDict, closed=True):
    name: "capo_codepipeline.types.action_name.ActionName"
    """<p>The action declaration's name.</p>"""
    action_type_id: "capo_codepipeline.types.action_type_id.ActionTypeId"
    """<p>Specifies the action type and the provider of the action.</p>"""
    run_order: NotRequired["capo_codepipeline.types.action_run_order.ActionRunOrder"]
    """<p>The order in which actions are run.</p>"""
    configuration: NotRequired[
        "capo_codepipeline.types.action_configuration_map.ActionConfigurationMap"
    ]
    """<p>The action's configuration. These are key-value pairs that specify input values for an action. For more information, see <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#action-requirements">Action Structure Requirements in CodePipeline</a>. For the list of configuration properties for the CloudFormation action type in CodePipeline, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/continuous-delivery-codepipeline-action-reference.html">Configuration Properties Reference</a> in the <i>CloudFormation User Guide</i>. For template snippets with examples, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/continuous-delivery-codepipeline-parameter-override-functions.html">Using Parameter Override Functions with CodePipeline Pipelines</a> in the <i>CloudFormation User Guide</i>.</p> <p>The values can be represented in either JSON or YAML format. For example, the JSON configuration item format is as follows: </p> <p> <i>JSON:</i> </p> <p> <code>"Configuration" : { Key : Value },</code> </p>"""
    commands: NotRequired["capo_codepipeline.types.command_list.CommandList"]
    """<p>The shell commands to run with your compute action in CodePipeline. All commands are supported except multi-line formats. While CodeBuild logs and permissions are used, you do not need to create any resources in CodeBuild.</p> <note> <p>Using compute time for this action will incur separate charges in CodeBuild.</p> </note>"""
    output_artifacts: NotRequired[
        "capo_codepipeline.types.output_artifact_list.OutputArtifactList"
    ]
    """<p>The name or ID of the result of the action declaration, such as a test or build artifact.</p>"""
    input_artifacts: NotRequired[
        "capo_codepipeline.types.input_artifact_list.InputArtifactList"
    ]
    """<p>The name or ID of the artifact consumed by the action, such as a test or build artifact.</p>"""
    output_variables: NotRequired[
        "capo_codepipeline.types.output_variable_list.OutputVariableList"
    ]
    """<p>The list of variables that are to be exported from the compute action. This is specifically CodeBuild environment variables as used for that action.</p>"""
    role_arn: NotRequired["capo_codepipeline.types.role_arn.RoleArn"]
    """<p>The ARN of the IAM service role that performs the declared action. This is assumed through the roleArn for the pipeline.</p>"""
    region: NotRequired["capo_codepipeline.types.aws_region_name.AWSRegionName"]
    """<p>The action declaration's Amazon Web Services Region, such as us-east-1.</p>"""
    namespace: NotRequired["capo_codepipeline.types.action_namespace.ActionNamespace"]
    """<p>The variable namespace associated with the action. All variables produced as output by this action fall under this namespace.</p>"""
    timeout_in_minutes: NotRequired[
        "capo_codepipeline.types.action_timeout.ActionTimeout"
    ]
    """<p>A timeout duration in minutes that can be applied against the ActionType’s default timeout value specified in <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/limits.html">Quotas for CodePipeline </a>. This attribute is available only to the manual approval ActionType.</p>"""
    environment_variables: NotRequired[
        "capo_codepipeline.types.environment_variable_list.EnvironmentVariableList"
    ]
    """<p>The environment variables for the action.</p>"""