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.RDS.ModifyOptionGroup

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Modifies an existing option group.

Synopsis

data ModifyOptionGroup = ModifyOptionGroup' {
- applyImmediately :: Maybe Bool
- optionsToInclude :: Maybe [OptionConfiguration]
- optionsToRemove :: Maybe [Text]
- optionGroupName :: Text
}
newModifyOptionGroup :: Text -> ModifyOptionGroup
modifyOptionGroup_applyImmediately :: Lens' ModifyOptionGroup (Maybe Bool)
modifyOptionGroup_optionsToInclude :: Lens' ModifyOptionGroup (Maybe [OptionConfiguration])
modifyOptionGroup_optionsToRemove :: Lens' ModifyOptionGroup (Maybe [Text])
modifyOptionGroup_optionGroupName :: Lens' ModifyOptionGroup Text
data ModifyOptionGroupResponse = ModifyOptionGroupResponse' {
- optionGroup :: Maybe OptionGroup
- httpStatus :: Int
}
newModifyOptionGroupResponse :: Int -> ModifyOptionGroupResponse
modifyOptionGroupResponse_optionGroup :: Lens' ModifyOptionGroupResponse (Maybe OptionGroup)
modifyOptionGroupResponse_httpStatus :: Lens' ModifyOptionGroupResponse Int

Creating a Request

data ModifyOptionGroup Source #

See: newModifyOptionGroup smart constructor.

Constructors

ModifyOptionGroup'

Fields

applyImmediately :: Maybe Bool
A value that indicates whether to apply the change immediately or during the next maintenance window for each instance associated with the option group.
optionsToInclude :: Maybe [OptionConfiguration]
Options in this list are added to the option group or, if already present, the specified configuration is used to update the existing configuration.
optionsToRemove :: Maybe [Text]
Options in this list are removed from the option group.
optionGroupName :: Text
The name of the option group to be modified.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance

Instances

Instances details

