aws-cdk-lib 2.178.2__py3-none-any.whl → 2.180.0__py3-none-any.whl

aws_cdk/aws_codepipeline/__init__.py

@@ -803,6 +803,7 @@ import constructs as _constructs_77d1e7e8
 from .. import (
     CfnResource as _CfnResource_9df397a6,
     CfnTag as _CfnTag_f6864754,
+    Duration as _Duration_4839e8c3,
     IInspectable as _IInspectable_c2943556,
     IResolvable as _IResolvable_da3f097b,
     IResource as _IResource_c80c4260,
@@ -1015,6 +1016,7 @@ class ActionCategory(enum.Enum):
     APPROVAL = "APPROVAL"
     DEPLOY = "DEPLOY"
     INVOKE = "INVOKE"
+    COMPUTE = "COMPUTE"
 
 
 @jsii.data_type(
@@ -1074,13 +1076,16 @@ class ActionConfig:
         "category": "category",
         "provider": "provider",
         "account": "account",
+        "commands": "commands",
         "inputs": "inputs",
         "outputs": "outputs",
+        "output_variables": "outputVariables",
         "owner": "owner",
         "region": "region",
         "resource": "resource",
         "role": "role",
         "run_order": "runOrder",
+        "timeout": "timeout",
         "variables_namespace": "variablesNamespace",
         "version": "version",
     },
@@ -1094,13 +1099,16 @@ class ActionProperties:
         category: ActionCategory,
         provider: builtins.str,
         account: typing.Optional[builtins.str] = None,
+        commands: typing.Optional[typing.Sequence[builtins.str]] = None,
         inputs: typing.Optional[typing.Sequence["Artifact"]] = None,
         outputs: typing.Optional[typing.Sequence["Artifact"]] = None,
+        output_variables: typing.Optional[typing.Sequence[builtins.str]] = None,
         owner: typing.Optional[builtins.str] = None,
         region: typing.Optional[builtins.str] = None,
         resource: typing.Optional[_IResource_c80c4260] = None,
         role: typing.Optional[_IRole_235f5d8e] = None,
         run_order: typing.Optional[jsii.Number] = None,
+        timeout: typing.Optional[_Duration_4839e8c3] = None,
         variables_namespace: typing.Optional[builtins.str] = None,
         version: typing.Optional[builtins.str] = None,
     ) -> None:
@@ -1110,13 +1118,16 @@ class ActionProperties:
         :param category: The category of the action. The category defines which action type the owner (the entity that performs the action) performs.
         :param provider: The service provider that the action calls.
         :param 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 either ``resource``, or ``account`` - but not both.
+        :param commands: Shell commands for the Commands action to run. Default: - no commands
         :param inputs: 
         :param outputs: 
+        :param output_variables: The names of the variables in your environment that you want to export. Default: - no output variables
         :param owner: 
         :param 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 to ``cdk deploy`` before deploying the main, Pipeline-containing Stack. Default: the Action resides in the same region as the Pipeline
         :param 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.
         :param role: 
         :param run_order: 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-requirements
+        :param timeout: A timeout duration that can be applied against the ActionType’s default timeout value specified in Quotas for AWS CodePipeline. This attribute is available only to the ``ManualApprovalAction``. It is configurable up to 86400 minutes (60 days) with a minimum value of 5 minutes. Default: - default timeout value defined by each ActionType
         :param 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
         :param version: 
 
@@ -1147,13 +1158,16 @@ class ActionProperties:
             
                 # the properties below are optional
                 account="account",
+                commands=["commands"],
                 inputs=[artifact],
                 outputs=[artifact],
+                output_variables=["outputVariables"],
                 owner="owner",
                 region="region",
                 resource=resource,
                 role=role,
                 run_order=123,
+                timeout=cdk.Duration.minutes(30),
                 variables_namespace="variablesNamespace",
                 version="version"
             )
