aws-cdk-lib 2.172.0__py3-none-any.whl → 2.173.0__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.0.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.0.dist-info}/METADATA +1 -1
- {aws_cdk_lib-2.172.0.dist-info → aws_cdk_lib-2.173.0.dist-info}/RECORD +69 -68
- {aws_cdk_lib-2.172.0.dist-info → aws_cdk_lib-2.173.0.dist-info}/LICENSE +0 -0
- {aws_cdk_lib-2.172.0.dist-info → aws_cdk_lib-2.173.0.dist-info}/NOTICE +0 -0
- {aws_cdk_lib-2.172.0.dist-info → aws_cdk_lib-2.173.0.dist-info}/WHEEL +0 -0
- {aws_cdk_lib-2.172.0.dist-info → aws_cdk_lib-2.173.0.dist-info}/top_level.txt +0 -0
|
@@ -4974,6 +4974,8 @@ class CfnBasePathMapping(
|
|
|
4974
4974
|
):
|
|
4975
4975
|
'''The ``AWS::ApiGateway::BasePathMapping`` resource creates a base path that clients who call your API must use in the invocation URL.
|
|
4976
4976
|
|
|
4977
|
+
Supported only for public custom domain names.
|
|
4978
|
+
|
|
4977
4979
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html
|
|
4978
4980
|
:cloudformationResource: AWS::ApiGateway::BasePathMapping
|
|
4979
4981
|
:exampleMetadata: fixture=_generated
|
|
@@ -5259,7 +5261,9 @@ class CfnBasePathMappingV2(
|
|
|
5259
5261
|
metaclass=jsii.JSIIMeta,
|
|
5260
5262
|
jsii_type="aws-cdk-lib.aws_apigateway.CfnBasePathMappingV2",
|
|
5261
5263
|
):
|
|
5262
|
-
'''
|
|
5264
|
+
'''The ``AWS::ApiGateway::BasePathMappingV2`` resource creates a base path that clients who call your API must use in the invocation URL.
|
|
5265
|
+
|
|
5266
|
+
Supported only for private custom domain names.
|
|
5263
5267
|
|
|
5264
5268
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmappingv2.html
|
|
5265
5269
|
:cloudformationResource: AWS::ApiGateway::BasePathMappingV2
|
|
@@ -5294,10 +5298,10 @@ class CfnBasePathMappingV2(
|
|
|
5294
5298
|
'''
|
|
5295
5299
|
:param scope: Scope in which this resource is defined.
|
|
5296
5300
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
5297
|
-
:param domain_name_arn: The
|
|
5298
|
-
:param rest_api_id: The
|
|
5299
|
-
:param base_path: The base path name that callers of the API must provide
|
|
5300
|
-
:param stage:
|
|
5301
|
+
:param domain_name_arn: The ARN of the domain name for the BasePathMappingV2 resource to be described.
|
|
5302
|
+
:param rest_api_id: The private API's identifier. This identifier is unique across all of your APIs in API Gateway.
|
|
5303
|
+
:param base_path: The base path name that callers of the private API must provide as part of the URL after the domain name.
|
|
5304
|
+
:param stage: Represents a unique identifier for a version of a deployed private RestApi that is callable by users. The Stage must depend on the ``RestApi`` 's stage. To create a dependency, add a DependsOn attribute to the BasePathMappingV2 resource.
|
|
5301
5305
|
'''
|
|
5302
5306
|
if __debug__:
|
|
5303
5307
|
type_hints = typing.get_type_hints(_typecheckingstub__a583f31dead36a23816022dfcb476b0ff18ec097d668a0cf42b19791b749acae)
|
|
@@ -5359,7 +5363,7 @@ class CfnBasePathMappingV2(
|
|
|
5359
5363
|
@builtins.property
|
|
5360
5364
|
@jsii.member(jsii_name="domainNameArn")
|
|
5361
5365
|
def domain_name_arn(self) -> builtins.str:
|
|
5362
|
-
'''The
|
|
5366
|
+
'''The ARN of the domain name for the BasePathMappingV2 resource to be described.'''
|
|
5363
5367
|
return typing.cast(builtins.str, jsii.get(self, "domainNameArn"))
|
|
5364
5368
|
|
|
5365
5369
|
@domain_name_arn.setter
|
|
@@ -5372,7 +5376,7 @@ class CfnBasePathMappingV2(
|
|
|
5372
5376
|
@builtins.property
|
|
5373
5377
|
@jsii.member(jsii_name="restApiId")
|
|
5374
5378
|
def rest_api_id(self) -> builtins.str:
|
|
5375
|
-
'''The
|
|
5379
|
+
'''The private API's identifier.'''
|
|
5376
5380
|
return typing.cast(builtins.str, jsii.get(self, "restApiId"))
|
|
5377
5381
|
|
|
5378
5382
|
@rest_api_id.setter
|
|
@@ -5385,7 +5389,7 @@ class CfnBasePathMappingV2(
|
|
|
5385
5389
|
@builtins.property
|
|
5386
5390
|
@jsii.member(jsii_name="basePath")
|
|
5387
5391
|
def base_path(self) -> typing.Optional[builtins.str]:
|
|
5388
|
-
'''The base path name that callers of the API must provide
|
|
5392
|
+
'''The base path name that callers of the private API must provide as part of the URL after the domain name.'''
|
|
5389
5393
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "basePath"))
|
|
5390
5394
|
|
|
5391
5395
|
@base_path.setter
|
|
@@ -5398,7 +5402,7 @@ class CfnBasePathMappingV2(
|
|
|
5398
5402
|
@builtins.property
|
|
5399
5403
|
@jsii.member(jsii_name="stage")
|
|
5400
5404
|
def stage(self) -> typing.Optional[builtins.str]:
|
|
5401
|
-
'''
|
|
5405
|
+
'''Represents a unique identifier for a version of a deployed private RestApi that is callable by users.'''
|
|
5402
5406
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "stage"))
|
|
5403
5407
|
|
|
5404
5408
|
@stage.setter
|
|
@@ -5430,10 +5434,10 @@ class CfnBasePathMappingV2Props:
|
|
|
5430
5434
|
) -> None:
|
|
5431
5435
|
'''Properties for defining a ``CfnBasePathMappingV2``.
|
|
5432
5436
|
|
|
5433
|
-
:param domain_name_arn: The
|
|
5434
|
-
:param rest_api_id: The
|
|
5435
|
-
:param base_path: The base path name that callers of the API must provide
|
|
5436
|
-
:param stage:
|
|
5437
|
+
:param domain_name_arn: The ARN of the domain name for the BasePathMappingV2 resource to be described.
|
|
5438
|
+
:param rest_api_id: The private API's identifier. This identifier is unique across all of your APIs in API Gateway.
|
|
5439
|
+
:param base_path: The base path name that callers of the private API must provide as part of the URL after the domain name.
|
|
5440
|
+
:param stage: Represents a unique identifier for a version of a deployed private RestApi that is callable by users. The Stage must depend on the ``RestApi`` 's stage. To create a dependency, add a DependsOn attribute to the BasePathMappingV2 resource.
|
|
5437
5441
|
|
|
5438
5442
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmappingv2.html
|
|
5439
5443
|
:exampleMetadata: fixture=_generated
|
|
@@ -5470,7 +5474,7 @@ class CfnBasePathMappingV2Props:
|
|
|
5470
5474
|
|
|
5471
5475
|
@builtins.property
|
|
5472
5476
|
def domain_name_arn(self) -> builtins.str:
|
|
5473
|
-
'''The
|
|
5477
|
+
'''The ARN of the domain name for the BasePathMappingV2 resource to be described.
|
|
5474
5478
|
|
|
5475
5479
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmappingv2.html#cfn-apigateway-basepathmappingv2-domainnamearn
|
|
5476
5480
|
'''
|
|
@@ -5480,7 +5484,9 @@ class CfnBasePathMappingV2Props:
|
|
|
5480
5484
|
|
|
5481
5485
|
@builtins.property
|
|
5482
5486
|
def rest_api_id(self) -> builtins.str:
|
|
5483
|
-
'''The
|
|
5487
|
+
'''The private API's identifier.
|
|
5488
|
+
|
|
5489
|
+
This identifier is unique across all of your APIs in API Gateway.
|
|
5484
5490
|
|
|
5485
5491
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmappingv2.html#cfn-apigateway-basepathmappingv2-restapiid
|
|
5486
5492
|
'''
|
|
@@ -5490,7 +5496,7 @@ class CfnBasePathMappingV2Props:
|
|
|
5490
5496
|
|
|
5491
5497
|
@builtins.property
|
|
5492
5498
|
def base_path(self) -> typing.Optional[builtins.str]:
|
|
5493
|
-
'''The base path name that callers of the API must provide
|
|
5499
|
+
'''The base path name that callers of the private API must provide as part of the URL after the domain name.
|
|
5494
5500
|
|
|
5495
5501
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmappingv2.html#cfn-apigateway-basepathmappingv2-basepath
|
|
5496
5502
|
'''
|
|
@@ -5499,7 +5505,9 @@ class CfnBasePathMappingV2Props:
|
|
|
5499
5505
|
|
|
5500
5506
|
@builtins.property
|
|
5501
5507
|
def stage(self) -> typing.Optional[builtins.str]:
|
|
5502
|
-
'''
|
|
5508
|
+
'''Represents a unique identifier for a version of a deployed private RestApi that is callable by users.
|
|
5509
|
+
|
|
5510
|
+
The Stage must depend on the ``RestApi`` 's stage. To create a dependency, add a DependsOn attribute to the BasePathMappingV2 resource.
|
|
5503
5511
|
|
|
5504
5512
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmappingv2.html#cfn-apigateway-basepathmappingv2-stage
|
|
5505
5513
|
'''
|
|
@@ -7659,7 +7667,7 @@ class CfnDomainName(
|
|
|
7659
7667
|
metaclass=jsii.JSIIMeta,
|
|
7660
7668
|
jsii_type="aws-cdk-lib.aws_apigateway.CfnDomainName",
|
|
7661
7669
|
):
|
|
7662
|
-
'''The ``AWS::ApiGateway::DomainName`` resource specifies a custom domain name for your API in API Gateway.
|
|
7670
|
+
'''The ``AWS::ApiGateway::DomainName`` resource specifies a public custom domain name for your API in API Gateway.
|
|
7663
7671
|
|
|
7664
7672
|
You can use a custom domain name to provide a URL that's more intuitive and easier to recall. For more information about using custom domain names, see `Set up Custom Domain Name for an API in API Gateway <https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html>`_ in the *API Gateway Developer Guide* .
|
|
7665
7673
|
|
|
@@ -7710,7 +7718,7 @@ class CfnDomainName(
|
|
|
7710
7718
|
'''
|
|
7711
7719
|
:param scope: Scope in which this resource is defined.
|
|
7712
7720
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
7713
|
-
:param certificate_arn: The reference to an AWS -managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.
|
|
7721
|
+
:param certificate_arn: The reference to an AWS -managed certificate that will be used by edge-optimized endpoint or private endpoint for this domain name. AWS Certificate Manager is the only supported source.
|
|
7714
7722
|
:param domain_name: The custom domain name as an API host name, for example, ``my-api.example.com`` .
|
|
7715
7723
|
:param endpoint_configuration: The endpoint configuration of this DomainName showing the endpoint types of the domain name.
|
|
7716
7724
|
:param mutual_tls_authentication: The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.
|
|
@@ -7824,7 +7832,7 @@ class CfnDomainName(
|
|
|
7824
7832
|
@builtins.property
|
|
7825
7833
|
@jsii.member(jsii_name="certificateArn")
|
|
7826
7834
|
def certificate_arn(self) -> typing.Optional[builtins.str]:
|
|
7827
|
-
'''The reference to an AWS -managed certificate that will be used by edge-optimized endpoint for this domain name.'''
|
|
7835
|
+
'''The reference to an AWS -managed certificate that will be used by edge-optimized endpoint or private endpoint for this domain name.'''
|
|
7828
7836
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "certificateArn"))
|
|
7829
7837
|
|
|
7830
7838
|
@certificate_arn.setter
|
|
@@ -8083,7 +8091,11 @@ class CfnDomainNameAccessAssociation(
|
|
|
8083
8091
|
metaclass=jsii.JSIIMeta,
|
|
8084
8092
|
jsii_type="aws-cdk-lib.aws_apigateway.CfnDomainNameAccessAssociation",
|
|
8085
8093
|
):
|
|
8086
|
-
'''
|
|
8094
|
+
'''The ``AWS::ApiGateway::DomainNameAccessAssociation`` resource creates a domain name access association between an access association source and a private custom domain name.
|
|
8095
|
+
|
|
8096
|
+
Use a domain name access association to invoke a private custom domain name while isolated from the public internet.
|
|
8097
|
+
|
|
8098
|
+
You can only create or delete a DomainNameAccessAssociation using CloudFormation. To reject a domain name access association, use the AWS CLI.
|
|
8087
8099
|
|
|
8088
8100
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnameaccessassociation.html
|
|
8089
8101
|
:cloudformationResource: AWS::ApiGateway::DomainNameAccessAssociation
|
|
@@ -8121,10 +8133,10 @@ class CfnDomainNameAccessAssociation(
|
|
|
8121
8133
|
'''
|
|
8122
8134
|
:param scope: Scope in which this resource is defined.
|
|
8123
8135
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
8124
|
-
:param access_association_source: The
|
|
8125
|
-
:param access_association_source_type: The
|
|
8126
|
-
:param domain_name_arn: The
|
|
8127
|
-
:param tags:
|
|
8136
|
+
:param access_association_source: The identifier of the domain name access association source. For a ``VPCE`` , the value is the VPC endpoint ID.
|
|
8137
|
+
:param access_association_source_type: The type of the domain name access association source. Only ``VPCE`` is currently supported.
|
|
8138
|
+
:param domain_name_arn: The ARN of the domain name.
|
|
8139
|
+
:param tags: The collection of tags. Each tag element is associated with a given resource.
|
|
8128
8140
|
'''
|
|
8129
8141
|
if __debug__:
|
|
8130
8142
|
type_hints = typing.get_type_hints(_typecheckingstub__cafcd3b452004fc09063699f5b2263d0f36c2a080b20c7f0d51493646ac87441)
|
|
@@ -8172,7 +8184,9 @@ class CfnDomainNameAccessAssociation(
|
|
|
8172
8184
|
@builtins.property
|
|
8173
8185
|
@jsii.member(jsii_name="attrDomainNameAccessAssociationArn")
|
|
8174
8186
|
def attr_domain_name_access_association_arn(self) -> builtins.str:
|
|
8175
|
-
'''The
|
|
8187
|
+
'''The access association ARN.
|
|
8188
|
+
|
|
8189
|
+
For example: ``arn:aws:apigateway:us-west-2:111122223333:/accessassociations/domainname/private.example.com+abcd1234/vpcesource/vpce-abcd1234efg`` .
|
|
8176
8190
|
|
|
8177
8191
|
:cloudformationAttribute: DomainNameAccessAssociationArn
|
|
8178
8192
|
'''
|
|
@@ -8192,7 +8206,7 @@ class CfnDomainNameAccessAssociation(
|
|
|
8192
8206
|
@builtins.property
|
|
8193
8207
|
@jsii.member(jsii_name="accessAssociationSource")
|
|
8194
8208
|
def access_association_source(self) -> builtins.str:
|
|
8195
|
-
'''The
|
|
8209
|
+
'''The identifier of the domain name access association source.'''
|
|
8196
8210
|
return typing.cast(builtins.str, jsii.get(self, "accessAssociationSource"))
|
|
8197
8211
|
|
|
8198
8212
|
@access_association_source.setter
|
|
@@ -8205,7 +8219,7 @@ class CfnDomainNameAccessAssociation(
|
|
|
8205
8219
|
@builtins.property
|
|
8206
8220
|
@jsii.member(jsii_name="accessAssociationSourceType")
|
|
8207
8221
|
def access_association_source_type(self) -> builtins.str:
|
|
8208
|
-
'''The
|
|
8222
|
+
'''The type of the domain name access association source.'''
|
|
8209
8223
|
return typing.cast(builtins.str, jsii.get(self, "accessAssociationSourceType"))
|
|
8210
8224
|
|
|
8211
8225
|
@access_association_source_type.setter
|
|
@@ -8218,7 +8232,7 @@ class CfnDomainNameAccessAssociation(
|
|
|
8218
8232
|
@builtins.property
|
|
8219
8233
|
@jsii.member(jsii_name="domainNameArn")
|
|
8220
8234
|
def domain_name_arn(self) -> builtins.str:
|
|
8221
|
-
'''The
|
|
8235
|
+
'''The ARN of the domain name.'''
|
|
8222
8236
|
return typing.cast(builtins.str, jsii.get(self, "domainNameArn"))
|
|
8223
8237
|
|
|
8224
8238
|
@domain_name_arn.setter
|
|
@@ -8231,7 +8245,7 @@ class CfnDomainNameAccessAssociation(
|
|
|
8231
8245
|
@builtins.property
|
|
8232
8246
|
@jsii.member(jsii_name="tags")
|
|
8233
8247
|
def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
8234
|
-
'''
|
|
8248
|
+
'''The collection of tags.'''
|
|
8235
8249
|
return typing.cast(typing.Optional[typing.List[_CfnTag_f6864754]], jsii.get(self, "tags"))
|
|
8236
8250
|
|
|
8237
8251
|
@tags.setter
|
|
@@ -8263,10 +8277,10 @@ class CfnDomainNameAccessAssociationProps:
|
|
|
8263
8277
|
) -> None:
|
|
8264
8278
|
'''Properties for defining a ``CfnDomainNameAccessAssociation``.
|
|
8265
8279
|
|
|
8266
|
-
:param access_association_source: The
|
|
8267
|
-
:param access_association_source_type: The
|
|
8268
|
-
:param domain_name_arn: The
|
|
8269
|
-
:param tags:
|
|
8280
|
+
:param access_association_source: The identifier of the domain name access association source. For a ``VPCE`` , the value is the VPC endpoint ID.
|
|
8281
|
+
:param access_association_source_type: The type of the domain name access association source. Only ``VPCE`` is currently supported.
|
|
8282
|
+
:param domain_name_arn: The ARN of the domain name.
|
|
8283
|
+
:param tags: The collection of tags. Each tag element is associated with a given resource.
|
|
8270
8284
|
|
|
8271
8285
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnameaccessassociation.html
|
|
8272
8286
|
:exampleMetadata: fixture=_generated
|
|
@@ -8305,7 +8319,9 @@ class CfnDomainNameAccessAssociationProps:
|
|
|
8305
8319
|
|
|
8306
8320
|
@builtins.property
|
|
8307
8321
|
def access_association_source(self) -> builtins.str:
|
|
8308
|
-
'''The
|
|
8322
|
+
'''The identifier of the domain name access association source.
|
|
8323
|
+
|
|
8324
|
+
For a ``VPCE`` , the value is the VPC endpoint ID.
|
|
8309
8325
|
|
|
8310
8326
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnameaccessassociation.html#cfn-apigateway-domainnameaccessassociation-accessassociationsource
|
|
8311
8327
|
'''
|
|
@@ -8315,7 +8331,9 @@ class CfnDomainNameAccessAssociationProps:
|
|
|
8315
8331
|
|
|
8316
8332
|
@builtins.property
|
|
8317
8333
|
def access_association_source_type(self) -> builtins.str:
|
|
8318
|
-
'''The
|
|
8334
|
+
'''The type of the domain name access association source.
|
|
8335
|
+
|
|
8336
|
+
Only ``VPCE`` is currently supported.
|
|
8319
8337
|
|
|
8320
8338
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnameaccessassociation.html#cfn-apigateway-domainnameaccessassociation-accessassociationsourcetype
|
|
8321
8339
|
'''
|
|
@@ -8325,7 +8343,7 @@ class CfnDomainNameAccessAssociationProps:
|
|
|
8325
8343
|
|
|
8326
8344
|
@builtins.property
|
|
8327
8345
|
def domain_name_arn(self) -> builtins.str:
|
|
8328
|
-
'''The
|
|
8346
|
+
'''The ARN of the domain name.
|
|
8329
8347
|
|
|
8330
8348
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnameaccessassociation.html#cfn-apigateway-domainnameaccessassociation-domainnamearn
|
|
8331
8349
|
'''
|
|
@@ -8335,7 +8353,9 @@ class CfnDomainNameAccessAssociationProps:
|
|
|
8335
8353
|
|
|
8336
8354
|
@builtins.property
|
|
8337
8355
|
def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
8338
|
-
'''
|
|
8356
|
+
'''The collection of tags.
|
|
8357
|
+
|
|
8358
|
+
Each tag element is associated with a given resource.
|
|
8339
8359
|
|
|
8340
8360
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnameaccessassociation.html#cfn-apigateway-domainnameaccessassociation-tags
|
|
8341
8361
|
'''
|
|
@@ -8383,7 +8403,7 @@ class CfnDomainNameProps:
|
|
|
8383
8403
|
) -> None:
|
|
8384
8404
|
'''Properties for defining a ``CfnDomainName``.
|
|
8385
8405
|
|
|
8386
|
-
:param certificate_arn: The reference to an AWS -managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.
|
|
8406
|
+
:param certificate_arn: The reference to an AWS -managed certificate that will be used by edge-optimized endpoint or private endpoint for this domain name. AWS Certificate Manager is the only supported source.
|
|
8387
8407
|
:param domain_name: The custom domain name as an API host name, for example, ``my-api.example.com`` .
|
|
8388
8408
|
:param endpoint_configuration: The endpoint configuration of this DomainName showing the endpoint types of the domain name.
|
|
8389
8409
|
:param mutual_tls_authentication: The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.
|
|
@@ -8450,7 +8470,7 @@ class CfnDomainNameProps:
|
|
|
8450
8470
|
|
|
8451
8471
|
@builtins.property
|
|
8452
8472
|
def certificate_arn(self) -> typing.Optional[builtins.str]:
|
|
8453
|
-
'''The reference to an AWS -managed certificate that will be used by edge-optimized endpoint for this domain name.
|
|
8473
|
+
'''The reference to an AWS -managed certificate that will be used by edge-optimized endpoint or private endpoint for this domain name.
|
|
8454
8474
|
|
|
8455
8475
|
AWS Certificate Manager is the only supported source.
|
|
8456
8476
|
|
|
@@ -8554,7 +8574,9 @@ class CfnDomainNameV2(
|
|
|
8554
8574
|
metaclass=jsii.JSIIMeta,
|
|
8555
8575
|
jsii_type="aws-cdk-lib.aws_apigateway.CfnDomainNameV2",
|
|
8556
8576
|
):
|
|
8557
|
-
'''
|
|
8577
|
+
'''The ``AWS::ApiGateway::DomainNameV2`` resource specifies a custom domain name for your private APIs in API Gateway.
|
|
8578
|
+
|
|
8579
|
+
You can use a private custom domain name to provide a URL for your private API that's more intuitive and easier to recall.
|
|
8558
8580
|
|
|
8559
8581
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2.html
|
|
8560
8582
|
:cloudformationResource: AWS::ApiGateway::DomainNameV2
|
|
@@ -8601,13 +8623,13 @@ class CfnDomainNameV2(
|
|
|
8601
8623
|
'''
|
|
8602
8624
|
:param scope: Scope in which this resource is defined.
|
|
8603
8625
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
8604
|
-
:param certificate_arn:
|
|
8605
|
-
:param domain_name:
|
|
8606
|
-
:param endpoint_configuration:
|
|
8626
|
+
:param certificate_arn: The reference to an AWS -managed certificate that will be used by the private endpoint for this domain name. AWS Certificate Manager is the only supported source.
|
|
8627
|
+
:param domain_name: Represents a custom domain name as a user-friendly host name of an API (RestApi).
|
|
8628
|
+
:param endpoint_configuration: The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has.
|
|
8607
8629
|
:param management_policy:
|
|
8608
|
-
:param policy:
|
|
8609
|
-
:param security_policy:
|
|
8610
|
-
:param tags:
|
|
8630
|
+
:param policy: A stringified JSON policy document that applies to the ``execute-api`` service for this DomainName regardless of the caller and Method configuration. You can use ``Fn::ToJsonString`` to enter your ``policy`` . For more information, see `Fn::ToJsonString <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ToJsonString.html>`_ .
|
|
8631
|
+
:param security_policy: The Transport Layer Security (TLS) version + cipher suite for this DomainName. Only ``TLS_1_2`` is supported.
|
|
8632
|
+
:param tags: The collection of tags. Each tag element is associated with a given resource.
|
|
8611
8633
|
'''
|
|
8612
8634
|
if __debug__:
|
|
8613
8635
|
type_hints = typing.get_type_hints(_typecheckingstub__a4f501d10d57d39a48913872efdcb7d389a076fed9b5aabb21034b8e60a1e0bf)
|
|
@@ -8658,7 +8680,7 @@ class CfnDomainNameV2(
|
|
|
8658
8680
|
@builtins.property
|
|
8659
8681
|
@jsii.member(jsii_name="attrDomainNameArn")
|
|
8660
8682
|
def attr_domain_name_arn(self) -> builtins.str:
|
|
8661
|
-
'''The
|
|
8683
|
+
'''The ARN of the domain name.
|
|
8662
8684
|
|
|
8663
8685
|
:cloudformationAttribute: DomainNameArn
|
|
8664
8686
|
'''
|
|
@@ -8667,7 +8689,8 @@ class CfnDomainNameV2(
|
|
|
8667
8689
|
@builtins.property
|
|
8668
8690
|
@jsii.member(jsii_name="attrDomainNameId")
|
|
8669
8691
|
def attr_domain_name_id(self) -> builtins.str:
|
|
8670
|
-
'''
|
|
8692
|
+
'''The domain name ID.
|
|
8693
|
+
|
|
8671
8694
|
:cloudformationAttribute: DomainNameId
|
|
8672
8695
|
'''
|
|
8673
8696
|
return typing.cast(builtins.str, jsii.get(self, "attrDomainNameId"))
|
|
@@ -8686,6 +8709,7 @@ class CfnDomainNameV2(
|
|
|
8686
8709
|
@builtins.property
|
|
8687
8710
|
@jsii.member(jsii_name="certificateArn")
|
|
8688
8711
|
def certificate_arn(self) -> typing.Optional[builtins.str]:
|
|
8712
|
+
'''The reference to an AWS -managed certificate that will be used by the private endpoint for this domain name.'''
|
|
8689
8713
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "certificateArn"))
|
|
8690
8714
|
|
|
8691
8715
|
@certificate_arn.setter
|
|
@@ -8698,6 +8722,7 @@ class CfnDomainNameV2(
|
|
|
8698
8722
|
@builtins.property
|
|
8699
8723
|
@jsii.member(jsii_name="domainName")
|
|
8700
8724
|
def domain_name(self) -> typing.Optional[builtins.str]:
|
|
8725
|
+
'''Represents a custom domain name as a user-friendly host name of an API (RestApi).'''
|
|
8701
8726
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "domainName"))
|
|
8702
8727
|
|
|
8703
8728
|
@domain_name.setter
|
|
@@ -8712,6 +8737,7 @@ class CfnDomainNameV2(
|
|
|
8712
8737
|
def endpoint_configuration(
|
|
8713
8738
|
self,
|
|
8714
8739
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDomainNameV2.EndpointConfigurationProperty"]]:
|
|
8740
|
+
'''The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has.'''
|
|
8715
8741
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDomainNameV2.EndpointConfigurationProperty"]], jsii.get(self, "endpointConfiguration"))
|
|
8716
8742
|
|
|
8717
8743
|
@endpoint_configuration.setter
|
|
@@ -8739,6 +8765,7 @@ class CfnDomainNameV2(
|
|
|
8739
8765
|
@builtins.property
|
|
8740
8766
|
@jsii.member(jsii_name="policy")
|
|
8741
8767
|
def policy(self) -> typing.Any:
|
|
8768
|
+
'''A stringified JSON policy document that applies to the ``execute-api`` service for this DomainName regardless of the caller and Method configuration.'''
|
|
8742
8769
|
return typing.cast(typing.Any, jsii.get(self, "policy"))
|
|
8743
8770
|
|
|
8744
8771
|
@policy.setter
|
|
@@ -8751,6 +8778,7 @@ class CfnDomainNameV2(
|
|
|
8751
8778
|
@builtins.property
|
|
8752
8779
|
@jsii.member(jsii_name="securityPolicy")
|
|
8753
8780
|
def security_policy(self) -> typing.Optional[builtins.str]:
|
|
8781
|
+
'''The Transport Layer Security (TLS) version + cipher suite for this DomainName.'''
|
|
8754
8782
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "securityPolicy"))
|
|
8755
8783
|
|
|
8756
8784
|
@security_policy.setter
|
|
@@ -8763,6 +8791,7 @@ class CfnDomainNameV2(
|
|
|
8763
8791
|
@builtins.property
|
|
8764
8792
|
@jsii.member(jsii_name="tags")
|
|
8765
8793
|
def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
8794
|
+
'''The collection of tags.'''
|
|
8766
8795
|
return typing.cast(typing.Optional[typing.List[_CfnTag_f6864754]], jsii.get(self, "tags"))
|
|
8767
8796
|
|
|
8768
8797
|
@tags.setter
|
|
@@ -8783,8 +8812,9 @@ class CfnDomainNameV2(
|
|
|
8783
8812
|
*,
|
|
8784
8813
|
types: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
8785
8814
|
) -> None:
|
|
8786
|
-
'''
|
|
8787
|
-
|
|
8815
|
+
'''The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has.
|
|
8816
|
+
|
|
8817
|
+
:param types: A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is ``"EDGE"`` . For a regional API and its custom domain name, the endpoint type is ``REGIONAL`` . For a private API, the endpoint type is ``PRIVATE`` .
|
|
8788
8818
|
|
|
8789
8819
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-domainnamev2-endpointconfiguration.html
|
|
8790
8820
|
:exampleMetadata: fixture=_generated
|
|
@@ -8808,7 +8838,10 @@ class CfnDomainNameV2(
|
|
|
8808
8838
|
|
|
8809
8839
|
@builtins.property
|
|
8810
8840
|
def types(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
8811
|
-
'''
|
|
8841
|
+
'''A list of endpoint types of an API (RestApi) or its custom domain name (DomainName).
|
|
8842
|
+
|
|
8843
|
+
For an edge-optimized API and its custom domain name, the endpoint type is ``"EDGE"`` . For a regional API and its custom domain name, the endpoint type is ``REGIONAL`` . For a private API, the endpoint type is ``PRIVATE`` .
|
|
8844
|
+
|
|
8812
8845
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-domainnamev2-endpointconfiguration.html#cfn-apigateway-domainnamev2-endpointconfiguration-types
|
|
8813
8846
|
'''
|
|
8814
8847
|
result = self._values.get("types")
|
|
@@ -8853,13 +8886,13 @@ class CfnDomainNameV2Props:
|
|
|
8853
8886
|
) -> None:
|
|
8854
8887
|
'''Properties for defining a ``CfnDomainNameV2``.
|
|
8855
8888
|
|
|
8856
|
-
:param certificate_arn:
|
|
8857
|
-
:param domain_name:
|
|
8858
|
-
:param endpoint_configuration:
|
|
8889
|
+
:param certificate_arn: The reference to an AWS -managed certificate that will be used by the private endpoint for this domain name. AWS Certificate Manager is the only supported source.
|
|
8890
|
+
:param domain_name: Represents a custom domain name as a user-friendly host name of an API (RestApi).
|
|
8891
|
+
:param endpoint_configuration: The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has.
|
|
8859
8892
|
:param management_policy:
|
|
8860
|
-
:param policy:
|
|
8861
|
-
:param security_policy:
|
|
8862
|
-
:param tags:
|
|
8893
|
+
:param policy: A stringified JSON policy document that applies to the ``execute-api`` service for this DomainName regardless of the caller and Method configuration. You can use ``Fn::ToJsonString`` to enter your ``policy`` . For more information, see `Fn::ToJsonString <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ToJsonString.html>`_ .
|
|
8894
|
+
:param security_policy: The Transport Layer Security (TLS) version + cipher suite for this DomainName. Only ``TLS_1_2`` is supported.
|
|
8895
|
+
:param tags: The collection of tags. Each tag element is associated with a given resource.
|
|
8863
8896
|
|
|
8864
8897
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2.html
|
|
8865
8898
|
:exampleMetadata: fixture=_generated
|
|
@@ -8915,7 +8948,10 @@ class CfnDomainNameV2Props:
|
|
|
8915
8948
|
|
|
8916
8949
|
@builtins.property
|
|
8917
8950
|
def certificate_arn(self) -> typing.Optional[builtins.str]:
|
|
8918
|
-
'''
|
|
8951
|
+
'''The reference to an AWS -managed certificate that will be used by the private endpoint for this domain name.
|
|
8952
|
+
|
|
8953
|
+
AWS Certificate Manager is the only supported source.
|
|
8954
|
+
|
|
8919
8955
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2.html#cfn-apigateway-domainnamev2-certificatearn
|
|
8920
8956
|
'''
|
|
8921
8957
|
result = self._values.get("certificate_arn")
|
|
@@ -8923,7 +8959,8 @@ class CfnDomainNameV2Props:
|
|
|
8923
8959
|
|
|
8924
8960
|
@builtins.property
|
|
8925
8961
|
def domain_name(self) -> typing.Optional[builtins.str]:
|
|
8926
|
-
'''
|
|
8962
|
+
'''Represents a custom domain name as a user-friendly host name of an API (RestApi).
|
|
8963
|
+
|
|
8927
8964
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2.html#cfn-apigateway-domainnamev2-domainname
|
|
8928
8965
|
'''
|
|
8929
8966
|
result = self._values.get("domain_name")
|
|
@@ -8933,7 +8970,8 @@ class CfnDomainNameV2Props:
|
|
|
8933
8970
|
def endpoint_configuration(
|
|
8934
8971
|
self,
|
|
8935
8972
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnDomainNameV2.EndpointConfigurationProperty]]:
|
|
8936
|
-
'''
|
|
8973
|
+
'''The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has.
|
|
8974
|
+
|
|
8937
8975
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2.html#cfn-apigateway-domainnamev2-endpointconfiguration
|
|
8938
8976
|
'''
|
|
8939
8977
|
result = self._values.get("endpoint_configuration")
|
|
@@ -8949,7 +8987,10 @@ class CfnDomainNameV2Props:
|
|
|
8949
8987
|
|
|
8950
8988
|
@builtins.property
|
|
8951
8989
|
def policy(self) -> typing.Any:
|
|
8952
|
-
'''
|
|
8990
|
+
'''A stringified JSON policy document that applies to the ``execute-api`` service for this DomainName regardless of the caller and Method configuration.
|
|
8991
|
+
|
|
8992
|
+
You can use ``Fn::ToJsonString`` to enter your ``policy`` . For more information, see `Fn::ToJsonString <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ToJsonString.html>`_ .
|
|
8993
|
+
|
|
8953
8994
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2.html#cfn-apigateway-domainnamev2-policy
|
|
8954
8995
|
'''
|
|
8955
8996
|
result = self._values.get("policy")
|
|
@@ -8957,7 +8998,10 @@ class CfnDomainNameV2Props:
|
|
|
8957
8998
|
|
|
8958
8999
|
@builtins.property
|
|
8959
9000
|
def security_policy(self) -> typing.Optional[builtins.str]:
|
|
8960
|
-
'''
|
|
9001
|
+
'''The Transport Layer Security (TLS) version + cipher suite for this DomainName.
|
|
9002
|
+
|
|
9003
|
+
Only ``TLS_1_2`` is supported.
|
|
9004
|
+
|
|
8961
9005
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2.html#cfn-apigateway-domainnamev2-securitypolicy
|
|
8962
9006
|
'''
|
|
8963
9007
|
result = self._values.get("security_policy")
|
|
@@ -8965,7 +9009,10 @@ class CfnDomainNameV2Props:
|
|
|
8965
9009
|
|
|
8966
9010
|
@builtins.property
|
|
8967
9011
|
def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
8968
|
-
'''
|
|
9012
|
+
'''The collection of tags.
|
|
9013
|
+
|
|
9014
|
+
Each tag element is associated with a given resource.
|
|
9015
|
+
|
|
8969
9016
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2.html#cfn-apigateway-domainnamev2-tags
|
|
8970
9017
|
'''
|
|
8971
9018
|
result = self._values.get("tags")
|