Class: Aws::S3Control::Types::CreateAccessGrantRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#access_grants_location_configuration ⇒ Types::AccessGrantsLocationConfiguration

The configuration options of the grant location. The grant location is the S3 path to the data to which you are granting access. It contains the S3SubPrefix field. The grant scope is the result of appending the subprefix to the location scope of the registered location.

Returns:



612
613
614
615
616
617
618
619
620
621
622
623
 
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 612

class CreateAccessGrantRequest < Struct.new(
  :account_id,
  :access_grants_location_id,
  :access_grants_location_configuration,
  :grantee,
  :permission,
  :application_arn,
  :s3_prefix_type,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#access_grants_location_id ⇒ String

The ID of the registered location to which you are granting access. S3 Access Grants assigns this ID when you register the location. S3 Access Grants assigns the ID default to the default location s3:// and assigns an auto-generated ID to other locations that you register.

If you are passing the default location, you cannot create an access grant for the entire default location. You must also specify a bucket or a bucket and prefix in the Subprefix field.

Returns:

  • (String) 


612
613
614
615
616
617
618
619
620
621
622
623
 
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 612

class CreateAccessGrantRequest < Struct.new(
  :account_id,
  :access_grants_location_id,
  :access_grants_location_configuration,
  :grantee,
  :permission,
  :application_arn,
  :s3_prefix_type,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#account_id ⇒ String

The ID of the Amazon Web Services account that is making this request.

Returns:

  • (String) 


612
613
614
615
616
617
618
619
620
621
622
623
 
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 612

class CreateAccessGrantRequest < Struct.new(
  :account_id,
  :access_grants_location_id,
  :access_grants_location_configuration,
  :grantee,
  :permission,
  :application_arn,
  :s3_prefix_type,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#application_arn ⇒ String

The Amazon Resource Name (ARN) of an Amazon Web Services IAM Identity Center application associated with your Identity Center instance. If an application ARN is included in the request to create an access grant, the grantee can only access the S3 data through this application.

Returns:

  • (String) 


612
613
614
615
616
617
618
619
620
621
622
623
 
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 612

class CreateAccessGrantRequest < Struct.new(
  :account_id,
  :access_grants_location_id,
  :access_grants_location_configuration,
  :grantee,
  :permission,
  :application_arn,
  :s3_prefix_type,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#grantee ⇒ Types::Grantee

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 Amazon Web Services 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.

Returns:



612
613
614
615
616
617
618
619
620
621
622
623
 
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 612

class CreateAccessGrantRequest < Struct.new(
  :account_id,
  :access_grants_location_id,
  :access_grants_location_configuration,
  :grantee,
  :permission,
  :application_arn,
  :s3_prefix_type,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#permission ⇒ String

The type of access that you are granting to your S3 data, which can be set to one of the following values:

  • READ – Grant read-only access to the S3 data.

  • WRITE – Grant write-only access to the S3 data.

  • READWRITE – Grant both read and write access to the S3 data.

Returns:

  • (String) 


612
613
614
615
616
617
618
619
620
621
622
623
 
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 612

class CreateAccessGrantRequest < Struct.new(
  :account_id,
  :access_grants_location_id,
  :access_grants_location_configuration,
  :grantee,
  :permission,
  :application_arn,
  :s3_prefix_type,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#s3_prefix_type ⇒ String

The type of S3SubPrefix. The only possible value is Object. Pass this value if the access grant scope is an object. Do not pass this value if the access grant scope is a bucket or a bucket and a prefix.

Returns:

  • (String) 


612
613
614
615
616
617
618
619
620
621
622
623
 
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 612

class CreateAccessGrantRequest < Struct.new(
  :account_id,
  :access_grants_location_id,
  :access_grants_location_configuration,
  :grantee,
  :permission,
  :application_arn,
  :s3_prefix_type,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

The Amazon Web Services resource tags that you are adding to the access grant. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources.

Returns:



612
613
614
615
616
617
618
619
620
621
622
623
 
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 612

class CreateAccessGrantRequest < Struct.new(
  :account_id,
  :access_grants_location_id,
  :access_grants_location_configuration,
  :grantee,
  :permission,
  :application_arn,
  :s3_prefix_type,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end