@@ -1167,13 +1181,16 @@ class ActionProperties:
             check_type(argname="argument category", value=category, expected_type=type_hints["category"])
             check_type(argname="argument provider", value=provider, expected_type=type_hints["provider"])
             check_type(argname="argument account", value=account, expected_type=type_hints["account"])
+            check_type(argname="argument commands", value=commands, expected_type=type_hints["commands"])
             check_type(argname="argument inputs", value=inputs, expected_type=type_hints["inputs"])
             check_type(argname="argument outputs", value=outputs, expected_type=type_hints["outputs"])
+            check_type(argname="argument output_variables", value=output_variables, expected_type=type_hints["output_variables"])
             check_type(argname="argument owner", value=owner, expected_type=type_hints["owner"])
             check_type(argname="argument region", value=region, expected_type=type_hints["region"])
             check_type(argname="argument resource", value=resource, expected_type=type_hints["resource"])
             check_type(argname="argument role", value=role, expected_type=type_hints["role"])
             check_type(argname="argument run_order", value=run_order, expected_type=type_hints["run_order"])
+            check_type(argname="argument timeout", value=timeout, expected_type=type_hints["timeout"])
             check_type(argname="argument variables_namespace", value=variables_namespace, expected_type=type_hints["variables_namespace"])
             check_type(argname="argument version", value=version, expected_type=type_hints["version"])
         self._values: typing.Dict[builtins.str, typing.Any] = {
@@ -1184,10 +1201,14 @@ class ActionProperties:
         }
         if account is not None:
             self._values["account"] = account
+        if commands is not None:
+            self._values["commands"] = commands
         if inputs is not None:
             self._values["inputs"] = inputs
         if outputs is not None:
             self._values["outputs"] = outputs
+        if output_variables is not None:
+            self._values["output_variables"] = output_variables
         if owner is not None:
             self._values["owner"] = owner
         if region is not None:
@@ -1198,6 +1219,8 @@ class ActionProperties:
             self._values["role"] = role
         if run_order is not None:
             self._values["run_order"] = run_order
+        if timeout is not None:
+            self._values["timeout"] = timeout
         if variables_namespace is not None:
             self._values["variables_namespace"] = variables_namespace
         if version is not None:
@@ -1247,6 +1270,15 @@ class ActionProperties:
         result = self._values.get("account")
         return typing.cast(typing.Optional[builtins.str], result)
 
+    @builtins.property
+    def commands(self) -> typing.Optional[typing.List[builtins.str]]:
+        '''Shell commands for the Commands action to run.
+
+        :default: - no commands
+        '''
+        result = self._values.get("commands")
+        return typing.cast(typing.Optional[typing.List[builtins.str]], result)
+
     @builtins.property
     def inputs(self) -> typing.Optional[typing.List["Artifact"]]:
         result = self._values.get("inputs")
@@ -1257,6 +1289,15 @@ class ActionProperties:
         result = self._values.get("outputs")
         return typing.cast(typing.Optional[typing.List["Artifact"]], result)
 
+    @builtins.property
+    def output_variables(self) -> typing.Optional[typing.List[builtins.str]]:
+        '''The names of the variables in your environment that you want to export.
+
+        :default: - no output variables
+        '''
+        result = self._values.get("output_variables")
+        return typing.cast(typing.Optional[typing.List[builtins.str]], result)
+
     @builtins.property
     def owner(self) -> typing.Optional[builtins.str]:
         result = self._values.get("owner")
@@ -1300,6 +1341,21 @@ class ActionProperties:
         result = self._values.get("run_order")
         return typing.cast(typing.Optional[jsii.Number], result)
 
