Class: AWSCDK::S3::CfnAccessGrant::GranteeProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::S3::CfnAccessGrant::GranteeProperty

Defined in:

s3/cfn_access_grant.rb

Overview

The user, group, or role to which you are granting access.

You can grant access to an IAM user or role. If you have added your corporate directory to AWS IAM Identity Center and associated your Identity Center instance with your S3 Access Grants instance, the grantee can also be a corporate directory user or group.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-accessgrant-grantee.html

Instance Attribute Summary

• #grantee_identifier ⇒ String readonly

  The unique identifier of the Grantee .

• #grantee_type ⇒ String readonly

  The type of the grantee to which access has been granted.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(grantee_identifier:, grantee_type:) ⇒ GranteeProperty constructor

  A new instance of GranteeProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(grantee_identifier:, grantee_type:) ⇒ GranteeProperty

Returns a new instance of GranteeProperty.

Parameters:

• grantee_identifier (String) —

  The unique identifier of the Grantee .

• grantee_type (String) —

  The type of the grantee to which access has been granted. It can be one of the following values:.

# File 's3/cfn_access_grant.rb', line 668

def initialize(grantee_identifier:, grantee_type:)
  @grantee_identifier = grantee_identifier
  Jsii::Type.check_type(@grantee_identifier, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "granteeIdentifier")
  @grantee_type = grantee_type
  Jsii::Type.check_type(@grantee_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "granteeType")
end

Instance Attribute Details

#grantee_identifier ⇒ String (readonly)

The unique identifier of the Grantee .

If the grantee type is IAM , the identifier is the IAM Amazon Resource Name (ARN) of the user or role. If the grantee type is a directory user or group, the identifier is 128-bit universally unique identifier (UUID) in the format a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 . You can obtain this UUID from your AWS IAM Identity Center instance.

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-accessgrant-grantee.html#cfn-s3-accessgrant-grantee-granteeidentifier

# File 's3/cfn_access_grant.rb', line 681

def grantee_identifier
  @grantee_identifier
end

#grantee_type ⇒ String (readonly)

The type of the grantee to which access has been granted. It can be one of the following values:.

• IAM - An IAM user or role.
• DIRECTORY_USER - Your corporate directory user. You can use this option if you have added your corporate identity directory to IAM Identity Center and associated the IAM Identity Center instance with your S3 Access Grants instance.
• DIRECTORY_GROUP - Your corporate directory group. You can use this option if you have added your corporate identity directory to IAM Identity Center and associated the IAM Identity Center instance with your S3 Access Grants instance.

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-accessgrant-grantee.html#cfn-s3-accessgrant-grantee-granteetype

# File 's3/cfn_access_grant.rb', line 690

def grantee_type
  @grantee_type
end

Class Method Details

.jsii_properties ⇒ Object

# File 's3/cfn_access_grant.rb', line 692

def self.jsii_properties
  {
    :grantee_identifier => "granteeIdentifier",
    :grantee_type => "granteeType",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 's3/cfn_access_grant.rb', line 699

def to_jsii
  result = {}
  result.merge!({
    "granteeIdentifier" => @grantee_identifier,
    "granteeType" => @grantee_type,
  })
  result.compact
end