Package software.amazon.awssdk.services.ec2.model

Interface Snapshot.Builder

    • Method Detail

      • dataEncryptionKeyId

        Snapshot.Builder dataEncryptionKeyId​(String dataEncryptionKeyId)

        The data encryption key identifier for the snapshot. This value is a unique identifier that corresponds to the data encryption key that was used to encrypt the original volume or snapshot copy. Because data encryption keys are inherited by volumes created from snapshots, and vice versa, if snapshots share the same data encryption key identifier, then they belong to the same volume/snapshot lineage. This parameter is only returned by DescribeSnapshots.

        Parameters:
        dataEncryptionKeyId - The data encryption key identifier for the snapshot. This value is a unique identifier that corresponds to the data encryption key that was used to encrypt the original volume or snapshot copy. Because data encryption keys are inherited by volumes created from snapshots, and vice versa, if snapshots share the same data encryption key identifier, then they belong to the same volume/snapshot lineage. This parameter is only returned by DescribeSnapshots.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • description

        Snapshot.Builder description​(String description)

        The description for the snapshot.

        Parameters:
        description - The description for the snapshot.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • encrypted

        Snapshot.Builder encrypted​(Boolean encrypted)

        Indicates whether the snapshot is encrypted.

        Parameters:
        encrypted - Indicates whether the snapshot is encrypted.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • kmsKeyId

        Snapshot.Builder kmsKeyId​(String kmsKeyId)

        The Amazon Resource Name (ARN) of the Key Management Service (KMS) KMS key that was used to protect the volume encryption key for the parent volume.

        Parameters:
        kmsKeyId - The Amazon Resource Name (ARN) of the Key Management Service (KMS) KMS key that was used to protect the volume encryption key for the parent volume.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • ownerId

        Snapshot.Builder ownerId​(String ownerId)

        The ID of the Amazon Web Services account that owns the EBS snapshot.

        Parameters:
        ownerId - The ID of the Amazon Web Services account that owns the EBS snapshot.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • progress

        Snapshot.Builder progress​(String progress)

        The progress of the snapshot, as a percentage.

        Parameters:
        progress - The progress of the snapshot, as a percentage.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • snapshotId

        Snapshot.Builder snapshotId​(String snapshotId)

        The ID of the snapshot. Each snapshot receives a unique identifier when it is created.

        Parameters:
        snapshotId - The ID of the snapshot. Each snapshot receives a unique identifier when it is created.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • startTime

        Snapshot.Builder startTime​(Instant startTime)

        The time stamp when the snapshot was initiated.

        Parameters:
        startTime - The time stamp when the snapshot was initiated.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • stateMessage

        Snapshot.Builder stateMessage​(String stateMessage)

        Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper Key Management Service (KMS) permissions are not obtained) this field displays error state details to help you diagnose why the error occurred. This parameter is only returned by DescribeSnapshots.

        Parameters:
        stateMessage - Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper Key Management Service (KMS) permissions are not obtained) this field displays error state details to help you diagnose why the error occurred. This parameter is only returned by DescribeSnapshots.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • volumeId

        Snapshot.Builder volumeId​(String volumeId)

        The ID of the volume that was used to create the snapshot. Snapshots created by the CopySnapshot action have an arbitrary volume ID that should not be used for any purpose.

        Parameters:
        volumeId - The ID of the volume that was used to create the snapshot. Snapshots created by the CopySnapshot action have an arbitrary volume ID that should not be used for any purpose.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • volumeSize

        Snapshot.Builder volumeSize​(Integer volumeSize)

        The size of the volume, in GiB.

        Parameters:
        volumeSize - The size of the volume, in GiB.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • ownerAlias

        Snapshot.Builder ownerAlias​(String ownerAlias)

        The Amazon Web Services owner alias, from an Amazon-maintained list (amazon). This is not the user-configured Amazon Web Services account alias set using the IAM console.

        Parameters:
        ownerAlias - The Amazon Web Services owner alias, from an Amazon-maintained list (amazon). This is not the user-configured Amazon Web Services account alias set using the IAM console.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        Snapshot.Builder tags​(Collection<Tag> tags)

        Any tags assigned to the snapshot.

        Parameters:
        tags - Any tags assigned to the snapshot.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        Snapshot.Builder tags​(Tag... tags)

        Any tags assigned to the snapshot.

        Parameters:
        tags - Any tags assigned to the snapshot.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        Snapshot.Builder tags​(Consumer<Tag.Builder>... tags)

        Any tags assigned to the snapshot.

        This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

        Parameters:
        tags - a consumer that will call methods on Tag.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #tags(java.util.Collection)

      • storageTier

        Snapshot.Builder storageTier​(String storageTier)

        The storage tier in which the snapshot is stored. standard indicates that the snapshot is stored in the standard snapshot storage tier and that it is ready for use. archive indicates that the snapshot is currently archived and that it must be restored before it can be used.

        Parameters:
        storageTier - The storage tier in which the snapshot is stored. standard indicates that the snapshot is stored in the standard snapshot storage tier and that it is ready for use. archive indicates that the snapshot is currently archived and that it must be restored before it can be used.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        StorageTier, StorageTier

      • storageTier

        Snapshot.Builder storageTier​(StorageTier storageTier)

        The storage tier in which the snapshot is stored. standard indicates that the snapshot is stored in the standard snapshot storage tier and that it is ready for use. archive indicates that the snapshot is currently archived and that it must be restored before it can be used.

        Parameters:
        storageTier - The storage tier in which the snapshot is stored. standard indicates that the snapshot is stored in the standard snapshot storage tier and that it is ready for use. archive indicates that the snapshot is currently archived and that it must be restored before it can be used.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        StorageTier, StorageTier

      • restoreExpiryTime

        Snapshot.Builder restoreExpiryTime​(Instant restoreExpiryTime)

        Only for archived snapshots that are temporarily restored. Indicates the date and time when a temporarily restored snapshot will be automatically re-archived.

        Parameters:
        restoreExpiryTime - Only for archived snapshots that are temporarily restored. Indicates the date and time when a temporarily restored snapshot will be automatically re-archived.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sseType

        Snapshot.Builder sseType​(String sseType)

        Reserved for future use.

        Parameters:
        sseType - Reserved for future use.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        SSEType, SSEType

      • sseType

        Snapshot.Builder sseType​(SSEType sseType)

        Reserved for future use.

        Parameters:
        sseType - Reserved for future use.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        SSEType, SSEType