java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.ebs.model.EbsRequest
    - - software.amazon.awssdk.services.ebs.model.StartSnapshotRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<StartSnapshotRequest.Builder,StartSnapshotRequest>

@Generated("software.amazon.awssdk:codegen")
public final class StartSnapshotRequest
extends EbsRequest
implements ToCopyableBuilder<StartSnapshotRequest.Builder,StartSnapshotRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface StartSnapshotRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static StartSnapshotRequest.Builder`	`builder()`
`String`	`clientToken()`	A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
`String`	`description()`	A description for the snapshot.
`Boolean`	`encrypted()`	Indicates whether to encrypt the snapshot.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTags()`	For responses, this returns true if the service returned a value for the Tags property.
`String`	`kmsKeyArn()`	The Amazon Resource Name (ARN) of the Key Management Service (KMS) key to be used to encrypt the snapshot.
`String`	`parentSnapshotId()`	The ID of the parent snapshot.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends StartSnapshotRequest.Builder>`	`serializableBuilderClass()`
`List<Tag>`	`tags()`	The tags to apply to the snapshot.
`Integer`	`timeout()`	The amount of time (in minutes) after which the snapshot is automatically cancelled if:
`StartSnapshotRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`Long`	`volumeSize()`	The size of the volume, in GiB.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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
  - volumeSize
```
public final Long volumeSize()
```
    The size of the volume, in GiB. The maximum size is 65536 GiB (64 TiB).
    
    Returns:
    
    The size of the volume, in GiB. The maximum size is 65536 GiB (64 TiB).
  - parentSnapshotId
```
public final String parentSnapshotId()
```
    The ID of the parent snapshot. If there is no parent snapshot, or if you are creating the first snapshot for an on-premises volume, omit this parameter.
    
    You can't specify ParentSnapshotId and Encrypted in the same request. If you specify both parameters, the request fails with ValidationException.
    
    The encryption status of the snapshot depends on the values that you specify for Encrypted, KmsKeyArn, and ParentSnapshotId, and whether your Amazon Web Services account is enabled for encryption by default. For more information, see Using encryption in the Amazon Elastic Compute Cloud User Guide.
    
    If you specify an encrypted parent snapshot, you must have permission to use the KMS key that was used to encrypt the parent snapshot. For more information, see Permissions to use Key Management Service keys in the Amazon Elastic Compute Cloud User Guide.
    
    Returns:
    
    The ID of the parent snapshot. If there is no parent snapshot, or if you are creating the first snapshot for an on-premises volume, omit this parameter.
    
    You can't specify ParentSnapshotId and Encrypted in the same request. If you specify both parameters, the request fails with ValidationException.
    
    The encryption status of the snapshot depends on the values that you specify for Encrypted, KmsKeyArn, and ParentSnapshotId, and whether your Amazon Web Services account is enabled for encryption by default. For more information, see Using encryption in the Amazon Elastic Compute Cloud User Guide.
    
    If you specify an encrypted parent snapshot, you must have permission to use the KMS key that was used to encrypt the parent snapshot. For more information, see Permissions to use Key Management Service keys in the Amazon Elastic Compute Cloud User Guide.
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags 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.
  - tags
```
public final List<Tag> tags()
```
    The tags to apply to the snapshot.
    
    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 hasTags() method.
    
    Returns:
    
    The tags to apply to the snapshot.
  - description
```
public final String description()
```
    A description for the snapshot.
    
    Returns:
    
    A description for the snapshot.
  - clientToken
```
public final String clientToken()
```
    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully. The subsequent retries with the same client token return the result from the original successful request and they have no additional effect.
    
    If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.
    
    For more information, see Idempotency for StartSnapshot API in the Amazon Elastic Compute Cloud User Guide.
    
    Returns:
    
    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully. The subsequent retries with the same client token return the result from the original successful request and they have no additional effect.
    
    If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.
    
    For more information, see Idempotency for StartSnapshot API in the Amazon Elastic Compute Cloud User Guide.
  - encrypted
```
public final Boolean encrypted()
```
    Indicates whether to encrypt the snapshot.
    
    You can't specify Encrypted and ParentSnapshotId in the same request. If you specify both parameters, the request fails with ValidationException.
    
    The encryption status of the snapshot depends on the values that you specify for Encrypted, KmsKeyArn, and ParentSnapshotId, and whether your Amazon Web Services account is enabled for encryption by default. For more information, see Using encryption in the Amazon Elastic Compute Cloud User Guide.
    
    To create an encrypted snapshot, you must have permission to use the KMS key. For more information, see Permissions to use Key Management Service keys in the Amazon Elastic Compute Cloud User Guide.
    
    Returns:
    
    Indicates whether to encrypt the snapshot.
    
    You can't specify Encrypted and ParentSnapshotId in the same request. If you specify both parameters, the request fails with ValidationException.
    
    The encryption status of the snapshot depends on the values that you specify for Encrypted, KmsKeyArn, and ParentSnapshotId, and whether your Amazon Web Services account is enabled for encryption by default. For more information, see Using encryption in the Amazon Elastic Compute Cloud User Guide.
    
    To create an encrypted snapshot, you must have permission to use the KMS key. For more information, see Permissions to use Key Management Service keys in the Amazon Elastic Compute Cloud User Guide.
  - kmsKeyArn
```
public final String kmsKeyArn()
```
    The Amazon Resource Name (ARN) of the Key Management Service (KMS) key to be used to encrypt the snapshot.
    
    The encryption status of the snapshot depends on the values that you specify for Encrypted, KmsKeyArn, and ParentSnapshotId, and whether your Amazon Web Services account is enabled for encryption by default. For more information, see Using encryption in the Amazon Elastic Compute Cloud User Guide.
    
    To create an encrypted snapshot, you must have permission to use the KMS key. For more information, see Permissions to use Key Management Service keys in the Amazon Elastic Compute Cloud User Guide.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the Key Management Service (KMS) key to be used to encrypt the snapshot.
    
    The encryption status of the snapshot depends on the values that you specify for Encrypted, KmsKeyArn, and ParentSnapshotId, and whether your Amazon Web Services account is enabled for encryption by default. For more information, see Using encryption in the Amazon Elastic Compute Cloud User Guide.
    
    To create an encrypted snapshot, you must have permission to use the KMS key. For more information, see Permissions to use Key Management Service keys in the Amazon Elastic Compute Cloud User Guide.
  - timeout
```
public final Integer timeout()
```
    The amount of time (in minutes) after which the snapshot is automatically cancelled if:
    
    No blocks are written to the snapshot.
    
    The snapshot is not completed after writing the last block of data.
    
    If no value is specified, the timeout defaults to 60 minutes.
    Returns:
    
    The amount of time (in minutes) after which the snapshot is automatically cancelled if:
    
    No blocks are written to the snapshot.
    
    The snapshot is not completed after writing the last block of data.
    
    If no value is specified, the timeout defaults to 60 minutes.
  - toBuilder
```
public StartSnapshotRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<StartSnapshotRequest.Builder,StartSnapshotRequest>
    
    Specified by:
    
    toBuilder in class EbsRequest
  - builder
```
public static StartSnapshotRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends StartSnapshotRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class StartSnapshotRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

volumeSize

parentSnapshotId

hasTags

tags

description

clientToken

encrypted

kmsKeyArn

timeout

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields