Amazonka.AccessAnalyzer.Types.RdsDbSnapshotConfiguration

Documentation

data RdsDbSnapshotConfiguration

The proposed access control configuration for an Amazon RDS DB snapshot. You can propose a configuration for a new Amazon RDS DB snapshot or an Amazon RDS DB snapshot that you own by specifying the RdsDbSnapshotAttributeValue and optional KMS encryption key. For more information, see ModifyDBSnapshotAttribute.

See: newRdsDbSnapshotConfiguration smart constructor.

Constructors

RdsDbSnapshotConfiguration'

Fields

• attributes :: Maybe (HashMap Text RdsDbSnapshotAttributeValue)

  The names and values of manual DB snapshot attributes. Manual DB snapshot attributes are used to authorize other Amazon Web Services accounts to restore a manual DB snapshot. The only valid value for attributeName for the attribute map is restore.

• kmsKeyId :: Maybe Text

  The KMS key identifier for an encrypted Amazon RDS DB 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 RDS DB 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 specify the kmsKeyId, then the access preview considers the snapshot as unencrypted.

Instances

FromJSON RdsDbSnapshotConfiguration

Defined in Amazonka.AccessAnalyzer.Types.RdsDbSnapshotConfiguration

Methods

parseJSON :: Value -> Parser RdsDbSnapshotConfiguration

parseJSONList :: Value -> Parser [RdsDbSnapshotConfiguration]

ToJSON RdsDbSnapshotConfiguration

Defined in Amazonka.AccessAnalyzer.Types.RdsDbSnapshotConfiguration

Methods

toJSON :: RdsDbSnapshotConfiguration -> Value

toEncoding :: RdsDbSnapshotConfiguration -> Encoding

toJSONList :: [RdsDbSnapshotConfiguration] -> Value

toEncodingList :: [RdsDbSnapshotConfiguration] -> Encoding

Generic RdsDbSnapshotConfiguration

Defined in Amazonka.AccessAnalyzer.Types.RdsDbSnapshotConfiguration

Associated Types

type Rep RdsDbSnapshotConfiguration :: Type -> Type

Methods

from :: RdsDbSnapshotConfiguration -> Rep RdsDbSnapshotConfiguration x

to :: Rep RdsDbSnapshotConfiguration x -> RdsDbSnapshotConfiguration

Read RdsDbSnapshotConfiguration

Defined in Amazonka.AccessAnalyzer.Types.RdsDbSnapshotConfiguration

Methods

readsPrec :: Int -> ReadS RdsDbSnapshotConfiguration

readList :: ReadS [RdsDbSnapshotConfiguration]

readPrec :: ReadPrec RdsDbSnapshotConfiguration

readListPrec :: ReadPrec [RdsDbSnapshotConfiguration]

Show RdsDbSnapshotConfiguration

Defined in Amazonka.AccessAnalyzer.Types.RdsDbSnapshotConfiguration

Methods

showsPrec :: Int -> RdsDbSnapshotConfiguration -> ShowS

show :: RdsDbSnapshotConfiguration -> String

showList :: [RdsDbSnapshotConfiguration] -> ShowS

NFData RdsDbSnapshotConfiguration

Defined in Amazonka.AccessAnalyzer.Types.RdsDbSnapshotConfiguration

Methods

rnf :: RdsDbSnapshotConfiguration -> ()

Eq RdsDbSnapshotConfiguration

Defined in Amazonka.AccessAnalyzer.Types.RdsDbSnapshotConfiguration

Methods

(==) :: RdsDbSnapshotConfiguration -> RdsDbSnapshotConfiguration -> Bool

(/=) :: RdsDbSnapshotConfiguration -> RdsDbSnapshotConfiguration -> Bool

Hashable RdsDbSnapshotConfiguration

Defined in Amazonka.AccessAnalyzer.Types.RdsDbSnapshotConfiguration

Methods

hashWithSalt :: Int -> RdsDbSnapshotConfiguration -> Int

hash :: RdsDbSnapshotConfiguration -> Int

type Rep RdsDbSnapshotConfiguration

Defined in Amazonka.AccessAnalyzer.Types.RdsDbSnapshotConfiguration

type Rep RdsDbSnapshotConfiguration = D1 ('MetaData "RdsDbSnapshotConfiguration" "Amazonka.AccessAnalyzer.Types.RdsDbSnapshotConfiguration" "amazonka-accessanalyzer-2.0-A0JZirwj4a95MolJaaBere" 'False) (C1 ('MetaCons "RdsDbSnapshotConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "attributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text RdsDbSnapshotAttributeValue))) :*: S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newRdsDbSnapshotConfiguration :: RdsDbSnapshotConfiguration

Create a value of RdsDbSnapshotConfiguration 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:attributes:RdsDbSnapshotConfiguration', rdsDbSnapshotConfiguration_attributes - The names and values of manual DB snapshot attributes. Manual DB snapshot attributes are used to authorize other Amazon Web Services accounts to restore a manual DB snapshot. The only valid value for attributeName for the attribute map is restore.

$sel:kmsKeyId:RdsDbSnapshotConfiguration', rdsDbSnapshotConfiguration_kmsKeyId - The KMS key identifier for an encrypted Amazon RDS DB 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 RDS DB 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 specify the kmsKeyId, then the access preview considers the snapshot as unencrypted.

rdsDbSnapshotConfiguration_attributes :: Lens' RdsDbSnapshotConfiguration (Maybe (HashMap Text RdsDbSnapshotAttributeValue))

The names and values of manual DB snapshot attributes. Manual DB snapshot attributes are used to authorize other Amazon Web Services accounts to restore a manual DB snapshot. The only valid value for attributeName for the attribute map is restore.

rdsDbSnapshotConfiguration_kmsKeyId :: Lens' RdsDbSnapshotConfiguration (Maybe Text)

The KMS key identifier for an encrypted Amazon RDS DB 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 RDS DB 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 specify the kmsKeyId, then the access preview considers the snapshot as unencrypted.