Class BackupRuleInput

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

Specifies a scheduled task used to back up a selection of resources.

See Also:

  • Method Details

    • 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.

    • targetBackupVaultName

      public final String targetBackupVaultName()

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

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

    • scheduleExpression

      public final String scheduleExpression()

      A CRON expression in UTC specifying when Backup initiates a backup job. When no CRON expression is provided, Backup will use the default expression cron(0 5 ? * * *).

      Returns:
      A CRON expression in UTC specifying when Backup initiates a backup job. When no CRON expression is provided, Backup will use the default expression cron(0 5 ? * * *).

    • 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. This value is optional. If this value is included, it must be at least 60 minutes to avoid errors.

      This parameter has a maximum value of 100 years (52,560,000 minutes).

      During the start window, the backup job status remains in CREATED status until it has successfully begun or until the start window time has run out. If within the start window time Backup receives an error that allows the job to be retried, Backup will automatically retry to begin the job at least every 10 minutes until the backup successfully begins (the job status changes to RUNNING) or until the job status changes to EXPIRED (which is expected to occur when the start window time is over).

      Returns:
      A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully. This value is optional. If this value is included, it must be at least 60 minutes to avoid errors.

      This parameter has a maximum value of 100 years (52,560,000 minutes).

      During the start window, the backup job status remains in CREATED status until it has successfully begun or until the start window time has run out. If within the start window time Backup receives an error that allows the job to be retried, Backup will automatically retry to begin the job at least every 10 minutes until the backup successfully begins (the job status changes to RUNNING) or until the job status changes to EXPIRED (which is expected to occur when the start window time is over).

    • completionWindowMinutes

      public final Long completionWindowMinutes()

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

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

    • lifecycle

      public final Lifecycle lifecycle()

      The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup will transition and expire backups automatically according to the lifecycle that you define.

      Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold storage.

      Resource types that can transition to cold storage are listed in the Feature availability by resource table. Backup ignores this expression for other resource types.

      This parameter has a maximum value of 100 years (36,500 days).

      Returns:
      The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup will transition and expire backups automatically according to the lifecycle that you define.

      Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold storage.

      Resource types that can transition to cold storage are listed in the Feature availability by resource table. Backup ignores this expression for other resource types.

      This parameter has a maximum value of 100 years (36,500 days).

    • hasRecoveryPointTags

      public final boolean hasRecoveryPointTags()
      For responses, this returns true if the service returned a value for the RecoveryPointTags 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.

    • recoveryPointTags

      public final Map<String,String> recoveryPointTags()

      The tags to assign to the resources.

      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 hasRecoveryPointTags() method.

      Returns:
      The tags to assign to the resources.

    • 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<CopyAction> copyActions()

      An array of CopyAction objects, which contains the 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, which contains the details of the copy operation.

    • enableContinuousBackup

      public final Boolean enableContinuousBackup()

      Specifies whether Backup creates continuous backups. True causes Backup to create continuous backups capable of point-in-time restore (PITR). False (or not specified) causes Backup to create snapshot backups.

      Returns:
      Specifies whether Backup creates continuous backups. True causes Backup to create continuous backups capable of point-in-time restore (PITR). False (or not specified) causes Backup to create snapshot backups.

    • scheduleExpressionTimezone

      public final String scheduleExpressionTimezone()

      The timezone in which the schedule expression is set. By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone.

      Returns:
      The timezone in which the schedule expression is set. By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone.

    • hasIndexActions

      public final boolean hasIndexActions()
      For responses, this returns true if the service returned a value for the IndexActions 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.

    • indexActions

      public final List<IndexAction> indexActions()

      There can up to one IndexAction in each BackupRule, as each backup can have 0 or 1 backup index associated with it.

      Within the array is ResourceTypes. Only 1 resource type will be accepted for each BackupRule. Valid values:

      • EBS for Amazon Elastic Block Store

      • S3 for Amazon Simple Storage Service (Amazon S3)

      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 hasIndexActions() method.

      Returns:
      There can up to one IndexAction in each BackupRule, as each backup can have 0 or 1 backup index associated with it.

      Within the array is ResourceTypes. Only 1 resource type will be accepted for each BackupRule. Valid values:

      • EBS for Amazon Elastic Block Store

      • S3 for Amazon Simple Storage Service (Amazon S3)

    • toBuilder

      public BackupRuleInput.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<BackupRuleInput.Builder,BackupRuleInput>
      Returns:
      a builder for type T

    • builder

      public static BackupRuleInput.Builder builder()

    • serializableBuilderClass

      public static Class<? extends BackupRuleInput.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.