+    @builtins.property
+    def timeout(self) -> typing.Optional[_Duration_4839e8c3]:
+        '''A timeout duration that can be applied against the ActionType’s default timeout value specified in Quotas for AWS CodePipeline.
+
+        This attribute is available only to the ``ManualApprovalAction``.
+
+        It is configurable up to 86400 minutes (60 days) with a minimum value of 5 minutes.
+
+        :default: - default timeout value defined by each ActionType
+
+        :see: https://docs.aws.amazon.com/codepipeline/latest/userguide/limits.html
+        '''
+        result = self._values.get("timeout")
+        return typing.cast(typing.Optional[_Duration_4839e8c3], result)
+
     @builtins.property
     def variables_namespace(self) -> typing.Optional[builtins.str]:
         '''The name of the namespace to use for variables emitted by this action.
@@ -1374,28 +1430,43 @@ class Artifact(
         )
     '''
 
-    def __init__(self, artifact_name: typing.Optional[builtins.str] = None) -> None:
-        '''
-        :param artifact_name: -
+    def __init__(
+        self,
+        artifact_name: typing.Optional[builtins.str] = None,
+        artifact_files: typing.Optional[typing.Sequence[builtins.str]] = None,
+    ) -> None:
+        '''An output artifact of an action.
+
+        Artifacts can be used as input by some actions.
+
+        :param artifact_name: the (required) name of the Artifact.
+        :param artifact_files: file paths that you want to export as the output artifact for the action. This property can only be used in the artifact for ``CommandsAction``. The length of the artifactFiles array must be between 1 and 10.
         '''
         if __debug__:
             type_hints = typing.get_type_hints(_typecheckingstub__f54b8d044be8c6120e635522855c750b47ac8841ab3f60bdbffb0d5bc115acd6)
             check_type(argname="argument artifact_name", value=artifact_name, expected_type=type_hints["artifact_name"])
-        jsii.create(self.__class__, self, [artifact_name])
+            check_type(argname="argument artifact_files", value=artifact_files, expected_type=type_hints["artifact_files"])
+        jsii.create(self.__class__, self, [artifact_name, artifact_files])
 
     @jsii.member(jsii_name="artifact")
     @builtins.classmethod
-    def artifact(cls, name: builtins.str) -> "Artifact":
+    def artifact(
+        cls,
+        name: builtins.str,
+        files: typing.Optional[typing.Sequence[builtins.str]] = None,
+    ) -> "Artifact":
         '''A static factory method used to create instances of the Artifact class.
 
         Mainly meant to be used from ``decdk``.
 
         :param name: the (required) name of the Artifact.
+        :param files: file paths that you want to export as the output artifact for the action. This property can only be used in the artifact for ``CommandsAction``. The length of the files array must be between 1 and 10.
         '''
         if __debug__:
             type_hints = typing.get_type_hints(_typecheckingstub__162b74657e69163ea68e052eb239ee6234ff6e7032951e1dfa2a29c0547c72f2)
             check_type(argname="argument name", value=name, expected_type=type_hints["name"])
-        return typing.cast("Artifact", jsii.sinvoke(cls, "artifact", [name]))
+            check_type(argname="argument files", value=files, expected_type=type_hints["files"])
+        return typing.cast("Artifact", jsii.sinvoke(cls, "artifact", [name, files]))
 
     @jsii.member(jsii_name="atPath")
     def at_path(self, file_name: builtins.str) -> "ArtifactPath":
@@ -1486,6 +1557,15 @@ class Artifact(
         '''The artifact attribute of the Amazon Simple Storage Service (Amazon S3) URL of the artifact, such as https://s3-us-west-2.amazonaws.com/artifactstorebucket-yivczw8jma0c/test/TemplateSo/1ABCyZZ.zip.'''
         return typing.cast(builtins.str, jsii.get(self, "url"))
 
+    @builtins.property
+    @jsii.member(jsii_name="artifactFiles")
+    def artifact_files(self) -> typing.Optional[typing.List[builtins.str]]:
+        '''The file paths that you want to export as the output artifact for the action.
+
+        This property can only be used in artifacts for ``CommandsAction``.
+        '''
+        return typing.cast(typing.Optional[typing.List[builtins.str]], jsii.get(self, "artifactFiles"))
+
     @builtins.property
     @jsii.member(jsii_name="artifactName")
     def artifact_name(self) -> typing.Optional[builtins.str]:
