software.amazon.awssdk.services.opsworkscm.model

Interface Backup.Builder

All Superinterfaces:

CopyableBuilder<Backup.Builder,Backup>, SdkBuilder<Backup.Builder,Backup>

Enclosing class:

Backup

public static interface Backup.Builder
extends CopyableBuilder<Backup.Builder,Backup>

Method Summary

Modifier and Type	Method and Description
Backup.Builder	backupArn(String backupArn) The ARN of the backup.
Backup.Builder	backupId(String backupId) The generated ID of the backup.
Backup.Builder	backupType(BackupType backupType) The backup type.
Backup.Builder	backupType(String backupType) The backup type.
Backup.Builder	createdAt(Instant createdAt) The time stamp when the backup was created in the database.
Backup.Builder	description(String description) A user-provided description for a manual backup.
Backup.Builder	engine(String engine) The engine type that is obtained from the server when the backup is created.
Backup.Builder	engineModel(String engineModel) The engine model that is obtained from the server when the backup is created.
Backup.Builder	engineVersion(String engineVersion) The engine version that is obtained from the server when the backup is created.
Backup.Builder	instanceProfileArn(String instanceProfileArn) The EC2 instance profile ARN that is obtained from the server when the backup is created.
Backup.Builder	instanceType(String instanceType) The instance type that is obtained from the server when the backup is created.
Backup.Builder	keyPair(String keyPair) The key pair that is obtained from the server when the backup is created.
Backup.Builder	preferredBackupWindow(String preferredBackupWindow) The preferred backup period that is obtained from the server when the backup is created.
Backup.Builder	preferredMaintenanceWindow(String preferredMaintenanceWindow) The preferred maintenance period that is obtained from the server when the backup is created.
Backup.Builder	s3DataSize(Integer s3DataSize) This field is deprecated and is no longer used.
Backup.Builder	s3DataUrl(String s3DataUrl) This field is deprecated and is no longer used.
Backup.Builder	s3LogUrl(String s3LogUrl) The Amazon S3 URL of the backup's log file.
Backup.Builder	securityGroupIds(Collection<String> securityGroupIds) The security group IDs that are obtained from the server when the backup is created.
Backup.Builder	securityGroupIds(String... securityGroupIds) The security group IDs that are obtained from the server when the backup is created.
Backup.Builder	serverName(String serverName) The name of the server from which the backup was made.
Backup.Builder	serviceRoleArn(String serviceRoleArn) The service role ARN that is obtained from the server when the backup is created.
Backup.Builder	status(BackupStatus status) The status of a backup while in progress.
Backup.Builder	status(String status) The status of a backup while in progress.
Backup.Builder	statusDescription(String statusDescription) An informational message about backup status.
Backup.Builder	subnetIds(Collection<String> subnetIds) The subnet IDs that are obtained from the server when the backup is created.
Backup.Builder	subnetIds(String... subnetIds) The subnet IDs that are obtained from the server when the backup is created.
Backup.Builder	toolsVersion(String toolsVersion) The version of AWS OpsWorks CM-specific tools that is obtained from the server when the backup is created.
Backup.Builder	userArn(String userArn) The IAM user ARN of the requester for manual backups.

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

copy

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

applyMutation, build

Method Detail

backupArn

Backup.Builder backupArn(String backupArn)

The ARN of the backup.

Parameters:

backupArn - The ARN of the backup.

Returns:

Returns a reference to this object so that method calls can be chained together.

backupId

Backup.Builder backupId(String backupId)

The generated ID of the backup. Example: myServerName-yyyyMMddHHmmssSSS

Parameters:

backupId - The generated ID of the backup. Example: myServerName-yyyyMMddHHmmssSSS

Returns:

Returns a reference to this object so that method calls can be chained together.

backupType

Backup.Builder backupType(String backupType)

The backup type. Valid values are automated or manual.

Parameters:

backupType - The backup type. Valid values are automated or manual.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

BackupType, BackupType

backupType

Backup.Builder backupType(BackupType backupType)

The backup type. Valid values are automated or manual.

Parameters:

backupType - The backup type. Valid values are automated or manual.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

BackupType, BackupType

createdAt

Backup.Builder createdAt(Instant createdAt)

The time stamp when the backup was created in the database. Example: 2016-07-29T13:38:47.520Z

Parameters:

createdAt - The time stamp when the backup was created in the database. Example: 2016-07-29T13:38:47.520Z

Returns:

Returns a reference to this object so that method calls can be chained together.

description

Backup.Builder description(String description)

A user-provided description for a manual backup. This field is empty for automated backups.

Parameters:

description - A user-provided description for a manual backup. This field is empty for automated backups.

Returns:

Returns a reference to this object so that method calls can be chained together.

engine

Backup.Builder engine(String engine)

The engine type that is obtained from the server when the backup is created.

Parameters:

engine - The engine type that is obtained from the server when the backup is created.

Returns:

Returns a reference to this object so that method calls can be chained together.

engineModel

Backup.Builder engineModel(String engineModel)

The engine model that is obtained from the server when the backup is created.

Parameters:

engineModel - The engine model that is obtained from the server when the backup is created.

Returns:

Returns a reference to this object so that method calls can be chained together.

