Class: Aws::S3Control::Types::CreateAccessGrantResult

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#access_grant_arn ⇒ String

The Amazon Resource Name (ARN) of the access grant.

Returns:

  • (String) 


684
685
686
687
688
689
690
691
692
693
694
695
696
 
# File 'lib/aws-sdk-s3control/types.rb', line 684

class CreateAccessGrantResult < Struct.new(
  :created_at,
  :access_grant_id,
  :access_grant_arn,
  :grantee,
  :access_grants_location_id,
  :access_grants_location_configuration,
  :permission,
  :application_arn,
  :grant_scope)
  SENSITIVE = []
  include Aws::Structure
end

#access_grant_id ⇒ String

The ID of the access grant. S3 Access Grants auto-generates this ID when you create the access grant.

Returns:

  • (String) 


684
685
686
687
688
689
690
691
692
693
694
695
696
 
# File 'lib/aws-sdk-s3control/types.rb', line 684

class CreateAccessGrantResult < Struct.new(
  :created_at,
  :access_grant_id,
  :access_grant_arn,
  :grantee,
  :access_grants_location_id,
  :access_grants_location_configuration,
  :permission,
  :application_arn,
  :grant_scope)
  SENSITIVE = []
  include Aws::Structure
end

#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.

Returns:



684
685
686
687
688
689
690
691
692
693
694
695
696
 
# File 'lib/aws-sdk-s3control/types.rb', line 684

class CreateAccessGrantResult < Struct.new(
  :created_at,
  :access_grant_id,
  :access_grant_arn,
  :grantee,
  :access_grants_location_id,
  :access_grants_location_configuration,
  :permission,
  :application_arn,
  :grant_scope)
  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.

Returns:

  • (String) 


684
685
686
687
688
689
690
691
692
693
694
695
696
 
# File 'lib/aws-sdk-s3control/types.rb', line 684

class CreateAccessGrantResult < Struct.new(
  :created_at,
  :access_grant_id,
  :access_grant_arn,
  :grantee,
  :access_grants_location_id,
  :access_grants_location_configuration,
  :permission,
  :application_arn,
  :grant_scope)
  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 the grant includes an application ARN, the grantee can only access the S3 data through this application.

Returns:

  • (String) 


684
685
686
687
688
689
690
691
692
693
694
695
696
 
# File 'lib/aws-sdk-s3control/types.rb', line 684

class CreateAccessGrantResult < Struct.new(
  :created_at,
  :access_grant_id,
  :access_grant_arn,
  :grantee,
  :access_grants_location_id,
  :access_grants_location_configuration,
  :permission,
  :application_arn,
  :grant_scope)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ Time

The date and time when you created the access grant.

Returns:

  • (Time) 


684
685
686
687
688
689
690
691
692
693
694
695
696
 
# File 'lib/aws-sdk-s3control/types.rb', line 684

class CreateAccessGrantResult < Struct.new(
  :created_at,
  :access_grant_id,
  :access_grant_arn,
  :grantee,
  :access_grants_location_id,
  :access_grants_location_configuration,
  :permission,
  :application_arn,
  :grant_scope)
  SENSITIVE = []
  include Aws::Structure
end

#grant_scope ⇒ String

The S3 path of the data to which you are granting access. It is the result of appending the ‘Subprefix` to the location scope.

Returns:

  • (String) 


684
685
686
687
688
689
690
691
692
693
694
695
696
 
# File 'lib/aws-sdk-s3control/types.rb', line 684

class CreateAccessGrantResult < Struct.new(
  :created_at,
  :access_grant_id,
  :access_grant_arn,
  :grantee,
  :access_grants_location_id,
  :access_grants_location_configuration,
  :permission,
  :application_arn,
  :grant_scope)
  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:



684
685
686
687
688
689
690
691
692
693
694
695
696
 
# File 'lib/aws-sdk-s3control/types.rb', line 684

class CreateAccessGrantResult < Struct.new(
  :created_at,
  :access_grant_id,
  :access_grant_arn,
  :grantee,
  :access_grants_location_id,
  :access_grants_location_configuration,
  :permission,
  :application_arn,
  :grant_scope)
  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) 


684
685
686
687
688
689
690
691
692
693
694
695
696
 
# File 'lib/aws-sdk-s3control/types.rb', line 684

class CreateAccessGrantResult < Struct.new(
  :created_at,
  :access_grant_id,
  :access_grant_arn,
  :grantee,
  :access_grants_location_id,
  :access_grants_location_configuration,
  :permission,
  :application_arn,
  :grant_scope)
  SENSITIVE = []
  include Aws::Structure
end