aws-cdk-lib 2.178.1__py3-none-any.whl → 2.179.0__py3-none-any.whl

aws_cdk/aws_stepfunctions_tasks/__init__.py

@@ -175,6 +175,23 @@ invoke_task = tasks.CallApiGatewayRestApiEndpoint(self, "Call REST API",
 )
 ```
 
+By default, the API endpoint URI will be constructed using the AWS region of
+the stack in which the provided `api` is created.
+
+To construct the endpoint with a different region, use the `region` parameter:
+
+```python
+import aws_cdk.aws_apigateway as apigateway
+
+rest_api = apigateway.RestApi(self, "MyRestApi")
+invoke_task = tasks.CallApiGatewayRestApiEndpoint(self, "Call REST API",
+    api=rest_api,
+    stage_name="prod",
+    method=tasks.HttpMethod.GET,
+    region="us-west-2"
+)
+```
+
 Be aware that the header values must be arrays. When passing the Task Token
 in the headers field `WAIT_FOR_TASK_TOKEN` integration, use
 `JsonPath.array()` to wrap the token in an array:
@@ -289,6 +306,8 @@ get_object = tasks.CallAwsServiceCrossRegion(self, "GetObject",
 
 Other properties such as `additionalIamStatements` can be used in the same way as the `CallAwsService` task.
 
+Note that when you use `integrationPattern.WAIT_FOR_TASK_TOKEN`, the output path changes under `Payload` property.
+
 ## Athena
 
 Step Functions supports [Athena](https://docs.aws.amazon.com/step-functions/latest/dg/connect-athena.html) through the service integration pattern.
@@ -1244,11 +1263,13 @@ The following code snippet includes a Task state that uses eks:call to list the
 
 ```python
 import aws_cdk.aws_eks as eks