@@ -9364,35 +9444,35 @@ class PipelineProps:
 
         Example::
 
-            # source_action: codepipeline_actions.S3SourceAction
-            # source_output: codepipeline.Artifact
-            # deploy_bucket: s3.Bucket
-            
+            # Source action
+            bucket = s3.Bucket(self, "SourceBucket",
+                versioned=True
+            )
+            source_artifact = codepipeline.Artifact("SourceArtifact")
+            source_action = codepipeline_actions.S3SourceAction(
+                action_name="Source",
+                output=source_artifact,
+                bucket=bucket,
+                bucket_key="my.zip"
+            )
             
-            # Pipeline-level variable
-            variable = codepipeline.Variable(
-                variable_name="bucket-var",
-                description="description",
-                default_value="sample"
+            # Commands action
+            output_artifact = codepipeline.Artifact("OutputArtifact")
+            commands_action = codepipeline_actions.CommandsAction(
+                action_name="Commands",
+                commands=["echo \"some commands\""
+                ],
+                input=source_artifact,
+                output=output_artifact
             )
             
-            codepipeline.Pipeline(self, "Pipeline",
-                pipeline_type=codepipeline.PipelineType.V2,
-                variables=[variable],
+            pipeline = codepipeline.Pipeline(self, "Pipeline",
                 stages=[codepipeline.StageProps(
                     stage_name="Source",
                     actions=[source_action]
                 ), codepipeline.StageProps(
-                    stage_name="Deploy",
-                    actions=[
-                        codepipeline_actions.S3DeployAction(
-                            action_name="DeployAction",
-                            # can reference the variables
-                            object_key=f"{variable.reference()}.txt",
-                            input=source_output,
-                            bucket=deploy_bucket
-                        )
-                    ]
+                    stage_name="Commands",
+                    actions=[commands_action]
                 )
                 ]
             )
@@ -10572,13 +10652,16 @@ def _typecheckingstub__9d5af996beb5106d261c46a26d8be39e2a16f31935368b97303970d10
     category: ActionCategory,
     provider: builtins.str,
     account: typing.Optional[builtins.str] = None,
+    commands: typing.Optional[typing.Sequence[builtins.str]] = None,
     inputs: typing.Optional[typing.Sequence[Artifact]] = None,
     outputs: typing.Optional[typing.Sequence[Artifact]] = None,
+    output_variables: typing.Optional[typing.Sequence[builtins.str]] = None,
     owner: typing.Optional[builtins.str] = None,
     region: typing.Optional[builtins.str] = None,
     resource: typing.Optional[_IResource_c80c4260] = None,
     role: typing.Optional[_IRole_235f5d8e] = None,
     run_order: typing.Optional[jsii.Number] = None,
+    timeout: typing.Optional[_Duration_4839e8c3] = None,
     variables_namespace: typing.Optional[builtins.str] = None,
     version: typing.Optional[builtins.str] = None,
 ) -> None:
@@ -10587,12 +10670,14 @@ def _typecheckingstub__9d5af996beb5106d261c46a26d8be39e2a16f31935368b97303970d10
 
 def _typecheckingstub__f54b8d044be8c6120e635522855c750b47ac8841ab3f60bdbffb0d5bc115acd6(
     artifact_name: typing.Optional[builtins.str] = None,
+    artifact_files: typing.Optional[typing.Sequence[builtins.str]] = None,
 ) -> None:
     """Type checking stubs"""
     pass
 
 def _typecheckingstub__162b74657e69163ea68e052eb239ee6234ff6e7032951e1dfa2a29c0547c72f2(
     name: builtins.str,
+    files: typing.Optional[typing.Sequence[builtins.str]] = None,
 ) -> None:
     """Type checking stubs"""
     pass