ToHeaders ModifyOptionGroup Source #
Instance details Defined in Amazonka.RDS.ModifyOptionGroup Methods toHeaders :: ModifyOptionGroup -> [Header] #
ToPath ModifyOptionGroup Source #
Instance details Defined in Amazonka.RDS.ModifyOptionGroup Methods toPath :: ModifyOptionGroup -> ByteString #
ToQuery ModifyOptionGroup Source #
Instance details Defined in Amazonka.RDS.ModifyOptionGroup Methods toQuery :: ModifyOptionGroup -> QueryString #
AWSRequest ModifyOptionGroup Source #
Instance details Defined in Amazonka.RDS.ModifyOptionGroup Associated Types type AWSResponse ModifyOptionGroup # Methods request :: (Service -> Service) -> ModifyOptionGroup -> Request ModifyOptionGroup # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ModifyOptionGroup -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ModifyOptionGroup))) #
Generic ModifyOptionGroup Source #
Instance details Defined in Amazonka.RDS.ModifyOptionGroup Associated Types type Rep ModifyOptionGroup :: Type -> Type # Methods from :: ModifyOptionGroup -> Rep ModifyOptionGroup x # to :: Rep ModifyOptionGroup x -> ModifyOptionGroup #
Read ModifyOptionGroup Source #
Instance details Defined in Amazonka.RDS.ModifyOptionGroup Methods readsPrec :: Int -> ReadS ModifyOptionGroup # readList :: ReadS [ModifyOptionGroup] # readPrec :: ReadPrec ModifyOptionGroup # readListPrec :: ReadPrec [ModifyOptionGroup] #
Show ModifyOptionGroup Source #
Instance details Defined in Amazonka.RDS.ModifyOptionGroup Methods showsPrec :: Int -> ModifyOptionGroup -> ShowS # show :: ModifyOptionGroup -> String # showList :: [ModifyOptionGroup] -> ShowS #
NFData ModifyOptionGroup Source #
Instance details Defined in Amazonka.RDS.ModifyOptionGroup Methods rnf :: ModifyOptionGroup -> () #
Eq ModifyOptionGroup Source #
Instance details Defined in Amazonka.RDS.ModifyOptionGroup Methods (==) :: ModifyOptionGroup -> ModifyOptionGroup -> Bool # (/=) :: ModifyOptionGroup -> ModifyOptionGroup -> Bool #
Hashable ModifyOptionGroup Source #
Instance details Defined in Amazonka.RDS.ModifyOptionGroup Methods hashWithSalt :: Int -> ModifyOptionGroup -> Int # hash :: ModifyOptionGroup -> Int #
type AWSResponse ModifyOptionGroup Source #
Instance details Defined in Amazonka.RDS.ModifyOptionGroup type AWSResponse ModifyOptionGroup = ModifyOptionGroupResponse
type Rep ModifyOptionGroup Source #
Instance details Defined in Amazonka.RDS.ModifyOptionGroup type Rep ModifyOptionGroup = D1 ('MetaData "ModifyOptionGroup" "Amazonka.RDS.ModifyOptionGroup" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "ModifyOptionGroup'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "applyImmediately") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "optionsToInclude") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [OptionConfiguration]))) :: (S1 ('MetaSel ('Just "optionsToRemove") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "optionGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newModifyOptionGroup Source #

Arguments

:: Text	`ModifyOptionGroup`
-> ModifyOptionGroup

Create a value of ModifyOptionGroup 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:applyImmediately:ModifyOptionGroup', modifyOptionGroup_applyImmediately - A value that indicates whether to apply the change immediately or during the next maintenance window for each instance associated with the option group.

$sel:optionsToInclude:ModifyOptionGroup', modifyOptionGroup_optionsToInclude - Options in this list are added to the option group or, if already present, the specified configuration is used to update the existing configuration.

$sel:optionsToRemove:ModifyOptionGroup', modifyOptionGroup_optionsToRemove - Options in this list are removed from the option group.

ModifyOptionGroup, modifyOptionGroup_optionGroupName - The name of the option group to be modified.

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance

Request Lenses

modifyOptionGroup_applyImmediately :: Lens' ModifyOptionGroup (Maybe Bool) Source #

A value that indicates whether to apply the change immediately or during the next maintenance window for each instance associated with the option group.

modifyOptionGroup_optionsToInclude :: Lens' ModifyOptionGroup (Maybe [OptionConfiguration]) Source #

Options in this list are added to the option group or, if already present, the specified configuration is used to update the existing configuration.

modifyOptionGroup_optionsToRemove :: Lens' ModifyOptionGroup (Maybe [Text]) Source #

Options in this list are removed from the option group.

modifyOptionGroup_optionGroupName :: Lens' ModifyOptionGroup Text Source #

The name of the option group to be modified.

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance

Destructuring the Response

data ModifyOptionGroupResponse Source #

See: newModifyOptionGroupResponse smart constructor.

Constructors

ModifyOptionGroupResponse'
Fields optionGroup :: Maybe OptionGroup httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ModifyOptionGroupResponse Source #
Instance details Defined in Amazonka.RDS.ModifyOptionGroup Associated Types type Rep ModifyOptionGroupResponse :: Type -> Type # Methods from :: ModifyOptionGroupResponse -> Rep ModifyOptionGroupResponse x # to :: Rep ModifyOptionGroupResponse x -> ModifyOptionGroupResponse #
Read ModifyOptionGroupResponse Source #
Instance details Defined in Amazonka.RDS.ModifyOptionGroup Methods readsPrec :: Int -> ReadS ModifyOptionGroupResponse # readList :: ReadS [ModifyOptionGroupResponse] # readPrec :: ReadPrec ModifyOptionGroupResponse # readListPrec :: ReadPrec [ModifyOptionGroupResponse] #
Show ModifyOptionGroupResponse Source #
Instance details Defined in Amazonka.RDS.ModifyOptionGroup Methods showsPrec :: Int -> ModifyOptionGroupResponse -> ShowS # show :: ModifyOptionGroupResponse -> String # showList :: [ModifyOptionGroupResponse] -> ShowS #
NFData ModifyOptionGroupResponse Source #
Instance details Defined in Amazonka.RDS.ModifyOptionGroup Methods rnf :: ModifyOptionGroupResponse -> () #
Eq ModifyOptionGroupResponse Source #
Instance details Defined in Amazonka.RDS.ModifyOptionGroup Methods (==) :: ModifyOptionGroupResponse -> ModifyOptionGroupResponse -> Bool # (/=) :: ModifyOptionGroupResponse -> ModifyOptionGroupResponse -> Bool #
type Rep ModifyOptionGroupResponse Source #
Instance details Defined in Amazonka.RDS.ModifyOptionGroup type Rep ModifyOptionGroupResponse = D1 ('MetaData "ModifyOptionGroupResponse" "Amazonka.RDS.ModifyOptionGroup" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "ModifyOptionGroupResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "optionGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OptionGroup)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newModifyOptionGroupResponse Source #

Arguments

:: Int	`$sel:httpStatus:ModifyOptionGroupResponse'`
-> ModifyOptionGroupResponse

Create a value of ModifyOptionGroupResponse 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:optionGroup:ModifyOptionGroupResponse', modifyOptionGroupResponse_optionGroup - Undocumented member.

$sel:httpStatus:ModifyOptionGroupResponse', modifyOptionGroupResponse_httpStatus - The response's http status code.

Response Lenses

modifyOptionGroupResponse_optionGroup :: Lens' ModifyOptionGroupResponse (Maybe OptionGroup) Source #

Undocumented member.

modifyOptionGroupResponse_httpStatus :: Lens' ModifyOptionGroupResponse Int Source #

The response's http status code.