Package software.amazon.awssdk.services.kms.model

Interface GrantListEntry.Builder

All Superinterfaces:
Buildable, CopyableBuilder<GrantListEntry.Builder,GrantListEntry>, SdkBuilder<GrantListEntry.Builder,GrantListEntry>, SdkPojo
Enclosing class:
GrantListEntry
@Mutable @NotThreadSafe public static interface GrantListEntry.Builder extends SdkPojo, CopyableBuilder<GrantListEntry.Builder,GrantListEntry>

  • Method Details

    • keyId

      GrantListEntry.Builder keyId(String keyId)

      The unique identifier for the KMS key to which the grant applies.

      Parameters:
      keyId - The unique identifier for the KMS key to which the grant applies.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • grantId

      GrantListEntry.Builder grantId(String grantId)

      The unique identifier for the grant.

      Parameters:
      grantId - The unique identifier for the grant.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      GrantListEntry.Builder name(String name)

      The friendly name that identifies the grant. If a name was provided in the CreateGrant request, that name is returned. Otherwise this value is null.

      Parameters:
      name - The friendly name that identifies the grant. If a name was provided in the CreateGrant request, that name is returned. Otherwise this value is null.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • creationDate

      GrantListEntry.Builder creationDate(Instant creationDate)

      The date and time when the grant was created.

      Parameters:
      creationDate - The date and time when the grant was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • granteePrincipal

      GrantListEntry.Builder granteePrincipal(String granteePrincipal)

      The identity that gets the permissions in the grant.

      When a grant is created with the GranteePrincipal field, the ListGrants response usually contains the user or role designated as the grantee principal in the grant. However, if the grantee principal is an Amazon Web Services service, the GranteePrincipal field contains an Amazon Web Services service principal, which might correspond to several different grantee principals, such as an IAM user, IAM role, or Amazon Web Services account.

      Parameters:
      granteePrincipal - The identity that gets the permissions in the grant.

      When a grant is created with the GranteePrincipal field, the ListGrants response usually contains the user or role designated as the grantee principal in the grant. However, if the grantee principal is an Amazon Web Services service, the GranteePrincipal field contains an Amazon Web Services service principal, which might correspond to several different grantee principals, such as an IAM user, IAM role, or Amazon Web Services account.

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

    • retiringPrincipal

      GrantListEntry.Builder retiringPrincipal(String retiringPrincipal)

      The principal that can retire the grant.

      Parameters:
      retiringPrincipal - The principal that can retire the grant.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • issuingAccount

      GrantListEntry.Builder issuingAccount(String issuingAccount)

      The Amazon Web Services account under which the grant was issued.

      Parameters:
      issuingAccount - The Amazon Web Services account under which the grant was issued.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • operationsWithStrings

      GrantListEntry.Builder operationsWithStrings(Collection<String> operations)

      The list of operations permitted by the grant.

      Parameters:
      operations - The list of operations permitted by the grant.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • operationsWithStrings

      GrantListEntry.Builder operationsWithStrings(String... operations)

      The list of operations permitted by the grant.

      Parameters:
      operations - The list of operations permitted by the grant.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • operations

      GrantListEntry.Builder operations(Collection<GrantOperation> operations)

      The list of operations permitted by the grant.

      Parameters:
      operations - The list of operations permitted by the grant.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • operations

      GrantListEntry.Builder operations(GrantOperation... operations)

      The list of operations permitted by the grant.

      Parameters:
      operations - The list of operations permitted by the grant.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • constraints

      GrantListEntry.Builder constraints(GrantConstraints constraints)

      The constraints on the grant, such as encryption context pairs or a SourceArn, that restrict the subsequent operations the grant allows.

      Parameters:
      constraints - The constraints on the grant, such as encryption context pairs or a SourceArn, that restrict the subsequent operations the grant allows.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • constraints

      default GrantListEntry.Builder constraints(Consumer<GrantConstraints.Builder> constraints)

      The constraints on the grant, such as encryption context pairs or a SourceArn, that restrict the subsequent operations the grant allows.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to constraints(GrantConstraints).

      Parameters:
      constraints - a consumer that will call methods on GrantConstraints.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • granteeServicePrincipal

      GrantListEntry.Builder granteeServicePrincipal(String granteeServicePrincipal)

      The Amazon Web Services service principal that gets the permissions in the grant.

      Parameters:
      granteeServicePrincipal - The Amazon Web Services service principal that gets the permissions in the grant.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • retiringServicePrincipal

      GrantListEntry.Builder retiringServicePrincipal(String retiringServicePrincipal)

      The Amazon Web Services service principal that can retire the grant.

      Parameters:
      retiringServicePrincipal - The Amazon Web Services service principal that can retire the grant.
      Returns:
      Returns a reference to this object so that method calls can be chained together.