Class CreateSnapshotRequest

    • Method Detail

      • description

        public final String description()

        A description for the snapshot.

        Returns:
        A description for the snapshot.
      • outpostArn

        public final String outpostArn()

        The Amazon Resource Name (ARN) of the Outpost on which to create a local snapshot.

        • To create a snapshot of a volume in a Region, omit this parameter. The snapshot is created in the same Region as the volume.

        • To create a snapshot of a volume on an Outpost and store the snapshot in the Region, omit this parameter. The snapshot is created in the Region for the Outpost.

        • To create a snapshot of a volume on an Outpost and store the snapshot on an Outpost, specify the ARN of the destination Outpost. The snapshot must be created on the same Outpost as the volume.

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

        Returns:
        The Amazon Resource Name (ARN) of the Outpost on which to create a local snapshot.

        • To create a snapshot of a volume in a Region, omit this parameter. The snapshot is created in the same Region as the volume.

        • To create a snapshot of a volume on an Outpost and store the snapshot in the Region, omit this parameter. The snapshot is created in the Region for the Outpost.

        • To create a snapshot of a volume on an Outpost and store the snapshot on an Outpost, specify the ARN of the destination Outpost. The snapshot must be created on the same Outpost as the volume.

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

      • volumeId

        public final String volumeId()

        The ID of the Amazon EBS volume.

        Returns:
        The ID of the Amazon EBS volume.
      • 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()

        The tags to apply to the snapshot during creation.

        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:
        The tags to apply to the snapshot during creation.
      • 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.
      • 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