Struct rusoto_kms::CreateGrantRequest

pub struct CreateGrantRequest {
    pub constraints: Option<GrantConstraints>,
    pub grant_tokens: Option<Vec<String>>,
    pub grantee_principal: String,
    pub key_id: String,
    pub name: Option<String>,
    pub operations: Option<Vec<String>>,
    pub retiring_principal: Option<String>,
}

Fields

constraints: Option<GrantConstraints>

A structure that you can use to allow certain operations in the grant only when the desired encryption context is present. For more information about encryption context, see Encryption Context in the AWS Key Management Service Developer Guide.

grant_tokens: Option<Vec<String>>

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

grantee_principal: String

The principal that is given permission to perform the operations that the grant permits.

To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, IAM roles, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.

key_id: String

The unique identifier for the customer master key (CMK) that the grant applies to.

To specify this value, use the globally unique key ID or the Amazon Resource Name (ARN) of the key. Examples:

• Globally unique key ID: 12345678-1234-1234-1234-123456789012

• Key ARN: arn:aws:kms:us-west-2:123456789012:key/12345678-1234-1234-1234-123456789012

name: Option<String>

A friendly name for identifying the grant. Use this value to prevent unintended creation of duplicate grants when retrying this request.

When this value is absent, all CreateGrant requests result in a new grant with a unique GrantId even if all the supplied parameters are identical. This can result in unintended duplicates when you retry the CreateGrant request.

When this value is present, you can retry a CreateGrant request with identical parameters; if the grant already exists, the original GrantId is returned without creating a new grant. Note that the returned grant token is unique with every CreateGrant request, even when a duplicate GrantId is returned. All grant tokens obtained in this way can be used interchangeably.

operations: Option<Vec<String>>

A list of operations that the grant permits.

retiring_principal: Option<String>

The principal that is given permission to retire the grant by using RetireGrant operation.

To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.

Trait Implementations

impl Default for CreateGrantRequest

fn default() -> CreateGrantRequest

Returns the "default value" for a type.

impl Debug for CreateGrantRequest

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Clone for CreateGrantRequest

fn clone(&self) -> CreateGrantRequest

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.