engineVersion

Backup.Builder engineVersion(String engineVersion)

The engine version that is obtained from the server when the backup is created.

Parameters:

engineVersion - The engine version that is obtained from the server when the backup is created.

Returns:

Returns a reference to this object so that method calls can be chained together.

instanceProfileArn

Backup.Builder instanceProfileArn(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

instanceType

Backup.Builder instanceType(String instanceType)

The instance type that is obtained from the server when the backup is created.

Parameters:

instanceType - The instance type that is obtained from the server when the backup is created.

Returns:

Returns a reference to this object so that method calls can be chained together.

keyPair

Backup.Builder keyPair(String keyPair)

The key pair that is obtained from the server when the backup is created.

Parameters:

keyPair - The key pair that is obtained from the server when the backup is created.

Returns:

Returns a reference to this object so that method calls can be chained together.

preferredBackupWindow

Backup.Builder preferredBackupWindow(String preferredBackupWindow)

The preferred backup period that is obtained from the server when the backup is created.

Parameters:

preferredBackupWindow - The preferred backup period that is obtained from the server when the backup is created.

Returns:

Returns a reference to this object so that method calls can be chained together.

preferredMaintenanceWindow

Backup.Builder preferredMaintenanceWindow(String preferredMaintenanceWindow)

The preferred maintenance period that is obtained from the server when the backup is created.

Parameters:

preferredMaintenanceWindow - The preferred maintenance period that is obtained from the server when the backup is created.

Returns:

Returns a reference to this object so that method calls can be chained together.

s3DataSize

Backup.Builder s3DataSize(Integer s3DataSize)

This field is deprecated and is no longer used.

Parameters:

s3DataSize - This field is deprecated and is no longer used.

Returns:

Returns a reference to this object so that method calls can be chained together.

s3DataUrl

Backup.Builder s3DataUrl(String s3DataUrl)

This field is deprecated and is no longer used.

Parameters:

s3DataUrl - This field is deprecated and is no longer used.

Returns:

Returns a reference to this object so that method calls can be chained together.

s3LogUrl

Backup.Builder s3LogUrl(String s3LogUrl)

The Amazon S3 URL of the backup's log file.

Parameters:

s3LogUrl - The Amazon S3 URL of the backup's log file.

Returns:

Returns a reference to this object so that method calls can be chained together.

securityGroupIds

Backup.Builder securityGroupIds(Collection<String> securityGroupIds)

The security group IDs that are obtained from the server when the backup is created.

Parameters:

securityGroupIds - The security group IDs that are obtained from the server when the backup is created.

Returns:

Returns a reference to this object so that method calls can be chained together.

securityGroupIds

Backup.Builder securityGroupIds(String... securityGroupIds)

The security group IDs that are obtained from the server when the backup is created.

Parameters:

securityGroupIds - The security group IDs that are obtained from the server when the backup is created.

Returns:

Returns a reference to this object so that method calls can be chained together.

serverName

Backup.Builder serverName(String serverName)

The name of the server from which the backup was made.

Parameters:

serverName - The name of the server from which the backup was made.

Returns:

Returns a reference to this object so that method calls can be chained together.

serviceRoleArn

Backup.Builder serviceRoleArn(String serviceRoleArn)

The service role ARN that is obtained from the server when the backup is created.

Parameters:

serviceRoleArn - The service role ARN that is obtained from the server when the backup is created.

Returns:

Returns a reference to this object so that method calls can be chained together.

status

Backup.Builder status(String status)

The status of a backup while in progress.

Parameters:

status - The status of a backup while in progress.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

BackupStatus, BackupStatus

status

Backup.Builder status(BackupStatus status)

The status of a backup while in progress.

Parameters:

status - The status of a backup while in progress.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

BackupStatus, BackupStatus

statusDescription

Backup.Builder statusDescription(String statusDescription)

An informational message about backup status.

Parameters:

statusDescription - An informational message about backup status.

Returns:

Returns a reference to this object so that method calls can be chained together.

subnetIds

Backup.Builder subnetIds(Collection<String> subnetIds)

The subnet IDs that are obtained from the server when the backup is created.

Parameters:

subnetIds - The subnet IDs that are obtained from the server when the backup is created.

Returns:

Returns a reference to this object so that method calls can be chained together.

subnetIds

Backup.Builder subnetIds(String... subnetIds)

The subnet IDs that are obtained from the server when the backup is created.

Parameters:

subnetIds - The subnet IDs that are obtained from the server when the backup is created.

Returns:

Returns a reference to this object so that method calls can be chained together.

toolsVersion

Backup.Builder toolsVersion(String toolsVersion)

The version of AWS OpsWorks CM-specific tools that is obtained from the server when the backup is created.

Parameters:

toolsVersion - The version of AWS OpsWorks CM-specific tools that is obtained from the server when the backup is created.

Returns:

Returns a reference to this object so that method calls can be chained together.

userArn

Backup.Builder userArn(String userArn)

The IAM user ARN of the requester for manual backups. This field is empty for automated backups.

Parameters:

userArn - The IAM user ARN of the requester for manual backups. This field is empty for automated backups.

Returns:

Returns a reference to this object so that method calls can be chained together.