aws-cdk-lib 2.165.0__py3-none-any.whl → 2.167.0__py3-none-any.whl

aws_cdk/aws_backup/__init__.py

@@ -4696,14 +4696,14 @@ class CfnLogicallyAirGappedBackupVault(
         '''
         :param scope: Scope in which this resource is defined.
         :param id: Construct identifier for this resource (unique in its scope).
-        :param backup_vault_name: 
-        :param max_retention_days: 
-        :param min_retention_days: 
-        :param access_policy: 
-        :param backup_vault_tags: 
-        :param notifications: 
-        :param vault_state: 
-        :param vault_type: 
+        :param backup_vault_name: The name of a logical container where backups are stored. Logically air-gapped backup vaults are identified by names that are unique to the account used to create them and the Region where they are created.
+        :param max_retention_days: The maximum retention period that the vault retains its recovery points.
+        :param min_retention_days: This setting specifies the minimum retention period that the vault retains its recovery points. The minimum value accepted is 7 days.
+        :param access_policy: The backup vault access policy document in JSON format.
+        :param backup_vault_tags: The tags to assign to the vault.
+        :param notifications: Returns event notifications for the specified backup vault.
+        :param vault_state: The current state of the vault.
+        :param vault_type: The type of vault described.
         '''
         if __debug__:
             type_hints = typing.get_type_hints(_typecheckingstub__f46c2d817c43abec9e204fc8a7211b43dd15b93e11a637e67a9711664c3afd52)
@@ -4782,6 +4782,7 @@ class CfnLogicallyAirGappedBackupVault(
     @builtins.property
     @jsii.member(jsii_name="backupVaultName")
     def backup_vault_name(self) -> builtins.str:
+        '''The name of a logical container where backups are stored.'''
         return typing.cast(builtins.str, jsii.get(self, "backupVaultName"))
 
     @backup_vault_name.setter
@@ -4794,6 +4795,7 @@ class CfnLogicallyAirGappedBackupVault(
     @builtins.property
     @jsii.member(jsii_name="maxRetentionDays")
     def max_retention_days(self) -> jsii.Number:
+        '''The maximum retention period that the vault retains its recovery points.'''
         return typing.cast(jsii.Number, jsii.get(self, "maxRetentionDays"))
 
     @max_retention_days.setter
@@ -4806,6 +4808,7 @@ class CfnLogicallyAirGappedBackupVault(
     @builtins.property
     @jsii.member(jsii_name="minRetentionDays")
     def min_retention_days(self) -> jsii.Number:
+        '''This setting specifies the minimum retention period that the vault retains its recovery points.'''
         return typing.cast(jsii.Number, jsii.get(self, "minRetentionDays"))
 
     @min_retention_days.setter
@@ -4818,6 +4821,7 @@ class CfnLogicallyAirGappedBackupVault(
     @builtins.property
     @jsii.member(jsii_name="accessPolicy")
     def access_policy(self) -> typing.Any:
+        '''The backup vault access policy document in JSON format.'''
         return typing.cast(typing.Any, jsii.get(self, "accessPolicy"))
 
     @access_policy.setter
@@ -4832,6 +4836,7 @@ class CfnLogicallyAirGappedBackupVault(
     def backup_vault_tags(
         self,
     ) -> typing.Optional[typing.Mapping[builtins.str, builtins.str]]:
+        '''The tags to assign to the vault.'''
         return typing.cast(typing.Optional[typing.Mapping[builtins.str, builtins.str]], jsii.get(self, "backupVaultTags"))
 
     @backup_vault_tags.setter
@@ -4849,6 +4854,7 @@ class CfnLogicallyAirGappedBackupVault(
     def notifications(
         self,
     ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnLogicallyAirGappedBackupVault.NotificationObjectTypeProperty"]]:
+        '''Returns event notifications for the specified backup vault.'''
         return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnLogicallyAirGappedBackupVault.NotificationObjectTypeProperty"]], jsii.get(self, "notifications"))
 
     @notifications.setter
@@ -4864,6 +4870,7 @@ class CfnLogicallyAirGappedBackupVault(
     @builtins.property
     @jsii.member(jsii_name="vaultState")
     def vault_state(self) -> typing.Optional[builtins.str]:
+        '''The current state of the vault.'''
         return typing.cast(typing.Optional[builtins.str], jsii.get(self, "vaultState"))
 
     @vault_state.setter
@@ -4876,6 +4883,7 @@ class CfnLogicallyAirGappedBackupVault(
     @builtins.property
     @jsii.member(jsii_name="vaultType")
     def vault_type(self) -> typing.Optional[builtins.str]:
+        '''The type of vault described.'''
         return typing.cast(typing.Optional[builtins.str], jsii.get(self, "vaultType"))
 
     @vault_type.setter
@@ -4901,8 +4909,8 @@ class CfnLogicallyAirGappedBackupVault(
             sns_topic_arn: builtins.str,
         ) -> None:
             '''
-            :param backup_vault_events: 
-            :param sns_topic_arn: 
+            :param backup_vault_events: An array of events that indicate the status of jobs to back up resources to the backup vault.
+            :param sns_topic_arn: The Amazon Resource Name (ARN) that specifies the topic for a backup vault’s events; for example, ``arn:aws:sns:us-west-2:111122223333:MyVaultTopic`` .
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-logicallyairgappedbackupvault-notificationobjecttype.html
             :exampleMetadata: fixture=_generated
@@ -4929,7 +4937,8 @@ class CfnLogicallyAirGappedBackupVault(
 
         @builtins.property
         def backup_vault_events(self) -> typing.List[builtins.str]:
-            '''
+            '''An array of events that indicate the status of jobs to back up resources to the backup vault.
+
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-logicallyairgappedbackupvault-notificationobjecttype.html#cfn-backup-logicallyairgappedbackupvault-notificationobjecttype-backupvaultevents
             '''
             result = self._values.get("backup_vault_events")
@@ -4938,7 +4947,10 @@ class CfnLogicallyAirGappedBackupVault(
 
         @builtins.property
         def sns_topic_arn(self) -> builtins.str:
-            '''
+            '''The Amazon Resource Name (ARN) that specifies the topic for a backup vault’s events;
+
+            for example, ``arn:aws:sns:us-west-2:111122223333:MyVaultTopic`` .
+
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-logicallyairgappedbackupvault-notificationobjecttype.html#cfn-backup-logicallyairgappedbackupvault-notificationobjecttype-snstopicarn
             '''
             result = self._values.get("sns_topic_arn")
@@ -4986,14 +4998,14 @@ class CfnLogicallyAirGappedBackupVaultProps:
     ) -> None:
         '''Properties for defining a ``CfnLogicallyAirGappedBackupVault``.
 
-        :param backup_vault_name: 
-        :param max_retention_days: 
-        :param min_retention_days: 
-        :param access_policy: 
-        :param backup_vault_tags: 
-        :param notifications: 
-        :param vault_state: 
-        :param vault_type: 
+        :param backup_vault_name: The name of a logical container where backups are stored. Logically air-gapped backup vaults are identified by names that are unique to the account used to create them and the Region where they are created.
+        :param max_retention_days: The maximum retention period that the vault retains its recovery points.
+        :param min_retention_days: This setting specifies the minimum retention period that the vault retains its recovery points. The minimum value accepted is 7 days.
+        :param access_policy: The backup vault access policy document in JSON format.
+        :param backup_vault_tags: The tags to assign to the vault.
+        :param notifications: Returns event notifications for the specified backup vault.
+        :param vault_state: The current state of the vault.
+        :param vault_type: The type of vault described.
 
         :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-logicallyairgappedbackupvault.html
         :exampleMetadata: fixture=_generated
@@ -5052,7 +5064,10 @@ class CfnLogicallyAirGappedBackupVaultProps:
 
     @builtins.property
     def backup_vault_name(self) -> builtins.str:
-        '''
+        '''The name of a logical container where backups are stored.
+
+        Logically air-gapped backup vaults are identified by names that are unique to the account used to create them and the Region where they are created.
+
         :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-logicallyairgappedbackupvault.html#cfn-backup-logicallyairgappedbackupvault-backupvaultname
         '''
         result = self._values.get("backup_vault_name")
@@ -5061,7 +5076,8 @@ class CfnLogicallyAirGappedBackupVaultProps:
 
     @builtins.property
     def max_retention_days(self) -> jsii.Number:
-        '''
+        '''The maximum retention period that the vault retains its recovery points.
+
         :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-logicallyairgappedbackupvault.html#cfn-backup-logicallyairgappedbackupvault-maxretentiondays
         '''
         result = self._values.get("max_retention_days")
@@ -5070,7 +5086,10 @@ class CfnLogicallyAirGappedBackupVaultProps:
 
     @builtins.property
     def min_retention_days(self) -> jsii.Number:
-        '''
+        '''This setting specifies the minimum retention period that the vault retains its recovery points.
+
+        The minimum value accepted is 7 days.
+
         :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-logicallyairgappedbackupvault.html#cfn-backup-logicallyairgappedbackupvault-minretentiondays
         '''
         result = self._values.get("min_retention_days")
@@ -5079,7 +5098,8 @@ class CfnLogicallyAirGappedBackupVaultProps:
 
     @builtins.property
     def access_policy(self) -> typing.Any:
-        '''
+        '''The backup vault access policy document in JSON format.
+
         :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-logicallyairgappedbackupvault.html#cfn-backup-logicallyairgappedbackupvault-accesspolicy
         '''
         result = self._values.get("access_policy")
@@ -5089,7 +5109,8 @@ class CfnLogicallyAirGappedBackupVaultProps:
     def backup_vault_tags(
         self,
     ) -> typing.Optional[typing.Mapping[builtins.str, builtins.str]]:
-        '''
+        '''The tags to assign to the vault.
+
         :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-logicallyairgappedbackupvault.html#cfn-backup-logicallyairgappedbackupvault-backupvaulttags
         '''
         result = self._values.get("backup_vault_tags")
@@ -5099,7 +5120,8 @@ class CfnLogicallyAirGappedBackupVaultProps:
     def notifications(
         self,
     ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnLogicallyAirGappedBackupVault.NotificationObjectTypeProperty]]:
-        '''
+        '''Returns event notifications for the specified backup vault.
+
         :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-logicallyairgappedbackupvault.html#cfn-backup-logicallyairgappedbackupvault-notifications
         '''
         result = self._values.get("notifications")
@@ -5107,7 +5129,8 @@ class CfnLogicallyAirGappedBackupVaultProps:
 
     @builtins.property
     def vault_state(self) -> typing.Optional[builtins.str]:
-        '''
+        '''The current state of the vault.
+
         :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-logicallyairgappedbackupvault.html#cfn-backup-logicallyairgappedbackupvault-vaultstate
         '''
         result = self._values.get("vault_state")
@@ -5115,7 +5138,8 @@ class CfnLogicallyAirGappedBackupVaultProps:
 
     @builtins.property
     def vault_type(self) -> typing.Optional[builtins.str]:
-        '''
+        '''The type of vault described.
+
         :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-logicallyairgappedbackupvault.html#cfn-backup-logicallyairgappedbackupvault-vaulttype
         '''
         result = self._values.get("vault_type")
@@ -5757,7 +5781,7 @@ class CfnRestoreTestingPlan(
         :param restore_testing_plan_name: The RestoreTestingPlanName is a unique string that is the name of the restore testing plan. This cannot be changed after creation, and it must consist of only alphanumeric characters and underscores.
         :param schedule_expression: A CRON expression in specified timezone when a restore testing plan is executed.
         :param schedule_expression_timezone: Optional. This is the timezone in which the schedule expression is set. By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone.
-        :param schedule_status: 
+        :param schedule_status: This parameter is not currently supported.
         :param start_window_hours: Defaults to 24 hours. A value in hours after a restore test is scheduled before a job will be canceled if it doesn't start successfully. This value is optional. If this value is included, this parameter has a maximum value of 168 hours (one week).
         :param tags: Optional tags to include. A tag is a key-value pair you can use to manage, filter, and search for your resources. Allowed characters include UTF-8 letters,numbers, spaces, and the following characters: ``+ - = . _ : /.``
         '''
@@ -5890,6 +5914,7 @@ class CfnRestoreTestingPlan(
     @builtins.property
     @jsii.member(jsii_name="scheduleStatus")
     def schedule_status(self) -> typing.Optional[builtins.str]:
+        '''This parameter is not currently supported.'''
         return typing.cast(typing.Optional[builtins.str], jsii.get(self, "scheduleStatus"))
 
     @schedule_status.setter
@@ -6097,7 +6122,7 @@ class CfnRestoreTestingPlanProps:
         :param restore_testing_plan_name: The RestoreTestingPlanName is a unique string that is the name of the restore testing plan. This cannot be changed after creation, and it must consist of only alphanumeric characters and underscores.
         :param schedule_expression: A CRON expression in specified timezone when a restore testing plan is executed.
         :param schedule_expression_timezone: Optional. This is the timezone in which the schedule expression is set. By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone.
-        :param schedule_status: 
+        :param schedule_status: This parameter is not currently supported.
         :param start_window_hours: Defaults to 24 hours. A value in hours after a restore test is scheduled before a job will be canceled if it doesn't start successfully. This value is optional. If this value is included, this parameter has a maximum value of 168 hours (one week).
         :param tags: Optional tags to include. A tag is a key-value pair you can use to manage, filter, and search for your resources. Allowed characters include UTF-8 letters,numbers, spaces, and the following characters: ``+ - = . _ : /.``
 
@@ -6203,7 +6228,8 @@ class CfnRestoreTestingPlanProps:
 
     @builtins.property
     def schedule_status(self) -> typing.Optional[builtins.str]:
-        '''
+        '''This parameter is not currently supported.
+
         :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-restoretestingplan.html#cfn-backup-restoretestingplan-schedulestatus
         '''
         result = self._values.get("schedule_status")