Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.AccessAnalyzer.Types.EbsSnapshotConfiguration

Description

Documentation

data EbsSnapshotConfiguration Source #

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.

See: newEbsSnapshotConfiguration smart constructor.

Constructors

EbsSnapshotConfiguration'

Fields

groups :: Maybe [Text]
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.
kmsKeyId :: Maybe Text
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.
userIds :: Maybe [Text]
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.

Instances

Instances details

FromJSON EbsSnapshotConfiguration Source #
Instance details Defined in Amazonka.AccessAnalyzer.Types.EbsSnapshotConfiguration Methods parseJSON :: Value -> Parser EbsSnapshotConfiguration # parseJSONList :: Value -> Parser [EbsSnapshotConfiguration] #
ToJSON EbsSnapshotConfiguration Source #
Instance details Defined in Amazonka.AccessAnalyzer.Types.EbsSnapshotConfiguration Methods toJSON :: EbsSnapshotConfiguration -> Value # toEncoding :: EbsSnapshotConfiguration -> Encoding # toJSONList :: [EbsSnapshotConfiguration] -> Value # toEncodingList :: [EbsSnapshotConfiguration] -> Encoding #
Generic EbsSnapshotConfiguration Source #
Instance details Defined in Amazonka.AccessAnalyzer.Types.EbsSnapshotConfiguration Associated Types type Rep EbsSnapshotConfiguration :: Type -> Type # Methods from :: EbsSnapshotConfiguration -> Rep EbsSnapshotConfiguration x # to :: Rep EbsSnapshotConfiguration x -> EbsSnapshotConfiguration #
Read EbsSnapshotConfiguration Source #
Instance details Defined in Amazonka.AccessAnalyzer.Types.EbsSnapshotConfiguration Methods readsPrec :: Int -> ReadS EbsSnapshotConfiguration # readList :: ReadS [EbsSnapshotConfiguration] # readPrec :: ReadPrec EbsSnapshotConfiguration # readListPrec :: ReadPrec [EbsSnapshotConfiguration] #
Show EbsSnapshotConfiguration Source #
Instance details Defined in Amazonka.AccessAnalyzer.Types.EbsSnapshotConfiguration Methods showsPrec :: Int -> EbsSnapshotConfiguration -> ShowS # show :: EbsSnapshotConfiguration -> String # showList :: [EbsSnapshotConfiguration] -> ShowS #
NFData EbsSnapshotConfiguration Source #
Instance details Defined in Amazonka.AccessAnalyzer.Types.EbsSnapshotConfiguration Methods rnf :: EbsSnapshotConfiguration -> () #
Eq EbsSnapshotConfiguration Source #
Instance details Defined in Amazonka.AccessAnalyzer.Types.EbsSnapshotConfiguration Methods (==) :: EbsSnapshotConfiguration -> EbsSnapshotConfiguration -> Bool # (/=) :: EbsSnapshotConfiguration -> EbsSnapshotConfiguration -> Bool #
Hashable EbsSnapshotConfiguration Source #
Instance details Defined in Amazonka.AccessAnalyzer.Types.EbsSnapshotConfiguration Methods hashWithSalt :: Int -> EbsSnapshotConfiguration -> Int # hash :: EbsSnapshotConfiguration -> Int #
type Rep EbsSnapshotConfiguration Source #
Instance details Defined in Amazonka.AccessAnalyzer.Types.EbsSnapshotConfiguration type Rep EbsSnapshotConfiguration = D1 ('MetaData "EbsSnapshotConfiguration" "Amazonka.AccessAnalyzer.Types.EbsSnapshotConfiguration" "amazonka-accessanalyzer-2.0-A0JZirwj4a95MolJaaBere" 'False) (C1 ('MetaCons "EbsSnapshotConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "groups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "userIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))))

newEbsSnapshotConfiguration :: EbsSnapshotConfiguration Source #

Create a value of EbsSnapshotConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:groups:EbsSnapshotConfiguration', ebsSnapshotConfiguration_groups - 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.

$sel:kmsKeyId:EbsSnapshotConfiguration', ebsSnapshotConfiguration_kmsKeyId - 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.

$sel:userIds:EbsSnapshotConfiguration', ebsSnapshotConfiguration_userIds - 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.

ebsSnapshotConfiguration_groups :: Lens' EbsSnapshotConfiguration (Maybe [Text]) Source #

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.

ebsSnapshotConfiguration_kmsKeyId :: Lens' EbsSnapshotConfiguration (Maybe Text) Source #

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.

ebsSnapshotConfiguration_userIds :: Lens' EbsSnapshotConfiguration (Maybe [Text]) Source #

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.