+from aws_cdk.lambda_layer_kubectl_v32 import KubectlV32Layer
 
 
 my_eks_cluster = eks.Cluster(self, "my sample cluster",
-    version=eks.KubernetesVersion.V1_18,
-    cluster_name="myEksCluster"
+    version=eks.KubernetesVersion.V1_32,
+    cluster_name="myEksCluster",
+    kubectl_layer=KubectlV32Layer(self, "kubectl")
 )
 
 tasks.EksCall(self, "Call a EKS Endpoint",
@@ -14042,6 +14063,7 @@ class CallApiGatewayRestApiEndpoint(
         *,
         api: _IRestApi_1f02523d,
         stage_name: builtins.str,
+        region: typing.Optional[builtins.str] = None,
         result_path: typing.Optional[builtins.str] = None,
         result_selector: typing.Optional[typing.Mapping[builtins.str, typing.Any]] = None,
         method: "HttpMethod",
@@ -14069,6 +14091,7 @@ class CallApiGatewayRestApiEndpoint(
         :param id: Descriptive identifier for this chainable.
         :param api: API to call.
         :param stage_name: Name of the stage where the API is deployed to in API Gateway.
+        :param region: Specify a custom Region where the API is deployed, e.g. 'us-east-1'. Default: - Uses the Region of the stack containing the ``api``.
         :param result_path: JSONPath expression to indicate where to inject the state's output. May also be the special value JsonPath.DISCARD, which will cause the state's input to become its output. Default: $
         :param result_selector: The JSON that will replace the state's raw result and become the effective result before ResultPath is applied. You can use ResultSelector to create a payload with values that are static or selected from the state's raw result. Default: - None
         :param method: Http method for the API.
@@ -14098,6 +14121,7 @@ class CallApiGatewayRestApiEndpoint(
         props = CallApiGatewayRestApiEndpointProps(
             api=api,
             stage_name=stage_name,
+            region=region,
             result_path=result_path,
             result_selector=result_selector,
             method=method,
@@ -14132,6 +14156,7 @@ class CallApiGatewayRestApiEndpoint(
         *,
         api: _IRestApi_1f02523d,
         stage_name: builtins.str,
+        region: typing.Optional[builtins.str] = None,
         method: "HttpMethod",
         api_path: typing.Optional[builtins.str] = None,
         auth_type: typing.Optional[AuthType] = None,
@@ -14174,6 +14199,7 @@ class CallApiGatewayRestApiEndpoint(
         :param id: -
         :param api: API to call.
         :param stage_name: Name of the stage where the API is deployed to in API Gateway.
+        :param region: Specify a custom Region where the API is deployed, e.g. 'us-east-1'. Default: - Uses the Region of the stack containing the ``api``.
         :param method: Http method for the API.
         :param api_path: Path parameters appended after API endpoint. Default: - No path
         :param auth_type: Authentication methods. Default: AuthType.NO_AUTH
@@ -14201,6 +14227,7 @@ class CallApiGatewayRestApiEndpoint(
         props = CallApiGatewayRestApiEndpointJsonataProps(
             api=api,
             stage_name=stage_name,
+            region=region,
             method=method,
             api_path=api_path,
             auth_type=auth_type,
@@ -14231,6 +14258,7 @@ class CallApiGatewayRestApiEndpoint(
         *,
         api: _IRestApi_1f02523d,
         stage_name: builtins.str,
+        region: typing.Optional[builtins.str] = None,
         result_path: typing.Optional[builtins.str] = None,
         result_selector: typing.Optional[typing.Mapping[builtins.str, typing.Any]] = None,
         method: "HttpMethod",
@@ -14276,6 +14304,7 @@ class CallApiGatewayRestApiEndpoint(
         :param id: -
         :param api: API to call.
         :param stage_name: Name of the stage where the API is deployed to in API Gateway.
+        :param region: Specify a custom Region where the API is deployed, e.g. 'us-east-1'. Default: - Uses the Region of the stack containing the ``api``.
         :param result_path: JSONPath expression to indicate where to inject the state's output. May also be the special value JsonPath.DISCARD, which will cause the state's input to become its output. Default: $
         :param result_selector: The JSON that will replace the state's raw result and become the effective result before ResultPath is applied. You can use ResultSelector to create a payload with values that are static or selected from the state's raw result. Default: - None
         :param method: Http method for the API.
@@ -14306,6 +14335,7 @@ class CallApiGatewayRestApiEndpoint(
         props = CallApiGatewayRestApiEndpointJsonPathProps(
             api=api,
             stage_name=stage_name,
+            region=region,
             result_path=result_path,
             result_selector=result_selector,
             method=method,
@@ -14363,14 +14393,21 @@ class CallApiGatewayRestApiEndpoint(
 @jsii.data_type(
     jsii_type="aws-cdk-lib.aws_stepfunctions_tasks.CallApiGatewayRestApiEndpointOptions",
     jsii_struct_bases=[],
-    name_mapping={"api": "api", "stage_name": "stageName"},
+    name_mapping={"api": "api", "stage_name": "stageName", "region": "region"},
 )
 class CallApiGatewayRestApiEndpointOptions:
-    def __init__(self, *, api: _IRestApi_1f02523d, stage_name: builtins.str) -> None:
+    def __init__(
+        self,
+        *,
+        api: _IRestApi_1f02523d,
+        stage_name: builtins.str,
+        region: typing.Optional[builtins.str] = None,
+    ) -> None:
         '''Base properties for calling an REST API Endpoint.
 
         :param api: API to call.
         :param stage_name: Name of the stage where the API is deployed to in API Gateway.
+        :param region: Specify a custom Region where the API is deployed, e.g. 'us-east-1'. Default: - Uses the Region of the stack containing the ``api``.
 
         :exampleMetadata: fixture=_generated
 
@@ -14385,17 +14422,23 @@ class CallApiGatewayRestApiEndpointOptions:
             
             call_api_gateway_rest_api_endpoint_options = stepfunctions_tasks.CallApiGatewayRestApiEndpointOptions(
                 api=rest_api,
-                stage_name="stageName"
+                stage_name="stageName",
+            
+                # the properties below are optional
+                region="region"
             )
         '''
         if __debug__:
             type_hints = typing.get_type_hints(_typecheckingstub__f3e7028403a9fb243cf40cd7590bda960bfb12daacd7648c71359997146e9dba)
             check_type(argname="argument api", value=api, expected_type=type_hints["api"])
             check_type(argname="argument stage_name", value=stage_name, expected_type=type_hints["stage_name"])
+            check_type(argname="argument region", value=region, expected_type=type_hints["region"])
         self._values: typing.Dict[builtins.str, typing.Any] = {
             "api": api,
             "stage_name": stage_name,
         }
+        if region is not None:
+            self._values["region"] = region
 
     @builtins.property
     def api(self) -> _IRestApi_1f02523d:
@@ -14411,6 +14454,15 @@ class CallApiGatewayRestApiEndpointOptions:
         assert result is not None, "Required property 'stage_name' is missing"
         return typing.cast(builtins.str, result)
 
+    @builtins.property
+    def region(self) -> typing.Optional[builtins.str]:
+        '''Specify a custom Region where the API is deployed, e.g. 'us-east-1'.
+
+        :default: - Uses the Region of the stack containing the ``api``.
+        '''
+        result = self._values.get("region")
+        return typing.cast(typing.Optional[builtins.str], result)
+
     def __eq__(self, rhs: typing.Any) -> builtins.bool:
         return isinstance(rhs, self.__class__) and rhs._values == self._values
 
@@ -14452,6 +14504,7 @@ class CallApiGatewayRestApiEndpointOptions:
         "request_body": "requestBody",
         "api": "api",
         "stage_name": "stageName",
+        "region": "region",
     },
 )
 class CallApiGatewayRestApiEndpointProps(
@@ -14484,6 +14537,7 @@ class CallApiGatewayRestApiEndpointProps(
         request_body: typing.Optional[_TaskInput_91b91b91] = None,
         api: _IRestApi_1f02523d,
         stage_name: builtins.str,
+        region: typing.Optional[builtins.str] = None,
     ) -> None:
         '''Properties for calling an REST API Endpoint.
 
@@ -14510,23 +14564,20 @@ class CallApiGatewayRestApiEndpointProps(
         :param request_body: HTTP Request body. Default: - No request body
         :param api: API to call.
         :param stage_name: Name of the stage where the API is deployed to in API Gateway.
+        :param region: Specify a custom Region where the API is deployed, e.g. 'us-east-1'. Default: - Uses the Region of the stack containing the ``api``.
 
         :exampleMetadata: infused
 
         Example::
 
             import aws_cdk.aws_apigateway as apigateway
-            # api: apigateway.RestApi
-            
             
-            tasks.CallApiGatewayRestApiEndpoint(self, "Endpoint",
-                api=api,
-                stage_name="Stage",
-                method=tasks.HttpMethod.PUT,
-                integration_pattern=sfn.IntegrationPattern.WAIT_FOR_TASK_TOKEN,
-                headers=sfn.TaskInput.from_object({
-                    "TaskToken": sfn.JsonPath.array(sfn.JsonPath.task_token)
-                })
+            rest_api = apigateway.RestApi(self, "MyRestApi")
+            invoke_task = tasks.CallApiGatewayRestApiEndpoint(self, "Call REST API",
+                api=rest_api,
+                stage_name="prod",
+                method=tasks.HttpMethod.GET,
+                region="us-west-2"
             )
         '''
         if isinstance(credentials, dict):
@@ -14556,6 +14607,7 @@ class CallApiGatewayRestApiEndpointProps(
             check_type(argname="argument request_body", value=request_body, expected_type=type_hints["request_body"])
             check_type(argname="argument api", value=api, expected_type=type_hints["api"])
             check_type(argname="argument stage_name", value=stage_name, expected_type=type_hints["stage_name"])
+            check_type(argname="argument region", value=region, expected_type=type_hints["region"])
         self._values: typing.Dict[builtins.str, typing.Any] = {
             "method": method,
             "api": api,
@@ -14601,6 +14653,8 @@ class CallApiGatewayRestApiEndpointProps(
             self._values["query_parameters"] = query_parameters
         if request_body is not None:
             self._values["request_body"] = request_body
+        if region is not None:
+            self._values["region"] = region
 
     @builtins.property
     def comment(self) -> typing.Optional[builtins.str]:
@@ -14862,6 +14916,15 @@ class CallApiGatewayRestApiEndpointProps(
         assert result is not None, "Required property 'stage_name' is missing"
         return typing.cast(builtins.str, result)
 
+    @builtins.property
+    def region(self) -> typing.Optional[builtins.str]:
+        '''Specify a custom Region where the API is deployed, e.g. 'us-east-1'.
+
+        :default: - Uses the Region of the stack containing the ``api``.
+        '''
+        result = self._values.get("region")
+        return typing.cast(typing.Optional[builtins.str], result)
+
     def __eq__(self, rhs: typing.Any) -> builtins.bool:
         return isinstance(rhs, self.__class__) and rhs._values == self._values
 
@@ -31472,11 +31535,13 @@ class EksCall(
     Example::
 
         import aws_cdk.aws_eks as eks
+        from aws_cdk.lambda_layer_kubectl_v32 import KubectlV32Layer
         
         
         my_eks_cluster = eks.Cluster(self, "my sample cluster",
-            version=eks.KubernetesVersion.V1_18,
-            cluster_name="myEksCluster"
+            version=eks.KubernetesVersion.V1_32,
+            cluster_name="myEksCluster",
+            kubectl_layer=KubectlV32Layer(self, "kubectl")
         )
         
         tasks.EksCall(self, "Call a EKS Endpoint",
@@ -32578,11 +32643,13 @@ class EksCallProps(_TaskStateBaseProps_3a62b6d0):
         Example::
 
             import aws_cdk.aws_eks as eks
+            from aws_cdk.lambda_layer_kubectl_v32 import KubectlV32Layer
             
             
             my_eks_cluster = eks.Cluster(self, "my sample cluster",
-                version=eks.KubernetesVersion.V1_18,
-                cluster_name="myEksCluster"
+                version=eks.KubernetesVersion.V1_32,
+                cluster_name="myEksCluster",
+                kubectl_layer=KubectlV32Layer(self, "kubectl")
             )
             
             tasks.EksCall(self, "Call a EKS Endpoint",
@@ -61832,11 +61899,13 @@ class HttpMethods(enum.Enum):
     Example::
 
         import aws_cdk.aws_eks as eks
+        from aws_cdk.lambda_layer_kubectl_v32 import KubectlV32Layer
         
         
         my_eks_cluster = eks.Cluster(self, "my sample cluster",
-            version=eks.KubernetesVersion.V1_18,
-            cluster_name="myEksCluster"
+            version=eks.KubernetesVersion.V1_32,
+            cluster_name="myEksCluster",
+            kubectl_layer=KubectlV32Layer(self, "kubectl")
         )
         
         tasks.EksCall(self, "Call a EKS Endpoint",
@@ -84631,6 +84700,7 @@ class CallApiGatewayHttpApiEndpointJsonataProps(
         "request_body": "requestBody",
         "api": "api",
         "stage_name": "stageName",
+        "region": "region",
     },
 )
 class CallApiGatewayRestApiEndpointJsonPathProps(
@@ -84662,6 +84732,7 @@ class CallApiGatewayRestApiEndpointJsonPathProps(
         request_body: typing.Optional[_TaskInput_91b91b91] = None,
         api: _IRestApi_1f02523d,
         stage_name: builtins.str,
+        region: typing.Optional[builtins.str] = None,
     ) -> None:
         '''Properties for calling an REST API Endpoint using JSONPath.
 
@@ -84687,6 +84758,7 @@ class CallApiGatewayRestApiEndpointJsonPathProps(
         :param request_body: HTTP Request body. Default: - No request body
         :param api: API to call.
         :param stage_name: Name of the stage where the API is deployed to in API Gateway.
+        :param region: Specify a custom Region where the API is deployed, e.g. 'us-east-1'. Default: - Uses the Region of the stack containing the ``api``.
 
         :exampleMetadata: infused
 
@@ -84732,6 +84804,7 @@ class CallApiGatewayRestApiEndpointJsonPathProps(
             check_type(argname="argument request_body", value=request_body, expected_type=type_hints["request_body"])
             check_type(argname="argument api", value=api, expected_type=type_hints["api"])
             check_type(argname="argument stage_name", value=stage_name, expected_type=type_hints["stage_name"])
+            check_type(argname="argument region", value=region, expected_type=type_hints["region"])
         self._values: typing.Dict[builtins.str, typing.Any] = {
             "method": method,
             "api": api,
@@ -84775,6 +84848,8 @@ class CallApiGatewayRestApiEndpointJsonPathProps(
             self._values["query_parameters"] = query_parameters
         if request_body is not None:
             self._values["request_body"] = request_body
+        if region is not None:
+            self._values["region"] = region
 
     @builtins.property
     def comment(self) -> typing.Optional[builtins.str]:
@@ -85019,6 +85094,15 @@ class CallApiGatewayRestApiEndpointJsonPathProps(
         assert result is not None, "Required property 'stage_name' is missing"
         return typing.cast(builtins.str, result)
 
+    @builtins.property
+    def region(self) -> typing.Optional[builtins.str]:
+        '''Specify a custom Region where the API is deployed, e.g. 'us-east-1'.
+
+        :default: - Uses the Region of the stack containing the ``api``.
+        '''
+        result = self._values.get("region")
+        return typing.cast(typing.Optional[builtins.str], result)
+
     def __eq__(self, rhs: typing.Any) -> builtins.bool:
         return isinstance(rhs, self.__class__) and rhs._values == self._values
 
@@ -85056,6 +85140,7 @@ class CallApiGatewayRestApiEndpointJsonPathProps(
         "request_body": "requestBody",
         "api": "api",
         "stage_name": "stageName",
+        "region": "region",
     },
 )
 class CallApiGatewayRestApiEndpointJsonataProps(
@@ -85084,6 +85169,7 @@ class CallApiGatewayRestApiEndpointJsonataProps(
         request_body: typing.Optional[_TaskInput_91b91b91] = None,
         api: _IRestApi_1f02523d,
         stage_name: builtins.str,
+        region: typing.Optional[builtins.str] = None,
     ) -> None:
         '''Properties for calling an REST API Endpoint using JSONata.
 
@@ -85106,6 +85192,7 @@ class CallApiGatewayRestApiEndpointJsonataProps(
         :param request_body: HTTP Request body. Default: - No request body
         :param api: API to call.
         :param stage_name: Name of the stage where the API is deployed to in API Gateway.
+        :param region: Specify a custom Region where the API is deployed, e.g. 'us-east-1'. Default: - Uses the Region of the stack containing the ``api``.
 
         :exampleMetadata: infused
 
@@ -85148,6 +85235,7 @@ class CallApiGatewayRestApiEndpointJsonataProps(
             check_type(argname="argument request_body", value=request_body, expected_type=type_hints["request_body"])
             check_type(argname="argument api", value=api, expected_type=type_hints["api"])
             check_type(argname="argument stage_name", value=stage_name, expected_type=type_hints["stage_name"])
+            check_type(argname="argument region", value=region, expected_type=type_hints["region"])
         self._values: typing.Dict[builtins.str, typing.Any] = {
             "method": method,
             "api": api,
@@ -85185,6 +85273,8 @@ class CallApiGatewayRestApiEndpointJsonataProps(
             self._values["query_parameters"] = query_parameters
         if request_body is not None:
             self._values["request_body"] = request_body
+        if region is not None:
+            self._values["region"] = region
 
     @builtins.property
     def comment(self) -> typing.Optional[builtins.str]:
@@ -85394,6 +85484,15 @@ class CallApiGatewayRestApiEndpointJsonataProps(
         assert result is not None, "Required property 'stage_name' is missing"
         return typing.cast(builtins.str, result)
 
+    @builtins.property
+    def region(self) -> typing.Optional[builtins.str]:
+        '''Specify a custom Region where the API is deployed, e.g. 'us-east-1'.
+
+        :default: - Uses the Region of the stack containing the ``api``.
+        '''
+        result = self._values.get("region")
+        return typing.cast(typing.Optional[builtins.str], result)
+
     def __eq__(self, rhs: typing.Any) -> builtins.bool:
         return isinstance(rhs, self.__class__) and rhs._values == self._values
 
@@ -87126,6 +87225,7 @@ def _typecheckingstub__a76886b18651b0cbd9c7ad80e6a462a8540904f212eeb56575f9a2c9a
     *,
     api: _IRestApi_1f02523d,
     stage_name: builtins.str,
+    region: typing.Optional[builtins.str] = None,
     result_path: typing.Optional[builtins.str] = None,
     result_selector: typing.Optional[typing.Mapping[builtins.str, typing.Any]] = None,
     method: HttpMethod,
@@ -87157,6 +87257,7 @@ def _typecheckingstub__d2442fdcffc01527df3494d29d520e172a5fc4b5567d13ab1172c04a4
     *,
     api: _IRestApi_1f02523d,
     stage_name: builtins.str,
+    region: typing.Optional[builtins.str] = None,
     method: HttpMethod,
     api_path: typing.Optional[builtins.str] = None,
     auth_type: typing.Optional[AuthType] = None,
@@ -87184,6 +87285,7 @@ def _typecheckingstub__e4dc06a85acae89b8512aa5463430dbf35b4fed27323d6928f986b34f
     *,
     api: _IRestApi_1f02523d,
     stage_name: builtins.str,
+    region: typing.Optional[builtins.str] = None,
     result_path: typing.Optional[builtins.str] = None,
     result_selector: typing.Optional[typing.Mapping[builtins.str, typing.Any]] = None,
     method: HttpMethod,
@@ -87212,6 +87314,7 @@ def _typecheckingstub__f3e7028403a9fb243cf40cd7590bda960bfb12daacd7648c713599971
     *,
     api: _IRestApi_1f02523d,
     stage_name: builtins.str,
+    region: typing.Optional[builtins.str] = None,
 ) -> None:
     """Type checking stubs"""
     pass
@@ -87241,6 +87344,7 @@ def _typecheckingstub__f5e083701921cac85bdeb9778c84e51785062fe16c2575a0df424f5a5
     request_body: typing.Optional[_TaskInput_91b91b91] = None,
     api: _IRestApi_1f02523d,
     stage_name: builtins.str,
+    region: typing.Optional[builtins.str] = None,
 ) -> None:
     """Type checking stubs"""
     pass
@@ -94268,6 +94372,7 @@ def _typecheckingstub__7b8b5896877eb92cc0432b392e54ec4c2a6e2ab6c4c1267937be8d816
     request_body: typing.Optional[_TaskInput_91b91b91] = None,
     api: _IRestApi_1f02523d,
     stage_name: builtins.str,
+    region: typing.Optional[builtins.str] = None,
 ) -> None:
     """Type checking stubs"""
     pass
@@ -94293,6 +94398,7 @@ def _typecheckingstub__b6847d83cb6b7fc3dd5f315ea3f38569ba494b7f17388e9222260ff45
     request_body: typing.Optional[_TaskInput_91b91b91] = None,
     api: _IRestApi_1f02523d,
     stage_name: builtins.str,
+    region: typing.Optional[builtins.str] = None,
 ) -> None:
     """Type checking stubs"""
     pass

aws_cdk/pipelines/__init__.py

@@ -1195,9 +1195,9 @@ separate cdk repo and are just importing them for use in one of your (many) pipe
 # shared_xRegion_us_west2_key_arn: str
 
 
-us_west1_bucket = s3.Bucket.from_bucket_attributes(scope, "UsEast1Bucket",
+us_west1_bucket = s3.Bucket.from_bucket_attributes(scope, "UsWest1Bucket",
     bucket_arn=shared_xRegion_us_west1_bucket_arn,
-    encryption_key=kms.Key.from_key_arn(scope, "UsEast1BucketKeyArn", shared_xRegion_us_west1_bucket_arn)
+    encryption_key=kms.Key.from_key_arn(scope, "UsWest1BucketKeyArn", shared_xRegion_us_west1_bucket_arn)
 )
 
 us_west2_bucket = s3.Bucket.from_bucket_attributes(scope, "UsWest2Bucket",

{aws_cdk_lib-2.178.1.dist-info → aws_cdk_lib-2.179.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: aws-cdk-lib
-Version: 2.178.1
+Version: 2.179.0
 Summary: Version 2 of the AWS Cloud Development Kit library
 Home-page: https://github.com/aws/aws-cdk
 Author: Amazon Web Services
@@ -22,7 +22,6 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 License-File: NOTICE
 Requires-Dist: aws-cdk.asset-awscli-v1<3.0.0,>=2.2.208
-Requires-Dist: aws-cdk.asset-kubectl-v20<3.0.0,>=2.1.3
 Requires-Dist: aws-cdk.asset-node-proxy-agent-v6<3.0.0,>=2.1.0
 Requires-Dist: aws-cdk.cloud-assembly-schema<40.0.0,>=39.2.0
 Requires-Dist: constructs<11.0.0,>=10.0.0