aws-cdk-lib 2.172.0__py3-none-any.whl → 2.173.1__py3-none-any.whl

aws_cdk/aws_iotsitewise/__init__.py

@@ -4901,7 +4901,7 @@ class CfnPortal(
         :param notification_sender_email: The email address that sends alarm notifications. .. epigraph:: If you use the `AWS IoT Events managed Lambda function <https://docs.aws.amazon.com/iotevents/latest/developerguide/lambda-support.html>`_ to manage your emails, you must `verify the sender email address in Amazon SES <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-email-addresses.html>`_ .
         :param portal_auth_mode: The service to use to authenticate users to the portal. Choose from the following options:. - ``SSO`` – The portal uses AWS IAM Identity Center to authenticate users and manage user permissions. Before you can create a portal that uses IAM Identity Center, you must enable IAM Identity Center. For more information, see `Enabling IAM Identity Center <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-get-started.html#mon-gs-sso>`_ in the *AWS IoT SiteWise User Guide* . This option is only available in AWS Regions other than the China Regions. - ``IAM`` – The portal uses AWS Identity and Access Management to authenticate users and manage user permissions. You can't change this value after you create a portal. Default: ``SSO``
         :param portal_description: A description for the portal.
-        :param portal_type: The type of portal.
+        :param portal_type: Define the type of portal. The value for AWS IoT SiteWise Monitor (Classic) is ``SITEWISE_PORTAL_V1`` . The value for AWS IoT SiteWise Monitor (AI-aware) is ``SITEWISE_PORTAL_V2`` .
         :param portal_type_configuration: Map to associate detail of configuration related with a PortalType.
         :param tags: A list of key-value pairs that contain metadata for the portal. For more information, see `Tagging your AWS IoT SiteWise resources <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html>`_ in the *AWS IoT SiteWise User Guide* .
         '''
@@ -5100,7 +5100,7 @@ class CfnPortal(
     @builtins.property
     @jsii.member(jsii_name="portalType")
     def portal_type(self) -> typing.Optional[builtins.str]:
-        '''The type of portal.'''
+        '''Define the type of portal.'''
         return typing.cast(typing.Optional[builtins.str], jsii.get(self, "portalType"))
 
     @portal_type.setter
@@ -5309,7 +5309,7 @@ class CfnPortalProps:
         :param notification_sender_email: The email address that sends alarm notifications. .. epigraph:: If you use the `AWS IoT Events managed Lambda function <https://docs.aws.amazon.com/iotevents/latest/developerguide/lambda-support.html>`_ to manage your emails, you must `verify the sender email address in Amazon SES <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-email-addresses.html>`_ .
         :param portal_auth_mode: The service to use to authenticate users to the portal. Choose from the following options:. - ``SSO`` – The portal uses AWS IAM Identity Center to authenticate users and manage user permissions. Before you can create a portal that uses IAM Identity Center, you must enable IAM Identity Center. For more information, see `Enabling IAM Identity Center <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-get-started.html#mon-gs-sso>`_ in the *AWS IoT SiteWise User Guide* . This option is only available in AWS Regions other than the China Regions. - ``IAM`` – The portal uses AWS Identity and Access Management to authenticate users and manage user permissions. You can't change this value after you create a portal. Default: ``SSO``
         :param portal_description: A description for the portal.
-        :param portal_type: The type of portal.
+        :param portal_type: Define the type of portal. The value for AWS IoT SiteWise Monitor (Classic) is ``SITEWISE_PORTAL_V1`` . The value for AWS IoT SiteWise Monitor (AI-aware) is ``SITEWISE_PORTAL_V2`` .
         :param portal_type_configuration: Map to associate detail of configuration related with a PortalType.
         :param tags: A list of key-value pairs that contain metadata for the portal. For more information, see `Tagging your AWS IoT SiteWise resources <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html>`_ in the *AWS IoT SiteWise User Guide* .
 
@@ -5459,7 +5459,9 @@ class CfnPortalProps:
 
     @builtins.property
     def portal_type(self) -> typing.Optional[builtins.str]:
-        '''The type of portal.
+        '''Define the type of portal.
+
+        The value for AWS IoT SiteWise Monitor (Classic) is ``SITEWISE_PORTAL_V1`` . The value for AWS IoT SiteWise Monitor (AI-aware) is ``SITEWISE_PORTAL_V2`` .
 
         :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-portal.html#cfn-iotsitewise-portal-portaltype
         '''

aws_cdk/aws_ivs/__init__.py

@@ -955,7 +955,9 @@ class CfnIngestConfiguration(
     metaclass=jsii.JSIIMeta,
     jsii_type="aws-cdk-lib.aws_ivs.CfnIngestConfiguration",
 ):
-    '''Resource Type definition for AWS::IVS::IngestConfiguration.
+    '''The ``AWS::IVS::IngestConfiguration`` resource specifies an ingest protocol to be used for a stage.
+
+    For more information, see `Stream Ingest <https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-stream-ingest.html>`_ in the *Amazon IVS Real-Time Streaming User Guide* .
 
     :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-ingestconfiguration.html
     :cloudformationResource: AWS::IVS::IngestConfiguration
@@ -995,12 +997,12 @@ class CfnIngestConfiguration(
         '''
         :param scope: Scope in which this resource is defined.
         :param id: Construct identifier for this resource (unique in its scope).
-        :param ingest_protocol: Ingest Protocol. Default: - "RTMPS"
-        :param insecure_ingest: Whether ingest configuration allows insecure ingest. Default: - false
-        :param name: IngestConfiguration. Default: - "-"
-        :param stage_arn: Stage ARN. A value other than an empty string indicates that stage is linked to IngestConfiguration. Default: "" (recording is disabled). Default: - ""
-        :param tags: A list of key-value pairs that contain metadata for the asset model.
-        :param user_id: User defined indentifier for participant associated with IngestConfiguration.
+        :param ingest_protocol: Type of ingest protocol that the user employs for broadcasting. Default: - "RTMPS"
+        :param insecure_ingest: Whether the channel allows insecure RTMP ingest. Default: ``false`` . Default: - false
+        :param name: Ingest name. Default: - "-"
+        :param stage_arn: ARN of the stage with which the IngestConfiguration is associated. Default: - ""
+        :param tags: An array of key-value pairs to apply to this resource.
+        :param user_id: Customer-assigned name to help identify the participant using the IngestConfiguration; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. *This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.*
         '''
         if __debug__:
             type_hints = typing.get_type_hints(_typecheckingstub__c56f46c8c3462fcf78f3e0898b4048a399a031987b0a76a9193f42a0a98fcd5e)
@@ -1050,7 +1052,9 @@ class CfnIngestConfiguration(
     @builtins.property
     @jsii.member(jsii_name="attrArn")
     def attr_arn(self) -> builtins.str:
-        '''IngestConfiguration ARN is automatically generated on creation and assigned as the unique identifier.
+        '''The ingest-configuration ARN.
+
+        For example: ``arn:aws:ivs:us-west-2:123456789012:ingest-configuration/abcdABCDefgh``
 
         :cloudformationAttribute: Arn
         '''
@@ -1059,7 +1063,9 @@ class CfnIngestConfiguration(
     @builtins.property
     @jsii.member(jsii_name="attrParticipantId")
     def attr_participant_id(self) -> builtins.str:
-        '''Participant Id is automatically generated on creation and assigned.
+        '''ID of the participant within the stage.
+
+        For example: ``abCDEf12GHIj``
 
         :cloudformationAttribute: ParticipantId
         '''
@@ -1068,7 +1074,9 @@ class CfnIngestConfiguration(
     @builtins.property
     @jsii.member(jsii_name="attrState")
     def attr_state(self) -> builtins.str:
-        '''State of IngestConfiguration which determines whether IngestConfiguration is in use or not.
+        '''State of the ingest configuration.
+
+        It is ``ACTIVE`` if a publisher currently is publishing to the stage associated with the ingest configuration. Valid values: ``ACTIVE`` | ``INACTIVE`` .
 
         :cloudformationAttribute: State
         '''
@@ -1077,7 +1085,9 @@ class CfnIngestConfiguration(
     @builtins.property
     @jsii.member(jsii_name="attrStreamKey")
     def attr_stream_key(self) -> builtins.str:
-        '''Stream-key value.
+        '''Ingest-key value for the RTMP(S) protocol.
+
+        For example: ``skSKABCDefgh``
 
         :cloudformationAttribute: StreamKey
         '''
@@ -1097,7 +1107,7 @@ class CfnIngestConfiguration(
     @builtins.property
     @jsii.member(jsii_name="ingestProtocol")
     def ingest_protocol(self) -> typing.Optional[builtins.str]:
-        '''Ingest Protocol.'''
+        '''Type of ingest protocol that the user employs for broadcasting.'''
         return typing.cast(typing.Optional[builtins.str], jsii.get(self, "ingestProtocol"))
 
     @ingest_protocol.setter
@@ -1112,7 +1122,7 @@ class CfnIngestConfiguration(
     def insecure_ingest(
         self,
     ) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
-        '''Whether ingest configuration allows insecure ingest.'''
+        '''Whether the channel allows insecure RTMP ingest.'''
         return typing.cast(typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]], jsii.get(self, "insecureIngest"))
 
     @insecure_ingest.setter
@@ -1128,7 +1138,7 @@ class CfnIngestConfiguration(
     @builtins.property
     @jsii.member(jsii_name="name")
     def name(self) -> typing.Optional[builtins.str]:
-        '''IngestConfiguration.'''
+        '''Ingest name.'''
         return typing.cast(typing.Optional[builtins.str], jsii.get(self, "name"))
 
     @name.setter
@@ -1141,7 +1151,7 @@ class CfnIngestConfiguration(
     @builtins.property
     @jsii.member(jsii_name="stageArn")
     def stage_arn(self) -> typing.Optional[builtins.str]:
-        '''Stage ARN.'''
+        '''ARN of the stage with which the IngestConfiguration is associated.'''
         return typing.cast(typing.Optional[builtins.str], jsii.get(self, "stageArn"))
 
     @stage_arn.setter
@@ -1154,7 +1164,7 @@ class CfnIngestConfiguration(
     @builtins.property
     @jsii.member(jsii_name="tags")
     def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
-        '''A list of key-value pairs that contain metadata for the asset model.'''
+        '''An array of key-value pairs to apply to this resource.'''
         return typing.cast(typing.Optional[typing.List[_CfnTag_f6864754]], jsii.get(self, "tags"))
 
     @tags.setter
@@ -1167,7 +1177,7 @@ class CfnIngestConfiguration(
     @builtins.property
     @jsii.member(jsii_name="userId")
     def user_id(self) -> typing.Optional[builtins.str]:
-        '''User defined indentifier for participant associated with IngestConfiguration.'''
+        '''Customer-assigned name to help identify the participant using the IngestConfiguration;'''
         return typing.cast(typing.Optional[builtins.str], jsii.get(self, "userId"))
 
     @user_id.setter
@@ -1203,12 +1213,12 @@ class CfnIngestConfigurationProps:
     ) -> None:
         '''Properties for defining a ``CfnIngestConfiguration``.
 
-        :param ingest_protocol: Ingest Protocol. Default: - "RTMPS"
-        :param insecure_ingest: Whether ingest configuration allows insecure ingest. Default: - false
-        :param name: IngestConfiguration. Default: - "-"
-        :param stage_arn: Stage ARN. A value other than an empty string indicates that stage is linked to IngestConfiguration. Default: "" (recording is disabled). Default: - ""
-        :param tags: A list of key-value pairs that contain metadata for the asset model.
-        :param user_id: User defined indentifier for participant associated with IngestConfiguration.
+        :param ingest_protocol: Type of ingest protocol that the user employs for broadcasting. Default: - "RTMPS"
+        :param insecure_ingest: Whether the channel allows insecure RTMP ingest. Default: ``false`` . Default: - false
+        :param name: Ingest name. Default: - "-"
+        :param stage_arn: ARN of the stage with which the IngestConfiguration is associated. Default: - ""
+        :param tags: An array of key-value pairs to apply to this resource.
+        :param user_id: Customer-assigned name to help identify the participant using the IngestConfiguration; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. *This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.*
 
         :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-ingestconfiguration.html
         :exampleMetadata: fixture=_generated
@@ -1255,7 +1265,7 @@ class CfnIngestConfigurationProps:
 
     @builtins.property
     def ingest_protocol(self) -> typing.Optional[builtins.str]:
-        '''Ingest Protocol.
+        '''Type of ingest protocol that the user employs for broadcasting.
 
         :default: - "RTMPS"
 
@@ -1268,7 +1278,9 @@ class CfnIngestConfigurationProps:
     def insecure_ingest(
         self,
     ) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
-        '''Whether ingest configuration allows insecure ingest.
+        '''Whether the channel allows insecure RTMP ingest.
+
+        Default: ``false`` .
 
         :default: - false
 
@@ -1279,7 +1291,7 @@ class CfnIngestConfigurationProps:
 
     @builtins.property
     def name(self) -> typing.Optional[builtins.str]:
-        '''IngestConfiguration.
+        '''Ingest name.
 
         :default: - "-"
 
@@ -1290,9 +1302,7 @@ class CfnIngestConfigurationProps:
 
     @builtins.property
     def stage_arn(self) -> typing.Optional[builtins.str]:
-        '''Stage ARN.
-
-        A value other than an empty string indicates that stage is linked to IngestConfiguration. Default: "" (recording is disabled).
+        '''ARN of the stage with which the IngestConfiguration is associated.
 
         :default: - ""
 
@@ -1303,7 +1313,7 @@ class CfnIngestConfigurationProps:
 
     @builtins.property
     def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
-        '''A list of key-value pairs that contain metadata for the asset model.
+        '''An array of key-value pairs to apply to this resource.
 
         :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-ingestconfiguration.html#cfn-ivs-ingestconfiguration-tags
         '''
@@ -1312,7 +1322,9 @@ class CfnIngestConfigurationProps:
 
     @builtins.property
     def user_id(self) -> typing.Optional[builtins.str]:
-        '''User defined indentifier for participant associated with IngestConfiguration.
+        '''Customer-assigned name to help identify the participant using the IngestConfiguration;
+
+        this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. *This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.*
 
         :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-ingestconfiguration.html#cfn-ivs-ingestconfiguration-userid
         '''

aws_cdk/aws_kendra/__init__.py

@@ -9677,6 +9677,10 @@ class CfnIndex(
         ) -> None:
             '''Provides the configuration information for a token.
 
+            .. epigraph::
+
+               If you're using an Amazon Kendra Gen AI Enterprise Edition index and you try to use ``UserTokenConfigurations`` to configure user context policy, Amazon Kendra returns a ``ValidationException`` error.
+
             :param json_token_type_configuration: Information about the JSON token type configuration.
             :param jwt_token_type_configuration: Information about the JWT token type configuration.
 

aws_cdk/aws_lakeformation/__init__.py

@@ -4108,7 +4108,8 @@ class CfnResource(
     @builtins.property
     @jsii.member(jsii_name="attrId")
     def attr_id(self) -> builtins.str:
-        '''
+        '''An identifier for the catalog resource.
+
         :cloudformationAttribute: Id
         '''
         return typing.cast(builtins.str, jsii.get(self, "attrId"))