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
BackupRuleobjects, each of which specifies a scheduled task that is used to back up a selection of resources.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceAwsBackupBackupPlanRuleDetails.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static AwsBackupBackupPlanRuleDetails.Builderbuilder()LongcompletionWindowMinutes()A value in minutes after a backup job is successfully started before it must be completed, or it is canceled by Backup.List<AwsBackupBackupPlanRuleCopyActionsDetails>copyActions()An array ofCopyActionobjects, each of which contains details of the copy operation.BooleanenableContinuousBackup()Specifies whether Backup creates continuous backups capable of point-in-time restore (PITR).booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasCopyActions()For responses, this returns true if the service returned a value for the CopyActions property.inthashCode()AwsBackupBackupPlanLifecycleDetailslifecycle()Defines when a protected resource is transitioned to cold storage and when it expires.StringruleId()Uniquely identifies a rule that is used to schedule the backup of a selection of resources.StringruleName()A display name for a backup rule.StringscheduleExpression()A cron expression in UTC specifying when Backup initiates a backup job.List<SdkField<?>>sdkFields()static Class<? extends AwsBackupBackupPlanRuleDetails.Builder>serializableBuilderClass()LongstartWindowMinutes()A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully.StringtargetBackupVault()The name of a logical container where backups are stored.AwsBackupBackupPlanRuleDetails.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
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 theisEmpty()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
CopyActionobjects, 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
CopyActionobjects, 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 do not 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 do not 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()
- Specified by:
toBuilderin interfaceToCopyableBuilder<AwsBackupBackupPlanRuleDetails.Builder,AwsBackupBackupPlanRuleDetails>
-
builder
public static AwsBackupBackupPlanRuleDetails.Builder builder()
-
serializableBuilderClass
public static Class<? extends AwsBackupBackupPlanRuleDetails.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-