aws-cdk-lib 2.73.0__py3-none-any.whl → 2.76.0__py3-none-any.whl

aws_cdk/aws_frauddetector/__init__.py

@@ -1285,9 +1285,8 @@ class CfnDetector(
     )
     class ModelProperty:
         def __init__(self, *, arn: typing.Optional[builtins.str] = None) -> None:
-            '''The model.
-
-            :param arn: The ARN of the model.
+            '''
+            :param arn: ``CfnDetector.ModelProperty.Arn``.
 
             :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-model.html
             :exampleMetadata: fixture=_generated
@@ -1311,7 +1310,7 @@ class CfnDetector(
 
         @builtins.property
         def arn(self) -> typing.Optional[builtins.str]:
-            '''The ARN of the model.
+            '''``CfnDetector.ModelProperty.Arn``.
 
             :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-model.html#cfn-frauddetector-detector-model-arn
             '''

aws_cdk/aws_fsx/__init__.py

@@ -112,7 +112,7 @@ inst.user_data.add_commands("set -eux", "yum update -y", "amazon-linux-extras in
 
 ### Importing an existing Lustre filesystem
 
-An FSx for Lustre file system can be imported with `fromLustreFileSystemAttributes(stack, id, attributes)`. The
+An FSx for Lustre file system can be imported with `fromLustreFileSystemAttributes(this, id, attributes)`. The
 following example lays out how you could import the SecurityGroup a file system belongs to, use that to import the file
 system, and then also import the VPC the file system is in and add an EC2 instance to it, giving it access to the file
 system.
@@ -154,7 +154,8 @@ Note: CloudFormation does not currently support for `PERSISTENT_2` filesystems,
 The following example illustrates setting up a DRA to an S3 bucket, including automated metadata import whenever a file is changed, created or deleted in the S3 bucket:
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
+from aws_cdk import aws_s3 as s3
+
 # vpc: ec2.Vpc
 # bucket: s3.Bucket
 
@@ -6220,7 +6221,8 @@ class LustreAutoImportPolicy(enum.Enum):
 
     Example::
 
-        # Example automatically generated from non-compiling source. May contain errors.
+        from aws_cdk import aws_s3 as s3
+        
         # vpc: ec2.Vpc
         # bucket: s3.Bucket
         
@@ -6305,7 +6307,8 @@ class LustreConfiguration:
 
         Example::
 
-            # Example automatically generated from non-compiling source. May contain errors.
+            from aws_cdk import aws_s3 as s3
+            
             # vpc: ec2.Vpc
             # bucket: s3.Bucket
             
@@ -6496,7 +6499,8 @@ class LustreDeploymentType(enum.Enum):
 
     Example::
 
-        # Example automatically generated from non-compiling source. May contain errors.
+        from aws_cdk import aws_s3 as s3
+        
         # vpc: ec2.Vpc
         # bucket: s3.Bucket
         
@@ -6581,7 +6585,8 @@ class LustreFileSystemProps(FileSystemProps):
 
         Example::
 
-            # Example automatically generated from non-compiling source. May contain errors.
+            from aws_cdk import aws_s3 as s3
+            
             # vpc: ec2.Vpc
             # bucket: s3.Bucket
             
@@ -6968,7 +6973,8 @@ class LustreFileSystem(
 
     Example::
 
-        # Example automatically generated from non-compiling source. May contain errors.
+        from aws_cdk import aws_s3 as s3
+        
         # vpc: ec2.Vpc
         # bucket: s3.Bucket
         

aws_cdk/aws_gamelift/__init__.py

@@ -954,7 +954,7 @@ class CfnFleet(
         :param anywhere_configuration: ``AWS::GameLift::Fleet.AnywhereConfiguration``.
         :param build_id: A unique identifier for a build to be deployed on the new fleet. If you are deploying the fleet with a custom game build, you must specify this property. The build must have been successfully uploaded to Amazon GameLift and be in a ``READY`` status. This fleet setting cannot be changed once the fleet is created.
         :param certificate_configuration: Prompts Amazon GameLift to generate a TLS/SSL certificate for the fleet. Amazon GameLift uses the certificates to encrypt traffic between game clients and the game servers running on Amazon GameLift. By default, the ``CertificateConfiguration`` is ``DISABLED`` . You can't change this property after you create the fleet. AWS Certificate Manager (ACM) certificates expire after 13 months. Certificate expiration can cause fleets to fail, preventing players from connecting to instances in the fleet. We recommend you replace fleets before 13 months, consider using fleet aliases for a smooth transition. .. epigraph:: ACM isn't available in all AWS regions. A fleet creation request with certificate generation enabled in an unsupported Region, fails with a 4xx error. For more information about the supported Regions, see `Supported Regions <https://docs.aws.amazon.com/acm/latest/userguide/acm-regions.html>`_ in the *AWS Certificate Manager User Guide* .
-        :param compute_type: The type of compute resource used to host your game servers. You can use your own compute resources with Amazon GameLift Anywhere or use Amazon EC2 instances with managed Amazon GameLift.
+        :param compute_type: ``AWS::GameLift::Fleet.ComputeType``.
         :param description: A description for the fleet.
         :param desired_ec2_instances: The number of EC2 instances that you want this fleet to host. When creating a new fleet, GameLift automatically sets this value to "1" and initiates a single instance. Once the fleet is active, update this value to trigger GameLift to add or remove instances from the fleet.
         :param ec2_inbound_permissions: The allowed IP address ranges and port settings that allow inbound traffic to access game sessions on this fleet. If the fleet is hosting a custom game build, this property must be set before players can connect to game sessions. For Realtime Servers fleets, Amazon GameLift automatically sets TCP and UDP ranges.
@@ -1134,9 +1134,7 @@ class CfnFleet(
     @builtins.property
     @jsii.member(jsii_name="computeType")
     def compute_type(self) -> typing.Optional[builtins.str]:
-        '''The type of compute resource used to host your game servers.
-
-        You can use your own compute resources with Amazon GameLift Anywhere or use Amazon EC2 instances with managed Amazon GameLift.
+        '''``AWS::GameLift::Fleet.ComputeType``.
 
         :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-computetype
         '''
@@ -1474,9 +1472,8 @@ class CfnFleet(
     )
     class AnywhereConfigurationProperty:
         def __init__(self, *, cost: builtins.str) -> None:
-            '''Amazon GameLift Anywhere configuration options for your Anywhere fleets.
-
-            :param cost: The cost to run your fleet per hour. Amazon GameLift uses the provided cost of your fleet to balance usage in queues. For more information about queues, see `Setting up queues <https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-intro.html>`_ in the *Amazon GameLift Developer Guide* .
+            '''
+            :param cost: ``CfnFleet.AnywhereConfigurationProperty.Cost``.
 
             :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-anywhereconfiguration.html
             :exampleMetadata: fixture=_generated
@@ -1500,9 +1497,7 @@ class CfnFleet(
 
         @builtins.property
         def cost(self) -> builtins.str:
-            '''The cost to run your fleet per hour.
-
-            Amazon GameLift uses the provided cost of your fleet to balance usage in queues. For more information about queues, see `Setting up queues <https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-intro.html>`_ in the *Amazon GameLift Developer Guide* .
+            '''``CfnFleet.AnywhereConfigurationProperty.Cost``.
 
             :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-anywhereconfiguration.html#cfn-gamelift-fleet-anywhereconfiguration-cost
             '''
@@ -2236,7 +2231,7 @@ class CfnFleetProps:
         :param anywhere_configuration: ``AWS::GameLift::Fleet.AnywhereConfiguration``.
         :param build_id: A unique identifier for a build to be deployed on the new fleet. If you are deploying the fleet with a custom game build, you must specify this property. The build must have been successfully uploaded to Amazon GameLift and be in a ``READY`` status. This fleet setting cannot be changed once the fleet is created.
         :param certificate_configuration: Prompts Amazon GameLift to generate a TLS/SSL certificate for the fleet. Amazon GameLift uses the certificates to encrypt traffic between game clients and the game servers running on Amazon GameLift. By default, the ``CertificateConfiguration`` is ``DISABLED`` . You can't change this property after you create the fleet. AWS Certificate Manager (ACM) certificates expire after 13 months. Certificate expiration can cause fleets to fail, preventing players from connecting to instances in the fleet. We recommend you replace fleets before 13 months, consider using fleet aliases for a smooth transition. .. epigraph:: ACM isn't available in all AWS regions. A fleet creation request with certificate generation enabled in an unsupported Region, fails with a 4xx error. For more information about the supported Regions, see `Supported Regions <https://docs.aws.amazon.com/acm/latest/userguide/acm-regions.html>`_ in the *AWS Certificate Manager User Guide* .
-        :param compute_type: The type of compute resource used to host your game servers. You can use your own compute resources with Amazon GameLift Anywhere or use Amazon EC2 instances with managed Amazon GameLift.
+        :param compute_type: ``AWS::GameLift::Fleet.ComputeType``.
         :param description: A description for the fleet.
         :param desired_ec2_instances: The number of EC2 instances that you want this fleet to host. When creating a new fleet, GameLift automatically sets this value to "1" and initiates a single instance. Once the fleet is active, update this value to trigger GameLift to add or remove instances from the fleet.
         :param ec2_inbound_permissions: The allowed IP address ranges and port settings that allow inbound traffic to access game sessions on this fleet. If the fleet is hosting a custom game build, this property must be set before players can connect to game sessions. For Realtime Servers fleets, Amazon GameLift automatically sets TCP and UDP ranges.
@@ -2441,9 +2436,7 @@ class CfnFleetProps:
 
     @builtins.property
     def compute_type(self) -> typing.Optional[builtins.str]:
-        '''The type of compute resource used to host your game servers.
-
-        You can use your own compute resources with Amazon GameLift Anywhere or use Amazon EC2 instances with managed Amazon GameLift.
+        '''``AWS::GameLift::Fleet.ComputeType``.
 
         :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-computetype
         '''
@@ -4519,8 +4512,6 @@ class CfnLocation(
 ):
     '''A CloudFormation ``AWS::GameLift::Location``.
 
-    Creates a custom location for use in an Anywhere fleet.
-
     :cloudformationResource: AWS::GameLift::Location
     :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-location.html
     :exampleMetadata: fixture=_generated
@@ -4554,7 +4545,7 @@ class CfnLocation(
 
         :param scope: - scope in which this resource is defined.
         :param id: - scoped id of the resource.
-        :param location_name: The location's name.
+        :param location_name: ``AWS::GameLift::Location.LocationName``.
         :param tags: ``AWS::GameLift::Location.Tags``.
         '''
         if __debug__:
@@ -4620,7 +4611,7 @@ class CfnLocation(
     @builtins.property
     @jsii.member(jsii_name="locationName")
     def location_name(self) -> builtins.str:
-        '''The location's name.
+        '''``AWS::GameLift::Location.LocationName``.
 
         :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-location.html#cfn-gamelift-location-locationname
         '''
@@ -4648,7 +4639,7 @@ class CfnLocationProps:
     ) -> None:
         '''Properties for defining a ``CfnLocation``.
 
-        :param location_name: The location's name.
+        :param location_name: ``AWS::GameLift::Location.LocationName``.
         :param tags: ``AWS::GameLift::Location.Tags``.
 
         :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-location.html
@@ -4682,7 +4673,7 @@ class CfnLocationProps:
 
     @builtins.property
     def location_name(self) -> builtins.str:
-        '''The location's name.
+        '''``AWS::GameLift::Location.LocationName``.
 
         :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-location.html#cfn-gamelift-location-locationname
         '''

aws_cdk/aws_grafana/__init__.py

@@ -134,7 +134,7 @@ class CfnWorkspace(
 
         :param scope: - scope in which this resource is defined.
         :param id: - scoped id of the resource.
-        :param account_access_type: Specifies whether the workspace can access AWS resources in this AWS account only, or whether it can also access AWS resources in other accounts in the same organization. If this is ``ORGANIZATION`` , the ``workspaceOrganizationalUnits`` parameter specifies which organizational units the workspace can access.
+        :param account_access_type: Specifies whether the workspace can access AWS resources in this AWS account only, or whether it can also access AWS resources in other accounts in the same organization. If this is ``ORGANIZATION`` , the ``OrganizationalUnits`` parameter specifies which organizational units the workspace can access.
         :param authentication_providers: Specifies whether this workspace uses SAML 2.0, AWS IAM Identity Center (successor to AWS Single Sign-On) , or both to authenticate users for using the Grafana console within a workspace. For more information, see `User authentication in Amazon Managed Grafana <https://docs.aws.amazon.com/grafana/latest/userguide/authentication-in-AMG.html>`_ .
         :param client_token: A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
         :param data_sources: Specifies the AWS data sources that have been configured to have IAM roles and permissions created to allow Amazon Managed Grafana to read data from these sources. This list is only used when the workspace was created through the AWS console, and the ``permissionType`` is ``SERVICE_MANAGED`` .
@@ -304,7 +304,7 @@ class CfnWorkspace(
     def account_access_type(self) -> typing.Optional[builtins.str]:
         '''Specifies whether the workspace can access AWS resources in this AWS account only, or whether it can also access AWS resources in other accounts in the same organization.
 
-        If this is ``ORGANIZATION`` , the ``workspaceOrganizationalUnits`` parameter specifies which organizational units the workspace can access.
+        If this is ``ORGANIZATION`` , the ``OrganizationalUnits`` parameter specifies which organizational units the workspace can access.
 
         :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-grafana-workspace.html#cfn-grafana-workspace-accountaccesstype
         '''
@@ -1112,7 +1112,7 @@ class CfnWorkspaceProps:
     ) -> None:
         '''Properties for defining a ``CfnWorkspace``.
 
-        :param account_access_type: Specifies whether the workspace can access AWS resources in this AWS account only, or whether it can also access AWS resources in other accounts in the same organization. If this is ``ORGANIZATION`` , the ``workspaceOrganizationalUnits`` parameter specifies which organizational units the workspace can access.
+        :param account_access_type: Specifies whether the workspace can access AWS resources in this AWS account only, or whether it can also access AWS resources in other accounts in the same organization. If this is ``ORGANIZATION`` , the ``OrganizationalUnits`` parameter specifies which organizational units the workspace can access.
         :param authentication_providers: Specifies whether this workspace uses SAML 2.0, AWS IAM Identity Center (successor to AWS Single Sign-On) , or both to authenticate users for using the Grafana console within a workspace. For more information, see `User authentication in Amazon Managed Grafana <https://docs.aws.amazon.com/grafana/latest/userguide/authentication-in-AMG.html>`_ .
         :param client_token: A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
         :param data_sources: Specifies the AWS data sources that have been configured to have IAM roles and permissions created to allow Amazon Managed Grafana to read data from these sources. This list is only used when the workspace was created through the AWS console, and the ``permissionType`` is ``SERVICE_MANAGED`` .
@@ -1227,7 +1227,7 @@ class CfnWorkspaceProps:
     def account_access_type(self) -> typing.Optional[builtins.str]:
         '''Specifies whether the workspace can access AWS resources in this AWS account only, or whether it can also access AWS resources in other accounts in the same organization.
 
-        If this is ``ORGANIZATION`` , the ``workspaceOrganizationalUnits`` parameter specifies which organizational units the workspace can access.
+        If this is ``ORGANIZATION`` , the ``OrganizationalUnits`` parameter specifies which organizational units the workspace can access.
 
         :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-grafana-workspace.html#cfn-grafana-workspace-accountaccesstype
         '''

aws_cdk/aws_iam/__init__.py

@@ -173,13 +173,13 @@ property, like shown below:
 # app: App
 
 stack = Stack(app, "MyStack")
-iam.Role.customize_roles(stack,
+iam.Role.customize_roles(self,
     use_precreated_roles={
         "MyStack/MyRole": "my-precreated-role-name"
     }
 )
 
-iam.Role(stack, "MyRole",
+iam.Role(self, "MyRole",
     assumed_by=iam.ServicePrincipal("sns.amazonaws.com")
 )
 ```
@@ -194,13 +194,13 @@ following CDK code:
 stack = Stack(app, "MyStack")
 iam.Role.customize_roles(stack)
 
-fn = lambda_.Function(stack, "MyLambda",
+fn = lambda_.Function(self, "MyLambda",
     code=lambda_.InlineCode("foo"),
     handler="index.handler",
     runtime=lambda_.Runtime.NODEJS_14_X
 )
 
-bucket = s3.Bucket(stack, "Bucket")
+bucket = s3.Bucket(self, "Bucket")
 bucket.grant_read(fn)
 ```
 
@@ -252,7 +252,7 @@ come back and update the `customizeRoles` with the role name.
 # app: App
 
 stack = Stack(app, "MyStack")
-iam.Role.customize_roles(stack,
+iam.Role.customize_roles(self,
     use_precreated_roles={
         "MyStack/MyLambda/ServiceRole": "my-role-name"
     }
@@ -269,7 +269,7 @@ It is also possible to generate the report *without* preventing the role/policy
 ```python
 # stack: Stack
 
-iam.Role.customize_roles(stack,
+iam.Role.customize_roles(self,
     prevent_synthesis=False
 )
 ```
@@ -741,8 +741,8 @@ group = iam.Group.from_group_name(self, "MyImportedGroupByName", "group-name")
 To add a user to a group (both for a new and imported user/group):
 
 ```python
-user = iam.User(self, "MyUser") # or User.fromUserName(stack, 'User', 'johnsmith');
-group = iam.Group(self, "MyGroup") # or Group.fromGroupArn(stack, 'Group', 'arn:aws:iam::account-id:group/group-name');
+user = iam.User(self, "MyUser") # or User.fromUserName(this, 'User', 'johnsmith');
+group = iam.Group(self, "MyGroup") # or Group.fromGroupArn(this, 'Group', 'arn:aws:iam::account-id:group/group-name');
 
 user.add_to_group(group)
 # or
@@ -995,7 +995,6 @@ class AddToResourcePolicyResult:
 
         Example::
 
-            # Example automatically generated from non-compiling source. May contain errors.
             bucket = s3.Bucket.from_bucket_name(self, "existingBucket", "bucket-name")
             
             # No policy statement will be added to the resource
@@ -6107,7 +6106,7 @@ class CustomizeRolesOptions:
         '''Options for customizing IAM role creation.
 
         :param prevent_synthesis: Whether or not to synthesize the resource into the CFN template. Set this to ``false`` if you still want to create the resources *and* you also want to create the policy report. Default: true
-        :param use_precreated_roles: A list of precreated IAM roles to substitute for roles that CDK is creating. The constructPath can be either a relative or absolute path from the scope that ``customizeRoles`` is used on to the role being created. For example, if you were creating a role Default: - there are no precreated roles. Synthesis will fail if ``preventSynthesis=true``
+        :param use_precreated_roles: A list of precreated IAM roles to substitute for roles that CDK is creating. The constructPath can be either a relative or absolute path from the scope that ``customizeRoles`` is used on to the role being created. Default: - there are no precreated roles. Synthesis will fail if ``preventSynthesis=true``
 
         :exampleMetadata: infused
 
@@ -6116,7 +6115,7 @@ class CustomizeRolesOptions:
             # app: App
             
             stack = Stack(app, "MyStack")
-            iam.Role.customize_roles(stack,
+            iam.Role.customize_roles(self,
                 use_precreated_roles={
                     "MyStack/MyLambda/ServiceRole": "my-role-name"
                 }
@@ -6153,17 +6152,19 @@ class CustomizeRolesOptions:
         The constructPath can be either a relative or absolute path
         from the scope that ``customizeRoles`` is used on to the role being created.
 
-        For example, if you were creating a role
-
         :default: - there are no precreated roles. Synthesis will fail if ``preventSynthesis=true``
 
         Example::
 
-            # Example automatically generated from non-compiling source. May contain errors.
+            # app: App
+            
+            
             stack = Stack(app, "MyStack")
-            Role(stack, "MyRole")
+            iam.Role(stack, "MyRole",
+                assumed_by=iam.AccountPrincipal("1111111111")
+            )
             
-            Role.customize_roles(stack,
+            iam.Role.customize_roles(stack,
                 use_precreated_roles={
                     # absolute path
                     "MyStack/MyRole": "my-precreated-role-name",
@@ -6437,7 +6438,6 @@ class Grant(metaclass=jsii.JSIIMeta, jsii_type="aws-cdk-lib.aws_iam.Grant"):
 
     Example::
 
-        # Example automatically generated from non-compiling source. May contain errors.
         # instance: ec2.Instance
         # volume: ec2.Volume
         
@@ -11533,7 +11533,6 @@ class PrincipalBase(
 
     Example::
 
-        # Example automatically generated from non-compiling source. May contain errors.
         tag_param = CfnParameter(self, "TagName")
         
         string_equals = CfnJson(self, "ConditionJson",
@@ -11943,14 +11942,13 @@ class Role(
 
         :param scope: construct scope to customize role creation.
         :param prevent_synthesis: Whether or not to synthesize the resource into the CFN template. Set this to ``false`` if you still want to create the resources *and* you also want to create the policy report. Default: true
-        :param use_precreated_roles: A list of precreated IAM roles to substitute for roles that CDK is creating. The constructPath can be either a relative or absolute path from the scope that ``customizeRoles`` is used on to the role being created. For example, if you were creating a role Default: - there are no precreated roles. Synthesis will fail if ``preventSynthesis=true``
+        :param use_precreated_roles: A list of precreated IAM roles to substitute for roles that CDK is creating. The constructPath can be either a relative or absolute path from the scope that ``customizeRoles`` is used on to the role being created. Default: - there are no precreated roles. Synthesis will fail if ``preventSynthesis=true``
 
         Example::
 
-            # Example automatically generated from non-compiling source. May contain errors.
             # app: App
             
-            Role.customize_roles(app,
+            iam.Role.customize_roles(app,
                 use_precreated_roles={
                     "ConstructPath/To/Role": "my-precreated-role-name"
                 }
@@ -12738,7 +12736,6 @@ class ArnPrincipal(
 
     Example::
 
-        # Example automatically generated from non-compiling source. May contain errors.
         # network_load_balancer1: elbv2.NetworkLoadBalancer
         # network_load_balancer2: elbv2.NetworkLoadBalancer
         
@@ -13295,7 +13292,6 @@ class AccountRootPrincipal(
 
     Example::
 
-        # Example automatically generated from non-compiling source. May contain errors.
         bucket = s3.Bucket(self, "MyBucket")
         result = bucket.add_to_resource_policy(
             iam.PolicyStatement(
@@ -13366,8 +13362,8 @@ class Group(
 
     Example::
 
-        user = iam.User(self, "MyUser") # or User.fromUserName(stack, 'User', 'johnsmith');
-        group = iam.Group(self, "MyGroup") # or Group.fromGroupArn(stack, 'Group', 'arn:aws:iam::account-id:group/group-name');
+        user = iam.User(self, "MyUser") # or User.fromUserName(this, 'User', 'johnsmith');
+        group = iam.Group(self, "MyGroup") # or Group.fromGroupArn(this, 'Group', 'arn:aws:iam::account-id:group/group-name');
         
         user.add_to_group(group)
         # or