Class CreateSnapshotsRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.ec2.model.Ec2Request
software.amazon.awssdk.services.ec2.model.CreateSnapshotsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateSnapshotsRequest.Builder,CreateSnapshotsRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateSnapshotsRequest extends Ec2Request implements ToCopyableBuilder<CreateSnapshotsRequest.Builder,CreateSnapshotsRequest>

  • Method Details

    • description

      public final String description()

      A description propagated to every snapshot specified by the instance.

      Returns:
      A description propagated to every snapshot specified by the instance.

    • instanceSpecification

      public final InstanceSpecification instanceSpecification()

      The instance to specify which volumes should be included in the snapshots.

      Returns:
      The instance to specify which volumes should be included in the snapshots.

    • outpostArn

      public final String outpostArn()

      Only supported for instances on Outposts. If the source instance is not on an Outpost, omit this parameter.

      • To create the snapshots on the same Outpost as the source instance, specify the ARN of that Outpost. The snapshots must be created on the same Outpost as the instance.

      • To create the snapshots in the parent Region of the Outpost, omit this parameter.

      For more information, see Create local snapshots from volumes on an Outpost in the Amazon EBS User Guide.

      Returns:

      Only supported for instances on Outposts. If the source instance is not on an Outpost, omit this parameter.

      • To create the snapshots on the same Outpost as the source instance, specify the ARN of that Outpost. The snapshots must be created on the same Outpost as the instance.

      • To create the snapshots in the parent Region of the Outpost, omit this parameter.

      For more information, see Create local snapshots from volumes on an Outpost in the Amazon EBS User Guide.

    • hasTagSpecifications

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

    • tagSpecifications

      public final List<TagSpecification> tagSpecifications()

      Tags to apply to every snapshot specified by the instance.

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

      Returns:
      Tags to apply to every snapshot specified by the instance.

    • dryRun

      public final Boolean dryRun()

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

      Returns:
      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

    • copyTagsFromSource

      public final CopyTagsFromSource copyTagsFromSource()

      Copies the tags from the specified volume to corresponding snapshot.

      If the service returns an enum value that is not available in the current SDK version, copyTagsFromSource will return CopyTagsFromSource.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from copyTagsFromSourceAsString().

      Returns:
      Copies the tags from the specified volume to corresponding snapshot.
      See Also:

    • copyTagsFromSourceAsString

      public final String copyTagsFromSourceAsString()

      Copies the tags from the specified volume to corresponding snapshot.

      If the service returns an enum value that is not available in the current SDK version, copyTagsFromSource will return CopyTagsFromSource.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from copyTagsFromSourceAsString().

      Returns:
      Copies the tags from the specified volume to corresponding snapshot.
      See Also:

    • location

      public final SnapshotLocationEnum location()

      Only supported for instances in Local Zones. If the source instance is not in a Local Zone, omit this parameter.

      • To create local snapshots in the same Local Zone as the source instance, specify local.

      • To create regional snapshots in the parent Region of the Local Zone, specify regional or omit this parameter.

      Default value: regional

      If the service returns an enum value that is not available in the current SDK version, location will return SnapshotLocationEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from locationAsString().

      Returns:

      Only supported for instances in Local Zones. If the source instance is not in a Local Zone, omit this parameter.

      • To create local snapshots in the same Local Zone as the source instance, specify local.

      • To create regional snapshots in the parent Region of the Local Zone, specify regional or omit this parameter.

      Default value: regional

      See Also:

    • locationAsString

      public final String locationAsString()

      Only supported for instances in Local Zones. If the source instance is not in a Local Zone, omit this parameter.

      • To create local snapshots in the same Local Zone as the source instance, specify local.

      • To create regional snapshots in the parent Region of the Local Zone, specify regional or omit this parameter.

      Default value: regional

      If the service returns an enum value that is not available in the current SDK version, location will return SnapshotLocationEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from locationAsString().

      Returns:

      Only supported for instances in Local Zones. If the source instance is not in a Local Zone, omit this parameter.

      • To create local snapshots in the same Local Zone as the source instance, specify local.

      • To create regional snapshots in the parent Region of the Local Zone, specify regional or omit this parameter.

      Default value: regional

      See Also:

    • toBuilder

      public CreateSnapshotsRequest.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<CreateSnapshotsRequest.Builder,CreateSnapshotsRequest>
      Specified by:
      toBuilder in class Ec2Request
      Returns:
      a builder for type T

    • builder

      public static CreateSnapshotsRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateSnapshotsRequest.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)
      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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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