aws-cdk-lib 2.172.0__py3-none-any.whl → 2.173.1__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of aws-cdk-lib might be problematic. Click here for more details.
- aws_cdk/__init__.py +57 -0
- aws_cdk/_jsii/__init__.py +1 -1
- aws_cdk/_jsii/{aws-cdk-lib@2.172.0.jsii.tgz → aws-cdk-lib@2.173.1.jsii.tgz} +0 -0
- aws_cdk/aws_amazonmq/__init__.py +40 -40
- aws_cdk/aws_apigateway/__init__.py +111 -64
- aws_cdk/aws_applicationautoscaling/__init__.py +141 -66
- aws_cdk/aws_appsync/__init__.py +4 -3
- aws_cdk/aws_autoscaling/__init__.py +15 -6
- aws_cdk/aws_bedrock/__init__.py +32 -44
- aws_cdk/aws_chatbot/__init__.py +72 -46
- aws_cdk/aws_cleanrooms/__init__.py +4 -6
- aws_cdk/aws_cloudfront/__init__.py +4 -2
- aws_cdk/aws_cloudtrail/__init__.py +104 -68
- aws_cdk/aws_cloudwatch/__init__.py +51 -14
- aws_cdk/aws_codebuild/__init__.py +39 -0
- aws_cdk/aws_codepipeline/__init__.py +4 -4
- aws_cdk/aws_cognito/__init__.py +221 -53
- aws_cdk/aws_config/__init__.py +13 -10
- aws_cdk/aws_connect/__init__.py +25 -23
- aws_cdk/aws_connectcampaignsv2/__init__.py +187 -176
- aws_cdk/aws_docdb/__init__.py +128 -0
- aws_cdk/aws_dynamodb/__init__.py +256 -0
- aws_cdk/aws_ec2/__init__.py +130 -48
- aws_cdk/aws_ecs/__init__.py +25 -13
- aws_cdk/aws_eks/__init__.py +86 -24
- aws_cdk/aws_elasticache/__init__.py +22 -22
- aws_cdk/aws_elasticloadbalancingv2/__init__.py +138 -128
- aws_cdk/aws_events/__init__.py +39 -26
- aws_cdk/aws_fsx/__init__.py +134 -10
- aws_cdk/aws_imagebuilder/__init__.py +8 -8
- aws_cdk/aws_invoicing/__init__.py +651 -0
- aws_cdk/aws_iot/__init__.py +28 -22
- aws_cdk/aws_iotfleetwise/__init__.py +473 -332
- aws_cdk/aws_iotsitewise/__init__.py +6 -4
- aws_cdk/aws_ivs/__init__.py +43 -31
- aws_cdk/aws_kendra/__init__.py +4 -0
- aws_cdk/aws_lakeformation/__init__.py +2 -1
- aws_cdk/aws_lambda/__init__.py +258 -156
- aws_cdk/aws_logs/__init__.py +532 -0
- aws_cdk/aws_m2/__init__.py +15 -15
- aws_cdk/aws_mediaconnect/__init__.py +24 -14
- aws_cdk/aws_medialive/__init__.py +2359 -5
- aws_cdk/aws_mediapackage/__init__.py +3 -9
- aws_cdk/aws_mediapackagev2/__init__.py +19 -17
- aws_cdk/aws_memorydb/__init__.py +664 -4
- aws_cdk/aws_qbusiness/__init__.py +2018 -66
- aws_cdk/aws_rds/__init__.py +30 -0
- aws_cdk/aws_resourcegroups/__init__.py +26 -17
- aws_cdk/aws_route53/__init__.py +1177 -10
- aws_cdk/aws_route53_targets/__init__.py +224 -100
- aws_cdk/aws_route53resolver/__init__.py +4 -2
- aws_cdk/aws_s3/__init__.py +4 -4
- aws_cdk/aws_s3express/__init__.py +30 -19
- aws_cdk/aws_sagemaker/__init__.py +783 -9
- aws_cdk/aws_secretsmanager/__init__.py +20 -6
- aws_cdk/aws_securityhub/__init__.py +64 -32
- aws_cdk/aws_servicediscovery/__init__.py +43 -0
- aws_cdk/aws_ses/__init__.py +109 -0
- aws_cdk/aws_stepfunctions_tasks/__init__.py +190 -35
- aws_cdk/aws_synthetics/__init__.py +7 -5
- aws_cdk/aws_vpclattice/__init__.py +1479 -122
- aws_cdk/aws_wisdom/__init__.py +2698 -232
- aws_cdk/aws_workspacesweb/__init__.py +118 -61
- {aws_cdk_lib-2.172.0.dist-info → aws_cdk_lib-2.173.1.dist-info}/METADATA +1 -1
- {aws_cdk_lib-2.172.0.dist-info → aws_cdk_lib-2.173.1.dist-info}/RECORD +69 -68
- {aws_cdk_lib-2.172.0.dist-info → aws_cdk_lib-2.173.1.dist-info}/LICENSE +0 -0
- {aws_cdk_lib-2.172.0.dist-info → aws_cdk_lib-2.173.1.dist-info}/NOTICE +0 -0
- {aws_cdk_lib-2.172.0.dist-info → aws_cdk_lib-2.173.1.dist-info}/WHEEL +0 -0
- {aws_cdk_lib-2.172.0.dist-info → aws_cdk_lib-2.173.1.dist-info}/top_level.txt +0 -0
aws_cdk/aws_events/__init__.py
CHANGED
|
@@ -1576,6 +1576,8 @@ class CfnConnection(
|
|
|
1576
1576
|
|
|
1577
1577
|
A connection defines the authorization type and credentials to use for authorization with an API destination HTTP endpoint.
|
|
1578
1578
|
|
|
1579
|
+
For more information, see `Connections for endpoint targets <https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-target-connection.html>`_ in the *Amazon EventBridge User Guide* .
|
|
1580
|
+
|
|
1579
1581
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html
|
|
1580
1582
|
:cloudformationResource: AWS::Events::Connection
|
|
1581
1583
|
:exampleMetadata: fixture=_generated
|
|
@@ -1690,7 +1692,7 @@ class CfnConnection(
|
|
|
1690
1692
|
:param scope: Scope in which this resource is defined.
|
|
1691
1693
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
1692
1694
|
:param authorization_type: The type of authorization to use for the connection. .. epigraph:: OAUTH tokens are refreshed when a 401 or 407 response is returned.
|
|
1693
|
-
:param auth_parameters:
|
|
1695
|
+
:param auth_parameters: The authorization parameters to use to authorize with the endpoint. You must include only authorization parameters for the ``AuthorizationType`` you specify.
|
|
1694
1696
|
:param description: A description for the connection to create.
|
|
1695
1697
|
:param invocation_connectivity_parameters: The private resource the HTTP request will be sent to.
|
|
1696
1698
|
:param name: The name for the connection to create.
|
|
@@ -1753,7 +1755,10 @@ class CfnConnection(
|
|
|
1753
1755
|
def attr_auth_parameters_connectivity_parameters_resource_parameters_resource_association_arn(
|
|
1754
1756
|
self,
|
|
1755
1757
|
) -> builtins.str:
|
|
1756
|
-
'''
|
|
1758
|
+
'''For connections to private APIs, the Amazon Resource Name (ARN) of the resource association EventBridge created between the connection and the private API's resource configuration.
|
|
1759
|
+
|
|
1760
|
+
For more information, see `Managing service network resource associations for connections <https://docs.aws.amazon.com/eventbridge/latest/userguide/connection-private.html#connection-private-snra>`_ in the **Amazon EventBridge User Guide** .
|
|
1761
|
+
|
|
1757
1762
|
:cloudformationAttribute: AuthParameters.ConnectivityParameters.ResourceParameters.ResourceAssociationArn
|
|
1758
1763
|
'''
|
|
1759
1764
|
return typing.cast(builtins.str, jsii.get(self, "attrAuthParametersConnectivityParametersResourceParametersResourceAssociationArn"))
|
|
@@ -1763,7 +1768,10 @@ class CfnConnection(
|
|
|
1763
1768
|
def attr_invocation_connectivity_parameters_resource_parameters_resource_association_arn(
|
|
1764
1769
|
self,
|
|
1765
1770
|
) -> builtins.str:
|
|
1766
|
-
'''
|
|
1771
|
+
'''For connections to private APIs, the Amazon Resource Name (ARN) of the resource association EventBridge created between the connection and the private API's resource configuration.
|
|
1772
|
+
|
|
1773
|
+
For more information, see `Managing service network resource associations for connections <https://docs.aws.amazon.com/eventbridge/latest/userguide/connection-private.html#connection-private-snra>`_ in the **Amazon EventBridge User Guide** .
|
|
1774
|
+
|
|
1767
1775
|
:cloudformationAttribute: InvocationConnectivityParameters.ResourceParameters.ResourceAssociationArn
|
|
1768
1776
|
'''
|
|
1769
1777
|
return typing.cast(builtins.str, jsii.get(self, "attrInvocationConnectivityParametersResourceParametersResourceAssociationArn"))
|
|
@@ -1800,7 +1808,7 @@ class CfnConnection(
|
|
|
1800
1808
|
def auth_parameters(
|
|
1801
1809
|
self,
|
|
1802
1810
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnConnection.AuthParametersProperty"]]:
|
|
1803
|
-
'''
|
|
1811
|
+
'''The authorization parameters to use to authorize with the endpoint.'''
|
|
1804
1812
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnConnection.AuthParametersProperty"]], jsii.get(self, "authParameters"))
|
|
1805
1813
|
|
|
1806
1814
|
@auth_parameters.setter
|
|
@@ -1869,7 +1877,7 @@ class CfnConnection(
|
|
|
1869
1877
|
api_key_name: builtins.str,
|
|
1870
1878
|
api_key_value: builtins.str,
|
|
1871
1879
|
) -> None:
|
|
1872
|
-
'''
|
|
1880
|
+
'''The API key authorization parameters for the connection.
|
|
1873
1881
|
|
|
1874
1882
|
:param api_key_name: The name of the API key to use for authorization.
|
|
1875
1883
|
:param api_key_value: The value for the API key to use for authorization.
|
|
@@ -1949,7 +1957,7 @@ class CfnConnection(
|
|
|
1949
1957
|
invocation_http_parameters: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnConnection.ConnectionHttpParametersProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
1950
1958
|
o_auth_parameters: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnConnection.OAuthParametersProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
1951
1959
|
) -> None:
|
|
1952
|
-
'''
|
|
1960
|
+
'''Tthe authorization parameters to use for the connection.
|
|
1953
1961
|
|
|
1954
1962
|
:param api_key_auth_parameters: The API Key parameters to use for authorization.
|
|
1955
1963
|
:param basic_auth_parameters: The authorization parameters for Basic authorization.
|
|
@@ -2132,7 +2140,7 @@ class CfnConnection(
|
|
|
2132
2140
|
)
|
|
2133
2141
|
class BasicAuthParametersProperty:
|
|
2134
2142
|
def __init__(self, *, password: builtins.str, username: builtins.str) -> None:
|
|
2135
|
-
'''
|
|
2143
|
+
'''The Basic authorization parameters for the connection.
|
|
2136
2144
|
|
|
2137
2145
|
:param password: The password associated with the user name to use for Basic authorization.
|
|
2138
2146
|
:param username: The user name to use for Basic authorization.
|
|
@@ -2203,7 +2211,7 @@ class CfnConnection(
|
|
|
2203
2211
|
client_id: builtins.str,
|
|
2204
2212
|
client_secret: builtins.str,
|
|
2205
2213
|
) -> None:
|
|
2206
|
-
'''
|
|
2214
|
+
'''The OAuth authorization parameters to use for the connection.
|
|
2207
2215
|
|
|
2208
2216
|
:param client_id: The client ID to use for OAuth authorization.
|
|
2209
2217
|
:param client_secret: The client secret assciated with the client ID to use for OAuth authorization.
|
|
@@ -2279,11 +2287,11 @@ class CfnConnection(
|
|
|
2279
2287
|
header_parameters: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Sequence[typing.Union[_IResolvable_da3f097b, typing.Union["CfnConnection.ParameterProperty", typing.Dict[builtins.str, typing.Any]]]]]] = None,
|
|
2280
2288
|
query_string_parameters: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Sequence[typing.Union[_IResolvable_da3f097b, typing.Union["CfnConnection.ParameterProperty", typing.Dict[builtins.str, typing.Any]]]]]] = None,
|
|
2281
2289
|
) -> None:
|
|
2282
|
-
'''
|
|
2290
|
+
'''Any additional parameters for the connection.
|
|
2283
2291
|
|
|
2284
|
-
:param body_parameters:
|
|
2285
|
-
:param header_parameters:
|
|
2286
|
-
:param query_string_parameters:
|
|
2292
|
+
:param body_parameters: Any additional body string parameters for the connection.
|
|
2293
|
+
:param header_parameters: Any additional header parameters for the connection.
|
|
2294
|
+
:param query_string_parameters: Any additional query string parameters for the connection.
|
|
2287
2295
|
|
|
2288
2296
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-connectionhttpparameters.html
|
|
2289
2297
|
:exampleMetadata: fixture=_generated
|
|
@@ -2335,7 +2343,7 @@ class CfnConnection(
|
|
|
2335
2343
|
def body_parameters(
|
|
2336
2344
|
self,
|
|
2337
2345
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnConnection.ParameterProperty"]]]]:
|
|
2338
|
-
'''
|
|
2346
|
+
'''Any additional body string parameters for the connection.
|
|
2339
2347
|
|
|
2340
2348
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-connectionhttpparameters.html#cfn-events-connection-connectionhttpparameters-bodyparameters
|
|
2341
2349
|
'''
|
|
@@ -2346,7 +2354,7 @@ class CfnConnection(
|
|
|
2346
2354
|
def header_parameters(
|
|
2347
2355
|
self,
|
|
2348
2356
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnConnection.ParameterProperty"]]]]:
|
|
2349
|
-
'''
|
|
2357
|
+
'''Any additional header parameters for the connection.
|
|
2350
2358
|
|
|
2351
2359
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-connectionhttpparameters.html#cfn-events-connection-connectionhttpparameters-headerparameters
|
|
2352
2360
|
'''
|
|
@@ -2357,7 +2365,7 @@ class CfnConnection(
|
|
|
2357
2365
|
def query_string_parameters(
|
|
2358
2366
|
self,
|
|
2359
2367
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnConnection.ParameterProperty"]]]]:
|
|
2360
|
-
'''
|
|
2368
|
+
'''Any additional query string parameters for the connection.
|
|
2361
2369
|
|
|
2362
2370
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-connectionhttpparameters.html#cfn-events-connection-connectionhttpparameters-querystringparameters
|
|
2363
2371
|
'''
|
|
@@ -2520,9 +2528,9 @@ class CfnConnection(
|
|
|
2520
2528
|
'''Contains the OAuth authorization parameters to use for the connection.
|
|
2521
2529
|
|
|
2522
2530
|
:param authorization_endpoint: The URL to the authorization endpoint when OAuth is specified as the authorization type.
|
|
2523
|
-
:param client_parameters:
|
|
2531
|
+
:param client_parameters: The client parameters for OAuth authorization.
|
|
2524
2532
|
:param http_method: The method to use for the authorization request.
|
|
2525
|
-
:param o_auth_http_parameters:
|
|
2533
|
+
:param o_auth_http_parameters: Details about the additional parameters to use for the connection.
|
|
2526
2534
|
|
|
2527
2535
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-oauthparameters.html
|
|
2528
2536
|
:exampleMetadata: fixture=_generated
|
|
@@ -2595,7 +2603,7 @@ class CfnConnection(
|
|
|
2595
2603
|
def client_parameters(
|
|
2596
2604
|
self,
|
|
2597
2605
|
) -> typing.Union[_IResolvable_da3f097b, "CfnConnection.ClientParametersProperty"]:
|
|
2598
|
-
'''
|
|
2606
|
+
'''The client parameters for OAuth authorization.
|
|
2599
2607
|
|
|
2600
2608
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-oauthparameters.html#cfn-events-connection-oauthparameters-clientparameters
|
|
2601
2609
|
'''
|
|
@@ -2617,7 +2625,7 @@ class CfnConnection(
|
|
|
2617
2625
|
def o_auth_http_parameters(
|
|
2618
2626
|
self,
|
|
2619
2627
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnConnection.ConnectionHttpParametersProperty"]]:
|
|
2620
|
-
'''
|
|
2628
|
+
'''Details about the additional parameters to use for the connection.
|
|
2621
2629
|
|
|
2622
2630
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-oauthparameters.html#cfn-events-connection-oauthparameters-oauthhttpparameters
|
|
2623
2631
|
'''
|
|
@@ -2652,7 +2660,7 @@ class CfnConnection(
|
|
|
2652
2660
|
value: builtins.str,
|
|
2653
2661
|
is_value_secret: typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]] = None,
|
|
2654
2662
|
) -> None:
|
|
2655
|
-
'''
|
|
2663
|
+
'''Any additional query string parameter for the connection.
|
|
2656
2664
|
|
|
2657
2665
|
You can include up to 100 additional query string parameters per request. Each additional parameter counts towards the event payload size, which cannot exceed 64 KB.
|
|
2658
2666
|
|
|
@@ -2750,7 +2758,7 @@ class CfnConnection(
|
|
|
2750
2758
|
) -> None:
|
|
2751
2759
|
'''
|
|
2752
2760
|
:param resource_configuration_arn:
|
|
2753
|
-
:param resource_association_arn:
|
|
2761
|
+
:param resource_association_arn: For connections to private APIs, the Amazon Resource Name (ARN) of the resource association EventBridge created between the connection and the private API's resource configuration. For more information, see `Managing service network resource associations for connections <https://docs.aws.amazon.com/eventbridge/latest/userguide/connection-private.html#connection-private-snra>`_ in the **Amazon EventBridge User Guide** .
|
|
2754
2762
|
|
|
2755
2763
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-resourceparameters.html
|
|
2756
2764
|
:exampleMetadata: fixture=_generated
|
|
@@ -2789,7 +2797,10 @@ class CfnConnection(
|
|
|
2789
2797
|
|
|
2790
2798
|
@builtins.property
|
|
2791
2799
|
def resource_association_arn(self) -> typing.Optional[builtins.str]:
|
|
2792
|
-
'''
|
|
2800
|
+
'''For connections to private APIs, the Amazon Resource Name (ARN) of the resource association EventBridge created between the connection and the private API's resource configuration.
|
|
2801
|
+
|
|
2802
|
+
For more information, see `Managing service network resource associations for connections <https://docs.aws.amazon.com/eventbridge/latest/userguide/connection-private.html#connection-private-snra>`_ in the **Amazon EventBridge User Guide** .
|
|
2803
|
+
|
|
2793
2804
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-resourceparameters.html#cfn-events-connection-resourceparameters-resourceassociationarn
|
|
2794
2805
|
'''
|
|
2795
2806
|
result = self._values.get("resource_association_arn")
|
|
@@ -2831,7 +2842,7 @@ class CfnConnectionProps:
|
|
|
2831
2842
|
'''Properties for defining a ``CfnConnection``.
|
|
2832
2843
|
|
|
2833
2844
|
:param authorization_type: The type of authorization to use for the connection. .. epigraph:: OAUTH tokens are refreshed when a 401 or 407 response is returned.
|
|
2834
|
-
:param auth_parameters:
|
|
2845
|
+
:param auth_parameters: The authorization parameters to use to authorize with the endpoint. You must include only authorization parameters for the ``AuthorizationType`` you specify.
|
|
2835
2846
|
:param description: A description for the connection to create.
|
|
2836
2847
|
:param invocation_connectivity_parameters: The private resource the HTTP request will be sent to.
|
|
2837
2848
|
:param name: The name for the connection to create.
|
|
@@ -2969,7 +2980,9 @@ class CfnConnectionProps:
|
|
|
2969
2980
|
def auth_parameters(
|
|
2970
2981
|
self,
|
|
2971
2982
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnConnection.AuthParametersProperty]]:
|
|
2972
|
-
'''
|
|
2983
|
+
'''The authorization parameters to use to authorize with the endpoint.
|
|
2984
|
+
|
|
2985
|
+
You must include only authorization parameters for the ``AuthorizationType`` you specify.
|
|
2973
2986
|
|
|
2974
2987
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html#cfn-events-connection-authparameters
|
|
2975
2988
|
'''
|
|
@@ -7186,7 +7199,7 @@ class CfnRule(
|
|
|
7186
7199
|
:param input_transformer: Settings to enable you to provide custom input to a target based on certain event data. You can extract one or more key-value pairs from the event and then use that data to send customized input to the target.
|
|
7187
7200
|
:param kinesis_parameters: The custom parameter you can use to control the shard assignment, when the target is a Kinesis data stream. If you do not include this parameter, the default is to use the ``eventId`` as the partition key.
|
|
7188
7201
|
:param redshift_data_parameters: Contains the Amazon Redshift Data API parameters to use when the target is a Amazon Redshift cluster. If you specify a Amazon Redshift Cluster as a Target, you can use this to specify parameters to invoke the Amazon Redshift Data API ExecuteStatement based on EventBridge events.
|
|
7189
|
-
:param retry_policy: The
|
|
7202
|
+
:param retry_policy: The retry policy configuration to use for the dead-letter queue.
|
|
7190
7203
|
:param role_arn: The Amazon Resource Name (ARN) of the IAM role to be used for this target when the rule is triggered. If one rule triggers multiple targets, you can use a different IAM role for each target.
|
|
7191
7204
|
:param run_command_parameters: Parameters used when you are using the rule to invoke Amazon EC2 Run Command.
|
|
7192
7205
|
:param sage_maker_pipeline_parameters: Contains the SageMaker Model Building Pipeline parameters to start execution of a SageMaker Model Building Pipeline. If you specify a SageMaker Model Building Pipeline as a target, you can use this to specify parameters to start a pipeline execution based on EventBridge events.
|
|
@@ -7522,7 +7535,7 @@ class CfnRule(
|
|
|
7522
7535
|
def retry_policy(
|
|
7523
7536
|
self,
|
|
7524
7537
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnRule.RetryPolicyProperty"]]:
|
|
7525
|
-
'''The
|
|
7538
|
+
'''The retry policy configuration to use for the dead-letter queue.
|
|
7526
7539
|
|
|
7527
7540
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-retrypolicy
|
|
7528
7541
|
'''
|
aws_cdk/aws_fsx/__init__.py
CHANGED
|
@@ -1026,6 +1026,7 @@ class CfnFileSystem(
|
|
|
1026
1026
|
data_compression_type="dataCompressionType",
|
|
1027
1027
|
deployment_type="deploymentType",
|
|
1028
1028
|
drive_cache_type="driveCacheType",
|
|
1029
|
+
efa_enabled=False,
|
|
1029
1030
|
export_path="exportPath",
|
|
1030
1031
|
imported_file_chunk_size=123,
|
|
1031
1032
|
import_path="importPath",
|
|
@@ -1070,6 +1071,10 @@ class CfnFileSystem(
|
|
|
1070
1071
|
endpoint_ip_address_range="endpointIpAddressRange",
|
|
1071
1072
|
options=["options"],
|
|
1072
1073
|
preferred_subnet_id="preferredSubnetId",
|
|
1074
|
+
read_cache_configuration=fsx.CfnFileSystem.ReadCacheConfigurationProperty(
|
|
1075
|
+
size_gi_b=123,
|
|
1076
|
+
sizing_mode="sizingMode"
|
|
1077
|
+
),
|
|
1073
1078
|
root_volume_configuration=fsx.CfnFileSystem.RootVolumeConfigurationProperty(
|
|
1074
1079
|
copy_tags_to_snapshots=False,
|
|
1075
1080
|
data_compression_type="dataCompressionType",
|
|
@@ -1165,7 +1170,7 @@ class CfnFileSystem(
|
|
|
1165
1170
|
:param open_zfs_configuration: The Amazon FSx for OpenZFS configuration properties for the file system that you are creating.
|
|
1166
1171
|
:param security_group_ids: A list of IDs specifying the security groups to apply to all network interfaces created for file system access. This list isn't returned in later requests to describe the file system. .. epigraph:: You must specify a security group if you are creating a Multi-AZ FSx for ONTAP file system in a VPC subnet that has been shared with you.
|
|
1167
1172
|
:param storage_capacity: Sets the storage capacity of the file system that you're creating. ``StorageCapacity`` is required if you are creating a new file system. It is not required if you are creating a file system by restoring a backup. *FSx for Lustre file systems* - The amount of storage capacity that you can configure depends on the value that you set for ``StorageType`` and the Lustre ``DeploymentType`` , as follows: - For ``SCRATCH_2`` , ``PERSISTENT_2`` and ``PERSISTENT_1`` deployment types using SSD storage type, the valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB. - For ``PERSISTENT_1`` HDD file systems, valid values are increments of 6000 GiB for 12 MB/s/TiB file systems and increments of 1800 GiB for 40 MB/s/TiB file systems. - For ``SCRATCH_1`` deployment type, valid values are 1200 GiB, 2400 GiB, and increments of 3600 GiB. *FSx for ONTAP file systems* - The amount of SSD storage capacity that you can configure depends on the value of the ``HAPairs`` property. The minimum value is calculated as 1,024 GiB * HAPairs and the maximum is calculated as 524,288 GiB * HAPairs, up to a maximum amount of SSD storage capacity of 1,048,576 GiB (1 pebibyte). *FSx for OpenZFS file systems* - The amount of storage capacity that you can configure is from 64 GiB up to 524,288 GiB (512 TiB). If you are creating a file system from a backup, you can specify a storage capacity equal to or greater than the original file system's storage capacity. *FSx for Windows File Server file systems* - The amount of storage capacity that you can configure depends on the value that you set for ``StorageType`` as follows: - For SSD storage, valid values are 32 GiB-65,536 GiB (64 TiB). - For HDD storage, valid values are 2000 GiB-65,536 GiB (64 TiB).
|
|
1168
|
-
:param storage_type: Sets the storage
|
|
1173
|
+
:param storage_type: Sets the storage class for the file system that you're creating. Valid values are ``SSD`` , ``HDD`` , and ``INTELLIGENT_TIERING`` . - Set to ``SSD`` to use solid state drive storage. SSD is supported on all Windows, Lustre, ONTAP, and OpenZFS deployment types. - Set to ``HDD`` to use hard disk drive storage. HDD is supported on ``SINGLE_AZ_2`` and ``MULTI_AZ_1`` Windows file system deployment types, and on ``PERSISTENT_1`` Lustre file system deployment types. - Set to ``INTELLIGENT_TIERING`` to use fully elastic, intelligently-tiered storage. Intelligent-Tiering is only available for OpenZFS file systems with the Multi-AZ deployment type. Default value is ``SSD`` . For more information, see `Storage type options <https://docs.aws.amazon.com/fsx/latest/WindowsGuide/optimize-fsx-costs.html#storage-type-options>`_ in the *FSx for Windows File Server User Guide* , `Multiple storage options <https://docs.aws.amazon.com/fsx/latest/LustreGuide/what-is.html#storage-options>`_ in the *FSx for Lustre User Guide* , and `Working with Intelligent-Tiering <https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance-intelligent-tiering>`_ in the *Amazon FSx for OpenZFS User Guide* .
|
|
1169
1174
|
:param tags: The tags to associate with the file system. For more information, see `Tagging your Amazon FSx resources <https://docs.aws.amazon.com/fsx/latest/LustreGuide/tag-resources.html>`_ in the *Amazon FSx for Lustre User Guide* .
|
|
1170
1175
|
:param windows_configuration: The configuration object for the Microsoft Windows file system you are creating. This value is required if ``FileSystemType`` is set to ``WINDOWS`` .
|
|
1171
1176
|
'''
|
|
@@ -1437,10 +1442,7 @@ class CfnFileSystem(
|
|
|
1437
1442
|
@builtins.property
|
|
1438
1443
|
@jsii.member(jsii_name="storageType")
|
|
1439
1444
|
def storage_type(self) -> typing.Optional[builtins.str]:
|
|
1440
|
-
'''Sets the storage
|
|
1441
|
-
|
|
1442
|
-
Valid values are ``SSD`` and ``HDD`` .
|
|
1443
|
-
'''
|
|
1445
|
+
'''Sets the storage class for the file system that you're creating.'''
|
|
1444
1446
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "storageType"))
|
|
1445
1447
|
|
|
1446
1448
|
@storage_type.setter
|
|
@@ -1753,6 +1755,7 @@ class CfnFileSystem(
|
|
|
1753
1755
|
"data_compression_type": "dataCompressionType",
|
|
1754
1756
|
"deployment_type": "deploymentType",
|
|
1755
1757
|
"drive_cache_type": "driveCacheType",
|
|
1758
|
+
"efa_enabled": "efaEnabled",
|
|
1756
1759
|
"export_path": "exportPath",
|
|
1757
1760
|
"imported_file_chunk_size": "importedFileChunkSize",
|
|
1758
1761
|
"import_path": "importPath",
|
|
@@ -1772,6 +1775,7 @@ class CfnFileSystem(
|
|
|
1772
1775
|
data_compression_type: typing.Optional[builtins.str] = None,
|
|
1773
1776
|
deployment_type: typing.Optional[builtins.str] = None,
|
|
1774
1777
|
drive_cache_type: typing.Optional[builtins.str] = None,
|
|
1778
|
+
efa_enabled: typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]] = None,
|
|
1775
1779
|
export_path: typing.Optional[builtins.str] = None,
|
|
1776
1780
|
imported_file_chunk_size: typing.Optional[jsii.Number] = None,
|
|
1777
1781
|
import_path: typing.Optional[builtins.str] = None,
|
|
@@ -1788,6 +1792,7 @@ class CfnFileSystem(
|
|
|
1788
1792
|
:param data_compression_type: Sets the data compression configuration for the file system. ``DataCompressionType`` can have the following values:. - ``NONE`` - (Default) Data compression is turned off when the file system is created. - ``LZ4`` - Data compression is turned on with the LZ4 algorithm. For more information, see `Lustre data compression <https://docs.aws.amazon.com/fsx/latest/LustreGuide/data-compression.html>`_ in the *Amazon FSx for Lustre User Guide* .
|
|
1789
1793
|
:param deployment_type: (Optional) Choose ``SCRATCH_1`` and ``SCRATCH_2`` deployment types when you need temporary storage and shorter-term processing of data. The ``SCRATCH_2`` deployment type provides in-transit encryption of data and higher burst throughput capacity than ``SCRATCH_1`` . Choose ``PERSISTENT_1`` for longer-term storage and for throughput-focused workloads that aren’t latency-sensitive. ``PERSISTENT_1`` supports encryption of data in transit, and is available in all AWS Regions in which FSx for Lustre is available. Choose ``PERSISTENT_2`` for longer-term storage and for latency-sensitive workloads that require the highest levels of IOPS/throughput. ``PERSISTENT_2`` supports SSD storage, and offers higher ``PerUnitStorageThroughput`` (up to 1000 MB/s/TiB). You can optionally specify a metadata configuration mode for ``PERSISTENT_2`` which supports increasing metadata performance. ``PERSISTENT_2`` is available in a limited number of AWS Regions . For more information, and an up-to-date list of AWS Regions in which ``PERSISTENT_2`` is available, see `File system deployment options for FSx for Lustre <https://docs.aws.amazon.com/fsx/latest/LustreGuide/using-fsx-lustre.html#lustre-deployment-types>`_ in the *Amazon FSx for Lustre User Guide* . .. epigraph:: If you choose ``PERSISTENT_2`` , and you set ``FileSystemTypeVersion`` to ``2.10`` , the ``CreateFileSystem`` operation fails. Encryption of data in transit is automatically turned on when you access ``SCRATCH_2`` , ``PERSISTENT_1`` , and ``PERSISTENT_2`` file systems from Amazon EC2 instances that support automatic encryption in the AWS Regions where they are available. For more information about encryption in transit for FSx for Lustre file systems, see `Encrypting data in transit <https://docs.aws.amazon.com/fsx/latest/LustreGuide/encryption-in-transit-fsxl.html>`_ in the *Amazon FSx for Lustre User Guide* . (Default = ``SCRATCH_1`` )
|
|
1790
1794
|
:param drive_cache_type: The type of drive cache used by ``PERSISTENT_1`` file systems that are provisioned with HDD storage devices. This parameter is required when storage type is HDD. Set this property to ``READ`` to improve the performance for frequently accessed files by caching up to 20% of the total storage capacity of the file system. This parameter is required when ``StorageType`` is set to ``HDD`` and ``DeploymentType`` is ``PERSISTENT_1`` .
|
|
1795
|
+
:param efa_enabled:
|
|
1791
1796
|
:param export_path: (Optional) Specifies the path in the Amazon S3 bucket where the root of your Amazon FSx file system is exported. The path must use the same Amazon S3 bucket as specified in ImportPath. You can provide an optional prefix to which new and changed data is to be exported from your Amazon FSx for Lustre file system. If an ``ExportPath`` value is not provided, Amazon FSx sets a default export path, ``s3://import-bucket/FSxLustre[creation-timestamp]`` . The timestamp is in UTC format, for example ``s3://import-bucket/FSxLustre20181105T222312Z`` . The Amazon S3 export bucket must be the same as the import bucket specified by ``ImportPath`` . If you specify only a bucket name, such as ``s3://import-bucket`` , you get a 1:1 mapping of file system objects to S3 bucket objects. This mapping means that the input data in S3 is overwritten on export. If you provide a custom prefix in the export path, such as ``s3://import-bucket/[custom-optional-prefix]`` , Amazon FSx exports the contents of your file system to that export prefix in the Amazon S3 bucket. .. epigraph:: This parameter is not supported for file systems with a data repository association.
|
|
1792
1797
|
:param imported_file_chunk_size: (Optional) For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system. The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB. .. epigraph:: This parameter is not supported for Lustre file systems with a data repository association.
|
|
1793
1798
|
:param import_path: (Optional) The path to the Amazon S3 bucket (including the optional prefix) that you're using as the data repository for your Amazon FSx for Lustre file system. The root of your FSx for Lustre file system will be mapped to the root of the Amazon S3 bucket you select. An example is ``s3://import-bucket/optional-prefix`` . If you specify a prefix after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system. .. epigraph:: This parameter is not supported for Lustre file systems with a data repository association.
|
|
@@ -1812,6 +1817,7 @@ class CfnFileSystem(
|
|
|
1812
1817
|
data_compression_type="dataCompressionType",
|
|
1813
1818
|
deployment_type="deploymentType",
|
|
1814
1819
|
drive_cache_type="driveCacheType",
|
|
1820
|
+
efa_enabled=False,
|
|
1815
1821
|
export_path="exportPath",
|
|
1816
1822
|
imported_file_chunk_size=123,
|
|
1817
1823
|
import_path="importPath",
|
|
@@ -1832,6 +1838,7 @@ class CfnFileSystem(
|
|
|
1832
1838
|
check_type(argname="argument data_compression_type", value=data_compression_type, expected_type=type_hints["data_compression_type"])
|
|
1833
1839
|
check_type(argname="argument deployment_type", value=deployment_type, expected_type=type_hints["deployment_type"])
|
|
1834
1840
|
check_type(argname="argument drive_cache_type", value=drive_cache_type, expected_type=type_hints["drive_cache_type"])
|
|
1841
|
+
check_type(argname="argument efa_enabled", value=efa_enabled, expected_type=type_hints["efa_enabled"])
|
|
1835
1842
|
check_type(argname="argument export_path", value=export_path, expected_type=type_hints["export_path"])
|
|
1836
1843
|
check_type(argname="argument imported_file_chunk_size", value=imported_file_chunk_size, expected_type=type_hints["imported_file_chunk_size"])
|
|
1837
1844
|
check_type(argname="argument import_path", value=import_path, expected_type=type_hints["import_path"])
|
|
@@ -1853,6 +1860,8 @@ class CfnFileSystem(
|
|
|
1853
1860
|
self._values["deployment_type"] = deployment_type
|
|
1854
1861
|
if drive_cache_type is not None:
|
|
1855
1862
|
self._values["drive_cache_type"] = drive_cache_type
|
|
1863
|
+
if efa_enabled is not None:
|
|
1864
|
+
self._values["efa_enabled"] = efa_enabled
|
|
1856
1865
|
if export_path is not None:
|
|
1857
1866
|
self._values["export_path"] = export_path
|
|
1858
1867
|
if imported_file_chunk_size is not None:
|
|
@@ -1975,6 +1984,16 @@ class CfnFileSystem(
|
|
|
1975
1984
|
result = self._values.get("drive_cache_type")
|
|
1976
1985
|
return typing.cast(typing.Optional[builtins.str], result)
|
|
1977
1986
|
|
|
1987
|
+
@builtins.property
|
|
1988
|
+
def efa_enabled(
|
|
1989
|
+
self,
|
|
1990
|
+
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
1991
|
+
'''
|
|
1992
|
+
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-lustreconfiguration.html#cfn-fsx-filesystem-lustreconfiguration-efaenabled
|
|
1993
|
+
'''
|
|
1994
|
+
result = self._values.get("efa_enabled")
|
|
1995
|
+
return typing.cast(typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]], result)
|
|
1996
|
+
|
|
1978
1997
|
@builtins.property
|
|
1979
1998
|
def export_path(self) -> typing.Optional[builtins.str]:
|
|
1980
1999
|
'''(Optional) Specifies the path in the Amazon S3 bucket where the root of your Amazon FSx file system is exported.
|
|
@@ -2509,6 +2528,7 @@ class CfnFileSystem(
|
|
|
2509
2528
|
"endpoint_ip_address_range": "endpointIpAddressRange",
|
|
2510
2529
|
"options": "options",
|
|
2511
2530
|
"preferred_subnet_id": "preferredSubnetId",
|
|
2531
|
+
"read_cache_configuration": "readCacheConfiguration",
|
|
2512
2532
|
"root_volume_configuration": "rootVolumeConfiguration",
|
|
2513
2533
|
"route_table_ids": "routeTableIds",
|
|
2514
2534
|
"throughput_capacity": "throughputCapacity",
|
|
@@ -2528,6 +2548,7 @@ class CfnFileSystem(
|
|
|
2528
2548
|
endpoint_ip_address_range: typing.Optional[builtins.str] = None,
|
|
2529
2549
|
options: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
2530
2550
|
preferred_subnet_id: typing.Optional[builtins.str] = None,
|
|
2551
|
+
read_cache_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnFileSystem.ReadCacheConfigurationProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
2531
2552
|
root_volume_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnFileSystem.RootVolumeConfigurationProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
2532
2553
|
route_table_ids: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
2533
2554
|
throughput_capacity: typing.Optional[jsii.Number] = None,
|
|
@@ -2544,6 +2565,7 @@ class CfnFileSystem(
|
|
|
2544
2565
|
:param endpoint_ip_address_range: (Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created. By default in the Amazon FSx API and Amazon FSx console, Amazon FSx selects an available /28 IP address range for you from one of the VPC's CIDR ranges. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables.
|
|
2545
2566
|
:param options: To delete a file system if there are child volumes present below the root volume, use the string ``DELETE_CHILD_VOLUMES_AND_SNAPSHOTS`` . If your file system has child volumes and you don't use this option, the delete request will fail.
|
|
2546
2567
|
:param preferred_subnet_id: Required when ``DeploymentType`` is set to ``MULTI_AZ_1`` . This specifies the subnet in which you want the preferred file server to be located.
|
|
2568
|
+
:param read_cache_configuration:
|
|
2547
2569
|
:param root_volume_configuration: The configuration Amazon FSx uses when creating the root value of the Amazon FSx for OpenZFS file system. All volumes are children of the root volume.
|
|
2548
2570
|
:param route_table_ids: (Multi-AZ only) Specifies the route tables in which Amazon FSx creates the rules for routing traffic to the correct file server. You should specify all virtual private cloud (VPC) route tables associated with the subnets in which your clients are located. By default, Amazon FSx selects your VPC's default route table.
|
|
2549
2571
|
:param throughput_capacity: Specifies the throughput of an Amazon FSx for OpenZFS file system, measured in megabytes per second (MBps). Valid values depend on the DeploymentType you choose, as follows: - For ``MULTI_AZ_1`` and ``SINGLE_AZ_2`` , valid values are 160, 320, 640, 1280, 2560, 3840, 5120, 7680, or 10240 MBps. - For ``SINGLE_AZ_1`` , valid values are 64, 128, 256, 512, 1024, 2048, 3072, or 4096 MBps. You pay for additional throughput capacity that you provision.
|
|
@@ -2573,6 +2595,10 @@ class CfnFileSystem(
|
|
|
2573
2595
|
endpoint_ip_address_range="endpointIpAddressRange",
|
|
2574
2596
|
options=["options"],
|
|
2575
2597
|
preferred_subnet_id="preferredSubnetId",
|
|
2598
|
+
read_cache_configuration=fsx.CfnFileSystem.ReadCacheConfigurationProperty(
|
|
2599
|
+
size_gi_b=123,
|
|
2600
|
+
sizing_mode="sizingMode"
|
|
2601
|
+
),
|
|
2576
2602
|
root_volume_configuration=fsx.CfnFileSystem.RootVolumeConfigurationProperty(
|
|
2577
2603
|
copy_tags_to_snapshots=False,
|
|
2578
2604
|
data_compression_type="dataCompressionType",
|
|
@@ -2606,6 +2632,7 @@ class CfnFileSystem(
|
|
|
2606
2632
|
check_type(argname="argument endpoint_ip_address_range", value=endpoint_ip_address_range, expected_type=type_hints["endpoint_ip_address_range"])
|
|
2607
2633
|
check_type(argname="argument options", value=options, expected_type=type_hints["options"])
|
|
2608
2634
|
check_type(argname="argument preferred_subnet_id", value=preferred_subnet_id, expected_type=type_hints["preferred_subnet_id"])
|
|
2635
|
+
check_type(argname="argument read_cache_configuration", value=read_cache_configuration, expected_type=type_hints["read_cache_configuration"])
|
|
2609
2636
|
check_type(argname="argument root_volume_configuration", value=root_volume_configuration, expected_type=type_hints["root_volume_configuration"])
|
|
2610
2637
|
check_type(argname="argument route_table_ids", value=route_table_ids, expected_type=type_hints["route_table_ids"])
|
|
2611
2638
|
check_type(argname="argument throughput_capacity", value=throughput_capacity, expected_type=type_hints["throughput_capacity"])
|
|
@@ -2629,6 +2656,8 @@ class CfnFileSystem(
|
|
|
2629
2656
|
self._values["options"] = options
|
|
2630
2657
|
if preferred_subnet_id is not None:
|
|
2631
2658
|
self._values["preferred_subnet_id"] = preferred_subnet_id
|
|
2659
|
+
if read_cache_configuration is not None:
|
|
2660
|
+
self._values["read_cache_configuration"] = read_cache_configuration
|
|
2632
2661
|
if root_volume_configuration is not None:
|
|
2633
2662
|
self._values["root_volume_configuration"] = root_volume_configuration
|
|
2634
2663
|
if route_table_ids is not None:
|
|
@@ -2750,6 +2779,16 @@ class CfnFileSystem(
|
|
|
2750
2779
|
result = self._values.get("preferred_subnet_id")
|
|
2751
2780
|
return typing.cast(typing.Optional[builtins.str], result)
|
|
2752
2781
|
|
|
2782
|
+
@builtins.property
|
|
2783
|
+
def read_cache_configuration(
|
|
2784
|
+
self,
|
|
2785
|
+
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnFileSystem.ReadCacheConfigurationProperty"]]:
|
|
2786
|
+
'''
|
|
2787
|
+
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration.html#cfn-fsx-filesystem-openzfsconfiguration-readcacheconfiguration
|
|
2788
|
+
'''
|
|
2789
|
+
result = self._values.get("read_cache_configuration")
|
|
2790
|
+
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnFileSystem.ReadCacheConfigurationProperty"]], result)
|
|
2791
|
+
|
|
2753
2792
|
@builtins.property
|
|
2754
2793
|
def root_volume_configuration(
|
|
2755
2794
|
self,
|
|
@@ -2816,6 +2855,73 @@ class CfnFileSystem(
|
|
|
2816
2855
|
k + "=" + repr(v) for k, v in self._values.items()
|
|
2817
2856
|
)
|
|
2818
2857
|
|
|
2858
|
+
@jsii.data_type(
|
|
2859
|
+
jsii_type="aws-cdk-lib.aws_fsx.CfnFileSystem.ReadCacheConfigurationProperty",
|
|
2860
|
+
jsii_struct_bases=[],
|
|
2861
|
+
name_mapping={"size_gib": "sizeGiB", "sizing_mode": "sizingMode"},
|
|
2862
|
+
)
|
|
2863
|
+
class ReadCacheConfigurationProperty:
|
|
2864
|
+
def __init__(
|
|
2865
|
+
self,
|
|
2866
|
+
*,
|
|
2867
|
+
size_gib: typing.Optional[jsii.Number] = None,
|
|
2868
|
+
sizing_mode: typing.Optional[builtins.str] = None,
|
|
2869
|
+
) -> None:
|
|
2870
|
+
'''
|
|
2871
|
+
:param size_gib:
|
|
2872
|
+
:param sizing_mode:
|
|
2873
|
+
|
|
2874
|
+
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-readcacheconfiguration.html
|
|
2875
|
+
:exampleMetadata: fixture=_generated
|
|
2876
|
+
|
|
2877
|
+
Example::
|
|
2878
|
+
|
|
2879
|
+
# The code below shows an example of how to instantiate this type.
|
|
2880
|
+
# The values are placeholders you should change.
|
|
2881
|
+
from aws_cdk import aws_fsx as fsx
|
|
2882
|
+
|
|
2883
|
+
read_cache_configuration_property = fsx.CfnFileSystem.ReadCacheConfigurationProperty(
|
|
2884
|
+
size_gi_b=123,
|
|
2885
|
+
sizing_mode="sizingMode"
|
|
2886
|
+
)
|
|
2887
|
+
'''
|
|
2888
|
+
if __debug__:
|
|
2889
|
+
type_hints = typing.get_type_hints(_typecheckingstub__5da424653f281066f7140c38ddd8b33a2fdb52a49e2f3ecfacac378ab1825ad9)
|
|
2890
|
+
check_type(argname="argument size_gib", value=size_gib, expected_type=type_hints["size_gib"])
|
|
2891
|
+
check_type(argname="argument sizing_mode", value=sizing_mode, expected_type=type_hints["sizing_mode"])
|
|
2892
|
+
self._values: typing.Dict[builtins.str, typing.Any] = {}
|
|
2893
|
+
if size_gib is not None:
|
|
2894
|
+
self._values["size_gib"] = size_gib
|
|
2895
|
+
if sizing_mode is not None:
|
|
2896
|
+
self._values["sizing_mode"] = sizing_mode
|
|
2897
|
+
|
|
2898
|
+
@builtins.property
|
|
2899
|
+
def size_gib(self) -> typing.Optional[jsii.Number]:
|
|
2900
|
+
'''
|
|
2901
|
+
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-readcacheconfiguration.html#cfn-fsx-filesystem-readcacheconfiguration-sizegib
|
|
2902
|
+
'''
|
|
2903
|
+
result = self._values.get("size_gib")
|
|
2904
|
+
return typing.cast(typing.Optional[jsii.Number], result)
|
|
2905
|
+
|
|
2906
|
+
@builtins.property
|
|
2907
|
+
def sizing_mode(self) -> typing.Optional[builtins.str]:
|
|
2908
|
+
'''
|
|
2909
|
+
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-readcacheconfiguration.html#cfn-fsx-filesystem-readcacheconfiguration-sizingmode
|
|
2910
|
+
'''
|
|
2911
|
+
result = self._values.get("sizing_mode")
|
|
2912
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
|
2913
|
+
|
|
2914
|
+
def __eq__(self, rhs: typing.Any) -> builtins.bool:
|
|
2915
|
+
return isinstance(rhs, self.__class__) and rhs._values == self._values
|
|
2916
|
+
|
|
2917
|
+
def __ne__(self, rhs: typing.Any) -> builtins.bool:
|
|
2918
|
+
return not (rhs == self)
|
|
2919
|
+
|
|
2920
|
+
def __repr__(self) -> str:
|
|
2921
|
+
return "ReadCacheConfigurationProperty(%s)" % ", ".join(
|
|
2922
|
+
k + "=" + repr(v) for k, v in self._values.items()
|
|
2923
|
+
)
|
|
2924
|
+
|
|
2819
2925
|
@jsii.data_type(
|
|
2820
2926
|
jsii_type="aws-cdk-lib.aws_fsx.CfnFileSystem.RootVolumeConfigurationProperty",
|
|
2821
2927
|
jsii_struct_bases=[],
|
|
@@ -3574,7 +3680,7 @@ class CfnFileSystemProps:
|
|
|
3574
3680
|
:param open_zfs_configuration: The Amazon FSx for OpenZFS configuration properties for the file system that you are creating.
|
|
3575
3681
|
:param security_group_ids: A list of IDs specifying the security groups to apply to all network interfaces created for file system access. This list isn't returned in later requests to describe the file system. .. epigraph:: You must specify a security group if you are creating a Multi-AZ FSx for ONTAP file system in a VPC subnet that has been shared with you.
|
|
3576
3682
|
:param storage_capacity: Sets the storage capacity of the file system that you're creating. ``StorageCapacity`` is required if you are creating a new file system. It is not required if you are creating a file system by restoring a backup. *FSx for Lustre file systems* - The amount of storage capacity that you can configure depends on the value that you set for ``StorageType`` and the Lustre ``DeploymentType`` , as follows: - For ``SCRATCH_2`` , ``PERSISTENT_2`` and ``PERSISTENT_1`` deployment types using SSD storage type, the valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB. - For ``PERSISTENT_1`` HDD file systems, valid values are increments of 6000 GiB for 12 MB/s/TiB file systems and increments of 1800 GiB for 40 MB/s/TiB file systems. - For ``SCRATCH_1`` deployment type, valid values are 1200 GiB, 2400 GiB, and increments of 3600 GiB. *FSx for ONTAP file systems* - The amount of SSD storage capacity that you can configure depends on the value of the ``HAPairs`` property. The minimum value is calculated as 1,024 GiB * HAPairs and the maximum is calculated as 524,288 GiB * HAPairs, up to a maximum amount of SSD storage capacity of 1,048,576 GiB (1 pebibyte). *FSx for OpenZFS file systems* - The amount of storage capacity that you can configure is from 64 GiB up to 524,288 GiB (512 TiB). If you are creating a file system from a backup, you can specify a storage capacity equal to or greater than the original file system's storage capacity. *FSx for Windows File Server file systems* - The amount of storage capacity that you can configure depends on the value that you set for ``StorageType`` as follows: - For SSD storage, valid values are 32 GiB-65,536 GiB (64 TiB). - For HDD storage, valid values are 2000 GiB-65,536 GiB (64 TiB).
|
|
3577
|
-
:param storage_type: Sets the storage
|
|
3683
|
+
:param storage_type: Sets the storage class for the file system that you're creating. Valid values are ``SSD`` , ``HDD`` , and ``INTELLIGENT_TIERING`` . - Set to ``SSD`` to use solid state drive storage. SSD is supported on all Windows, Lustre, ONTAP, and OpenZFS deployment types. - Set to ``HDD`` to use hard disk drive storage. HDD is supported on ``SINGLE_AZ_2`` and ``MULTI_AZ_1`` Windows file system deployment types, and on ``PERSISTENT_1`` Lustre file system deployment types. - Set to ``INTELLIGENT_TIERING`` to use fully elastic, intelligently-tiered storage. Intelligent-Tiering is only available for OpenZFS file systems with the Multi-AZ deployment type. Default value is ``SSD`` . For more information, see `Storage type options <https://docs.aws.amazon.com/fsx/latest/WindowsGuide/optimize-fsx-costs.html#storage-type-options>`_ in the *FSx for Windows File Server User Guide* , `Multiple storage options <https://docs.aws.amazon.com/fsx/latest/LustreGuide/what-is.html#storage-options>`_ in the *FSx for Lustre User Guide* , and `Working with Intelligent-Tiering <https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance-intelligent-tiering>`_ in the *Amazon FSx for OpenZFS User Guide* .
|
|
3578
3684
|
:param tags: The tags to associate with the file system. For more information, see `Tagging your Amazon FSx resources <https://docs.aws.amazon.com/fsx/latest/LustreGuide/tag-resources.html>`_ in the *Amazon FSx for Lustre User Guide* .
|
|
3579
3685
|
:param windows_configuration: The configuration object for the Microsoft Windows file system you are creating. This value is required if ``FileSystemType`` is set to ``WINDOWS`` .
|
|
3580
3686
|
|
|
@@ -3603,6 +3709,7 @@ class CfnFileSystemProps:
|
|
|
3603
3709
|
data_compression_type="dataCompressionType",
|
|
3604
3710
|
deployment_type="deploymentType",
|
|
3605
3711
|
drive_cache_type="driveCacheType",
|
|
3712
|
+
efa_enabled=False,
|
|
3606
3713
|
export_path="exportPath",
|
|
3607
3714
|
imported_file_chunk_size=123,
|
|
3608
3715
|
import_path="importPath",
|
|
@@ -3647,6 +3754,10 @@ class CfnFileSystemProps:
|
|
|
3647
3754
|
endpoint_ip_address_range="endpointIpAddressRange",
|
|
3648
3755
|
options=["options"],
|
|
3649
3756
|
preferred_subnet_id="preferredSubnetId",
|
|
3757
|
+
read_cache_configuration=fsx.CfnFileSystem.ReadCacheConfigurationProperty(
|
|
3758
|
+
size_gi_b=123,
|
|
3759
|
+
sizing_mode="sizingMode"
|
|
3760
|
+
),
|
|
3650
3761
|
root_volume_configuration=fsx.CfnFileSystem.RootVolumeConfigurationProperty(
|
|
3651
3762
|
copy_tags_to_snapshots=False,
|
|
3652
3763
|
data_compression_type="dataCompressionType",
|
|
@@ -3909,12 +4020,15 @@ class CfnFileSystemProps:
|
|
|
3909
4020
|
|
|
3910
4021
|
@builtins.property
|
|
3911
4022
|
def storage_type(self) -> typing.Optional[builtins.str]:
|
|
3912
|
-
'''Sets the storage
|
|
4023
|
+
'''Sets the storage class for the file system that you're creating.
|
|
4024
|
+
|
|
4025
|
+
Valid values are ``SSD`` , ``HDD`` , and ``INTELLIGENT_TIERING`` .
|
|
3913
4026
|
|
|
3914
4027
|
- Set to ``SSD`` to use solid state drive storage. SSD is supported on all Windows, Lustre, ONTAP, and OpenZFS deployment types.
|
|
3915
4028
|
- Set to ``HDD`` to use hard disk drive storage. HDD is supported on ``SINGLE_AZ_2`` and ``MULTI_AZ_1`` Windows file system deployment types, and on ``PERSISTENT_1`` Lustre file system deployment types.
|
|
4029
|
+
- Set to ``INTELLIGENT_TIERING`` to use fully elastic, intelligently-tiered storage. Intelligent-Tiering is only available for OpenZFS file systems with the Multi-AZ deployment type.
|
|
3916
4030
|
|
|
3917
|
-
Default value is ``SSD`` . For more information, see `Storage type options <https://docs.aws.amazon.com/fsx/latest/WindowsGuide/optimize-fsx-costs.html#storage-type-options>`_ in the *FSx for Windows File Server User Guide*
|
|
4031
|
+
Default value is ``SSD`` . For more information, see `Storage type options <https://docs.aws.amazon.com/fsx/latest/WindowsGuide/optimize-fsx-costs.html#storage-type-options>`_ in the *FSx for Windows File Server User Guide* , `Multiple storage options <https://docs.aws.amazon.com/fsx/latest/LustreGuide/what-is.html#storage-options>`_ in the *FSx for Lustre User Guide* , and `Working with Intelligent-Tiering <https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance-intelligent-tiering>`_ in the *Amazon FSx for OpenZFS User Guide* .
|
|
3918
4032
|
|
|
3919
4033
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#cfn-fsx-filesystem-storagetype
|
|
3920
4034
|
'''
|
|
@@ -5837,7 +5951,7 @@ class CfnVolume(
|
|
|
5837
5951
|
:param options: To delete the volume's child volumes, snapshots, and clones, use the string ``DELETE_CHILD_VOLUMES_AND_SNAPSHOTS`` .
|
|
5838
5952
|
:param origin_snapshot: The configuration object that specifies the snapshot to use as the origin of the data for the volume.
|
|
5839
5953
|
:param read_only: A Boolean value indicating whether the volume is read-only.
|
|
5840
|
-
:param record_size_kib: Specifies the suggested block size for a volume in a ZFS dataset, in kibibytes (KiB).
|
|
5954
|
+
:param record_size_kib: Specifies the suggested block size for a volume in a ZFS dataset, in kibibytes (KiB). For file systems using the Intelligent-Tiering storage class, valid values are 128, 256, 512, 1024, 2048, or 4096 KiB, with a default of 1024 KiB. For all other file systems, valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB, with a default of 128 KiB. We recommend using the default setting for the majority of use cases. Generally, workloads that write in fixed small or large record sizes may benefit from setting a custom record size, like database workloads (small record size) or media streaming workloads (large record size). For additional guidance on when to set a custom record size, see `ZFS Record size <https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance.html#record-size-performance>`_ in the *Amazon FSx for OpenZFS User Guide* .
|
|
5841
5955
|
:param storage_capacity_quota_gib: Sets the maximum storage size in gibibytes (GiB) for the volume. You can specify a quota that is larger than the storage on the parent volume. A volume quota limits the amount of storage that the volume can consume to the configured amount, but does not guarantee the space will be available on the parent volume. To guarantee quota space, you must also set ``StorageCapacityReservationGiB`` . To *not* specify a storage capacity quota, set this to ``-1`` . For more information, see `Volume properties <https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/managing-volumes.html#volume-properties>`_ in the *Amazon FSx for OpenZFS User Guide* .
|
|
5842
5956
|
:param storage_capacity_reservation_gib: Specifies the amount of storage in gibibytes (GiB) to reserve from the parent volume. Setting ``StorageCapacityReservationGiB`` guarantees that the specified amount of storage space on the parent volume will always be available for the volume. You can't reserve more storage than the parent volume has. To *not* specify a storage capacity reservation, set this to ``0`` or ``-1`` . For more information, see `Volume properties <https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/managing-volumes.html#volume-properties>`_ in the *Amazon FSx for OpenZFS User Guide* .
|
|
5843
5957
|
:param user_and_group_quotas: Configures how much storage users and groups can use on the volume.
|
|
@@ -5998,7 +6112,7 @@ class CfnVolume(
|
|
|
5998
6112
|
def record_size_kib(self) -> typing.Optional[jsii.Number]:
|
|
5999
6113
|
'''Specifies the suggested block size for a volume in a ZFS dataset, in kibibytes (KiB).
|
|
6000
6114
|
|
|
6001
|
-
|
|
6115
|
+
For file systems using the Intelligent-Tiering storage class, valid values are 128, 256, 512, 1024, 2048, or 4096 KiB, with a default of 1024 KiB. For all other file systems, valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB, with a default of 128 KiB. We recommend using the default setting for the majority of use cases. Generally, workloads that write in fixed small or large record sizes may benefit from setting a custom record size, like database workloads (small record size) or media streaming workloads (large record size). For additional guidance on when to set a custom record size, see `ZFS Record size <https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance.html#record-size-performance>`_ in the *Amazon FSx for OpenZFS User Guide* .
|
|
6002
6116
|
|
|
6003
6117
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-openzfsconfiguration.html#cfn-fsx-volume-openzfsconfiguration-recordsizekib
|
|
6004
6118
|
'''
|
|
@@ -8684,6 +8798,7 @@ def _typecheckingstub__8e1fe808b96f0eb1b8b6ed8eb3d551c8d995fe2c98c9be554bed33160
|
|
|
8684
8798
|
data_compression_type: typing.Optional[builtins.str] = None,
|
|
8685
8799
|
deployment_type: typing.Optional[builtins.str] = None,
|
|
8686
8800
|
drive_cache_type: typing.Optional[builtins.str] = None,
|
|
8801
|
+
efa_enabled: typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]] = None,
|
|
8687
8802
|
export_path: typing.Optional[builtins.str] = None,
|
|
8688
8803
|
imported_file_chunk_size: typing.Optional[jsii.Number] = None,
|
|
8689
8804
|
import_path: typing.Optional[builtins.str] = None,
|
|
@@ -8738,6 +8853,7 @@ def _typecheckingstub__5472f29690b088eacdf6c6853ffd8b23cd15c760dc30d812107be1280
|
|
|
8738
8853
|
endpoint_ip_address_range: typing.Optional[builtins.str] = None,
|
|
8739
8854
|
options: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
8740
8855
|
preferred_subnet_id: typing.Optional[builtins.str] = None,
|
|
8856
|
+
read_cache_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union[CfnFileSystem.ReadCacheConfigurationProperty, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
8741
8857
|
root_volume_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union[CfnFileSystem.RootVolumeConfigurationProperty, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
8742
8858
|
route_table_ids: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
8743
8859
|
throughput_capacity: typing.Optional[jsii.Number] = None,
|
|
@@ -8746,6 +8862,14 @@ def _typecheckingstub__5472f29690b088eacdf6c6853ffd8b23cd15c760dc30d812107be1280
|
|
|
8746
8862
|
"""Type checking stubs"""
|
|
8747
8863
|
pass
|
|
8748
8864
|
|
|
8865
|
+
def _typecheckingstub__5da424653f281066f7140c38ddd8b33a2fdb52a49e2f3ecfacac378ab1825ad9(
|
|
8866
|
+
*,
|
|
8867
|
+
size_gib: typing.Optional[jsii.Number] = None,
|
|
8868
|
+
sizing_mode: typing.Optional[builtins.str] = None,
|
|
8869
|
+
) -> None:
|
|
8870
|
+
"""Type checking stubs"""
|
|
8871
|
+
pass
|
|
8872
|
+
|
|
8749
8873
|
def _typecheckingstub__7c2a873402766c6577ffe7568330e8c952efaedecdfd993af4793d2ea6d69f8b(
|
|
8750
8874
|
*,
|
|
8751
8875
|
copy_tags_to_snapshots: typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]] = None,
|