Backup (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.opsworkscm.model.Backup

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<Backup.Builder,Backup>

@Generated(value="software.amazon.awssdk:codegen")
public final class Backup
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Backup.Builder,Backup>

Describes a single backup.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Backup.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Backup.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`backupArn()` The ARN of the backup.
`String`	`backupId()` The generated ID of the backup.
`BackupType`	`backupType()` The backup type.
`String`	`backupTypeAsString()` The backup type.
`static Backup.Builder`	`builder()`
`Instant`	`createdAt()` The time stamp when the backup was created in the database.
`String`	`description()` A user-provided description for a manual backup.
`String`	`engine()` The engine type that is obtained from the server when the backup is created.
`String`	`engineModel()` The engine model that is obtained from the server when the backup is created.
`String`	`engineVersion()` The engine version that is obtained from the server when the backup is created.
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`instanceProfileArn()` The EC2 instance profile ARN that is obtained from the server when the backup is created.
`String`	`instanceType()` The instance type that is obtained from the server when the backup is created.
`String`	`keyPair()` The key pair that is obtained from the server when the backup is created.
`String`	`preferredBackupWindow()` The preferred backup period that is obtained from the server when the backup is created.
`String`	`preferredMaintenanceWindow()` The preferred maintenance period that is obtained from the server when the backup is created.
`Integer`	`s3DataSize()` This field is deprecated and is no longer used.
`String`	`s3DataUrl()` This field is deprecated and is no longer used.
`String`	`s3LogUrl()` The Amazon S3 URL of the backup's log file.
`List<SdkField<?>>`	`sdkFields()`
`List<String>`	`securityGroupIds()` The security group IDs that are obtained from the server when the backup is created.
`static Class<? extends Backup.Builder>`	`serializableBuilderClass()`
`String`	`serverName()` The name of the server from which the backup was made.
`String`	`serviceRoleArn()` The service role ARN that is obtained from the server when the backup is created.
`BackupStatus`	`status()` The status of a backup while in progress.
`String`	`statusAsString()` The status of a backup while in progress.
`String`	`statusDescription()` An informational message about backup status.
`List<String>`	`subnetIds()` The subnet IDs that are obtained from the server when the backup is created.
`Backup.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toolsVersion()` The version of AWS OpsWorks CM-specific tools that is obtained from the server when the backup is created.
`String`	`toString()`
`String`	`userArn()` The IAM user ARN of the requester for manual backups.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - backupArn
```
public String backupArn()
```
    The ARN of the backup.
    
    Returns:
    
    The ARN of the backup.
  - backupId
```
public String backupId()
```
    The generated ID of the backup. Example: myServerName-yyyyMMddHHmmssSSS
    
    Returns:
    
    The generated ID of the backup. Example: myServerName-yyyyMMddHHmmssSSS
  - backupType
```
public BackupType backupType()
```
    The backup type. Valid values are automated or manual.
    
    If the service returns an enum value that is not available in the current SDK version, backupType will return BackupType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from backupTypeAsString().
    
    Returns:
    
    The backup type. Valid values are automated or manual.
    
    See Also:
    
    BackupType
  - backupTypeAsString
```
public String backupTypeAsString()
```
    The backup type. Valid values are automated or manual.
    
    If the service returns an enum value that is not available in the current SDK version, backupType will return BackupType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from backupTypeAsString().
    
    Returns:
    
    The backup type. Valid values are automated or manual.
    
    See Also:
    
    BackupType
  - createdAt
```
public Instant createdAt()
```
    The time stamp when the backup was created in the database. Example: 2016-07-29T13:38:47.520Z
    
    Returns:
    
    The time stamp when the backup was created in the database. Example: 2016-07-29T13:38:47.520Z
  - description
```
public String description()
```
    A user-provided description for a manual backup. This field is empty for automated backups.
    
    Returns:
    
    A user-provided description for a manual backup. This field is empty for automated backups.
  - engine
```
public String engine()
```
    The engine type that is obtained from the server when the backup is created.
    
    Returns:
    
    The engine type that is obtained from the server when the backup is created.
  - engineModel
```
public String engineModel()
```
    The engine model that is obtained from the server when the backup is created.
    
    Returns:
    
    The engine model that is obtained from the server when the backup is created.
  - engineVersion
```
public String engineVersion()
```
    The engine version that is obtained from the server when the backup is created.
    
    Returns:
    
    The engine version that is obtained from the server when the backup is created.
  - instanceProfileArn
```
public String instanceProfileArn()
```
    The EC2 instance profile ARN that is obtained from the server when the backup is created. Because this value is stored, you are not required to provide the InstanceProfileArn again if you restore a backup.
    
    Returns:
    
    The EC2 instance profile ARN that is obtained from the server when the backup is created. Because this value is stored, you are not required to provide the InstanceProfileArn again if you restore a backup.
  - instanceType
```
public String instanceType()
```
    The instance type that is obtained from the server when the backup is created.
    
    Returns:
    
    The instance type that is obtained from the server when the backup is created.
  - keyPair
```
public String keyPair()
```
    The key pair that is obtained from the server when the backup is created.
    
    Returns:
    
    The key pair that is obtained from the server when the backup is created.
  - preferredBackupWindow
```
public String preferredBackupWindow()
```
    The preferred backup period that is obtained from the server when the backup is created.
    
    Returns:
    
    The preferred backup period that is obtained from the server when the backup is created.
  - preferredMaintenanceWindow
```
public String preferredMaintenanceWindow()
```
    The preferred maintenance period that is obtained from the server when the backup is created.
    
    Returns:
    
    The preferred maintenance period that is obtained from the server when the backup is created.
  - s3DataSize
```
public Integer s3DataSize()
```
    This field is deprecated and is no longer used.
    
    Returns:
    
    This field is deprecated and is no longer used.
  - s3DataUrl
```
public String s3DataUrl()
```
    This field is deprecated and is no longer used.
    
    Returns:
    
    This field is deprecated and is no longer used.
  - s3LogUrl
```
public String s3LogUrl()
```
    The Amazon S3 URL of the backup's log file.
    
    Returns:
    
    The Amazon S3 URL of the backup's log file.
  - securityGroupIds
```
public List<String> securityGroupIds()
```
    The security group IDs that are obtained from the server when the backup is created.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The security group IDs that are obtained from the server when the backup is created.
  - serverName
```
public String serverName()
```
    The name of the server from which the backup was made.
    
    Returns:
    
    The name of the server from which the backup was made.
  - serviceRoleArn
```
public String serviceRoleArn()
```
    The service role ARN that is obtained from the server when the backup is created.
    
    Returns:
    
    The service role ARN that is obtained from the server when the backup is created.
  - status
```
public BackupStatus status()
```
    The status of a backup while in progress.
    
    If the service returns an enum value that is not available in the current SDK version, status will return BackupStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The status of a backup while in progress.
    
    See Also:
    
    BackupStatus
  - statusAsString
```
public String statusAsString()
```
    The status of a backup while in progress.
    
    If the service returns an enum value that is not available in the current SDK version, status will return BackupStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The status of a backup while in progress.
    
    See Also:
    
    BackupStatus
  - statusDescription
```
public String statusDescription()
```
    An informational message about backup status.
    
    Returns:
    
    An informational message about backup status.
  - subnetIds
```
public List<String> subnetIds()
```
    The subnet IDs that are obtained from the server when the backup is created.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The subnet IDs that are obtained from the server when the backup is created.
  - toolsVersion
```
public String toolsVersion()
```
    The version of AWS OpsWorks CM-specific tools that is obtained from the server when the backup is created.
    
    Returns:
    
    The version of AWS OpsWorks CM-specific tools that is obtained from the server when the backup is created.
  - userArn
```
public String userArn()
```
    The IAM user ARN of the requester for manual backups. This field is empty for automated backups.
    
    Returns:
    
    The IAM user ARN of the requester for manual backups. This field is empty for automated backups.
  - toBuilder
```
public Backup.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<Backup.Builder,Backup>
    
    Returns:
    
    a builder for type T
  - builder
```
public static Backup.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Backup.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public 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.

Class Backup

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

backupArn

backupId

backupType

backupTypeAsString

createdAt

description

engine

engineModel

engineVersion

instanceProfileArn

instanceType

keyPair

preferredBackupWindow

preferredMaintenanceWindow

s3DataSize

s3DataUrl

s3LogUrl

securityGroupIds

serverName

serviceRoleArn

status

statusAsString

statusDescription

subnetIds

toolsVersion

userArn

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields