Class AwsBackupBackupPlanRuleDetails

java.lang.Object
software.amazon.awssdk.services.securityhub.model.AwsBackupBackupPlanRuleDetails
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<AwsBackupBackupPlanRuleDetails.Builder,AwsBackupBackupPlanRuleDetails>
@Generated("software.amazon.awssdk:codegen") public final class AwsBackupBackupPlanRuleDetails extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AwsBackupBackupPlanRuleDetails.Builder,AwsBackupBackupPlanRuleDetails>

Provides details about an array of BackupRule objects, each of which specifies a scheduled task that is used to back up a selection of resources.

See Also:

  • Method Details

    • targetBackupVault

      public final String targetBackupVault()

      The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the Amazon Web Services account used to create them and the Amazon Web Services Region where they are created. They consist of letters, numbers, and hyphens.

      Returns:
      The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the Amazon Web Services account used to create them and the Amazon Web Services Region where they are created. They consist of letters, numbers, and hyphens.

    • startWindowMinutes

      public final Long startWindowMinutes()

      A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully.

      Returns:
      A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully.

    • scheduleExpression

      public final String scheduleExpression()

      A cron expression in UTC specifying when Backup initiates a backup job.

      Returns:
      A cron expression in UTC specifying when Backup initiates a backup job.

    • ruleName

      public final String ruleName()

      A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.' characters.

      Returns:
      A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.' characters.

    • ruleId

      public final String ruleId()

      Uniquely identifies a rule that is used to schedule the backup of a selection of resources.

      Returns:
      Uniquely identifies a rule that is used to schedule the backup of a selection of resources.

    • enableContinuousBackup

      public final Boolean enableContinuousBackup()

      Specifies whether Backup creates continuous backups capable of point-in-time restore (PITR).

      Returns:
      Specifies whether Backup creates continuous backups capable of point-in-time restore (PITR).

    • completionWindowMinutes

      public final Long completionWindowMinutes()

      A value in minutes after a backup job is successfully started before it must be completed, or it is canceled by Backup.

      Returns:
      A value in minutes after a backup job is successfully started before it must be completed, or it is canceled by Backup.

    • hasCopyActions

      public final boolean hasCopyActions()
      For responses, this returns true if the service returned a value for the CopyActions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • copyActions

      public final List<AwsBackupBackupPlanRuleCopyActionsDetails> copyActions()

      An array of CopyAction objects, each of which contains details of the copy operation.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasCopyActions() method.

      Returns:
      An array of CopyAction objects, each of which contains details of the copy operation.

    • lifecycle

      public final AwsBackupBackupPlanLifecycleDetails lifecycle()

      Defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define. If you don't specify a lifecycle, Backup applies the lifecycle policy of the source backup to the destination backup.

      Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days.

      Returns:
      Defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define. If you don't specify a lifecycle, Backup applies the lifecycle policy of the source backup to the destination backup.

      Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days.

    • toBuilder

      public AwsBackupBackupPlanRuleDetails.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<AwsBackupBackupPlanRuleDetails.Builder,AwsBackupBackupPlanRuleDetails>
      Returns:
      a builder for type T

    • builder

      public static AwsBackupBackupPlanRuleDetails.Builder builder()

    • serializableBuilderClass

      public static Class<? extends AwsBackupBackupPlanRuleDetails.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.