Class: Aws::AccessAnalyzer::Types::EbsSnapshotConfiguration

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

Overview

The proposed access control configuration for an Amazon EBS volume snapshot. You can propose a configuration for a new Amazon EBS volume snapshot or an Amazon EBS volume snapshot that you own by specifying the user IDs, groups, and optional KMS encryption key. For more information, see [ModifySnapshotAttribute].

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifySnapshotAttribute.html

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#groups ⇒ Array<String>

The groups that have access to the Amazon EBS volume snapshot. If the value ‘all` is specified, then the Amazon EBS volume snapshot is public.

  • If the configuration is for an existing Amazon EBS volume snapshot and you do not specify the ‘groups`, then the access preview uses the existing shared `groups` for the snapshot.

  • If the access preview is for a new resource and you do not specify the ‘groups`, then the access preview considers the snapshot without any `groups`.

  • To propose deletion of existing shared ‘groups`, you can specify an empty list for `groups`.

Returns:

  • (Array<String>) 


1301
1302
1303
1304
1305
1306
1307
 
# File 'lib/aws-sdk-accessanalyzer/types.rb', line 1301

class EbsSnapshotConfiguration < Struct.new(
  :user_ids,
  :groups,
  :kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ String

The KMS key identifier for an encrypted Amazon EBS volume snapshot. The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

  • If the configuration is for an existing Amazon EBS volume snapshot and you do not specify the ‘kmsKeyId`, or you specify an empty string, then the access preview uses the existing `kmsKeyId` of the snapshot.

  • If the access preview is for a new resource and you do not specify the ‘kmsKeyId`, the access preview considers the snapshot as unencrypted.

Returns:

  • (String) 


1301
1302
1303
1304
1305
1306
1307
 
# File 'lib/aws-sdk-accessanalyzer/types.rb', line 1301

class EbsSnapshotConfiguration < Struct.new(
  :user_ids,
  :groups,
  :kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#user_ids ⇒ Array<String>

The IDs of the Amazon Web Services accounts that have access to the Amazon EBS volume snapshot.

  • If the configuration is for an existing Amazon EBS volume snapshot and you do not specify the ‘userIds`, then the access preview uses the existing shared `userIds` for the snapshot.

  • If the access preview is for a new resource and you do not specify the ‘userIds`, then the access preview considers the snapshot without any `userIds`.

  • To propose deletion of existing shared ‘accountIds`, you can specify an empty list for `userIds`.

Returns:

  • (Array<String>) 


1301
1302
1303
1304
1305
1306
1307
 
# File 'lib/aws-sdk-accessanalyzer/types.rb', line 1301

class EbsSnapshotConfiguration < Struct.new(
  :user_ids,
  :groups,
  :kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end