Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.GuardDuty.CreateIPSet

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a new IPSet, which is called a trusted IP list in the console user interface. An IPSet is a list of IP addresses that are trusted for secure communication with AWS infrastructure and applications. GuardDuty doesn't generate findings for IP addresses that are included in IPSets. Only users from the administrator account can use this operation.

Synopsis

data CreateIPSet = CreateIPSet' {
- clientToken :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- detectorId :: Text
- name :: Text
- format :: IpSetFormat
- location :: Text
- activate :: Bool
}
newCreateIPSet :: Text -> Text -> IpSetFormat -> Text -> Bool -> CreateIPSet
createIPSet_clientToken :: Lens' CreateIPSet (Maybe Text)
createIPSet_tags :: Lens' CreateIPSet (Maybe (HashMap Text Text))
createIPSet_detectorId :: Lens' CreateIPSet Text
createIPSet_name :: Lens' CreateIPSet Text
createIPSet_format :: Lens' CreateIPSet IpSetFormat
createIPSet_location :: Lens' CreateIPSet Text
createIPSet_activate :: Lens' CreateIPSet Bool
data CreateIPSetResponse = CreateIPSetResponse' {
- httpStatus :: Int
- ipSetId :: Text
}
newCreateIPSetResponse :: Int -> Text -> CreateIPSetResponse
createIPSetResponse_httpStatus :: Lens' CreateIPSetResponse Int
createIPSetResponse_ipSetId :: Lens' CreateIPSetResponse Text

Creating a Request

data CreateIPSet Source #

See: newCreateIPSet smart constructor.

Constructors

CreateIPSet'

Fields

clientToken :: Maybe Text
The idempotency token for the create request.
tags :: Maybe (HashMap Text Text)
The tags to be added to a new IP set resource.
detectorId :: Text
The unique ID of the detector of the GuardDuty account that you want to create an IPSet for.
name :: Text
The user-friendly name to identify the IPSet.
Allowed characters are alphanumerics, spaces, hyphens (-), and underscores (_).
format :: IpSetFormat
The format of the file that contains the IPSet.
location :: Text
The URI of the file that contains the IPSet. For example: https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key.
activate :: Bool
A Boolean value that indicates whether GuardDuty is to start using the uploaded IPSet.

Instances

Instances details

Eq CreateIPSet Source #
Instance details Defined in Amazonka.GuardDuty.CreateIPSet Methods (==) :: CreateIPSet -> CreateIPSet -> Bool # (/=) :: CreateIPSet -> CreateIPSet -> Bool #
Read CreateIPSet Source #
Instance details Defined in Amazonka.GuardDuty.CreateIPSet Methods readsPrec :: Int -> ReadS CreateIPSet # readList :: ReadS [CreateIPSet] # readPrec :: ReadPrec CreateIPSet # readListPrec :: ReadPrec [CreateIPSet] #
Show CreateIPSet Source #
Instance details Defined in Amazonka.GuardDuty.CreateIPSet Methods showsPrec :: Int -> CreateIPSet -> ShowS # show :: CreateIPSet -> String # showList :: [CreateIPSet] -> ShowS #
Generic CreateIPSet Source #
Instance details Defined in Amazonka.GuardDuty.CreateIPSet Associated Types type Rep CreateIPSet :: Type -> Type # Methods from :: CreateIPSet -> Rep CreateIPSet x # to :: Rep CreateIPSet x -> CreateIPSet #
NFData CreateIPSet Source #
Instance details Defined in Amazonka.GuardDuty.CreateIPSet Methods rnf :: CreateIPSet -> () #
Hashable CreateIPSet Source #
Instance details Defined in Amazonka.GuardDuty.CreateIPSet Methods hashWithSalt :: Int -> CreateIPSet -> Int # hash :: CreateIPSet -> Int #
ToJSON CreateIPSet Source #
Instance details Defined in Amazonka.GuardDuty.CreateIPSet Methods toJSON :: CreateIPSet -> Value # toEncoding :: CreateIPSet -> Encoding # toJSONList :: [CreateIPSet] -> Value # toEncodingList :: [CreateIPSet] -> Encoding #
AWSRequest CreateIPSet Source #
Instance details Defined in Amazonka.GuardDuty.CreateIPSet Associated Types type AWSResponse CreateIPSet # Methods request :: CreateIPSet -> Request CreateIPSet # response :: MonadResource m => Logger -> Service -> Proxy CreateIPSet -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateIPSet))) #
ToHeaders CreateIPSet Source #
Instance details Defined in Amazonka.GuardDuty.CreateIPSet Methods toHeaders :: CreateIPSet -> [Header] #
ToPath CreateIPSet Source #
Instance details Defined in Amazonka.GuardDuty.CreateIPSet Methods toPath :: CreateIPSet -> ByteString #
ToQuery CreateIPSet Source #
Instance details Defined in Amazonka.GuardDuty.CreateIPSet Methods toQuery :: CreateIPSet -> QueryString #
type Rep CreateIPSet Source #
Instance details Defined in Amazonka.GuardDuty.CreateIPSet type Rep CreateIPSet = D1 ('MetaData "CreateIPSet" "Amazonka.GuardDuty.CreateIPSet" "libZSservicesZSamazonka-guarddutyZSamazonka-guardduty" 'False) (C1 ('MetaCons "CreateIPSet'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "detectorId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :: ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "format") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 IpSetFormat)) :: (S1 ('MetaSel ('Just "location") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "activate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)))))
type AWSResponse CreateIPSet Source #
Instance details Defined in Amazonka.GuardDuty.CreateIPSet type AWSResponse CreateIPSet = CreateIPSetResponse

newCreateIPSet Source #

Arguments

:: Text	`$sel:detectorId:CreateIPSet'`
-> Text	`$sel:name:CreateIPSet'`
-> IpSetFormat	`$sel:format:CreateIPSet'`
-> Text	`$sel:location:CreateIPSet'`
-> Bool	`$sel:activate:CreateIPSet'`
-> CreateIPSet

Create a value of CreateIPSet 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:clientToken:CreateIPSet', createIPSet_clientToken - The idempotency token for the create request.

$sel:tags:CreateIPSet', createIPSet_tags - The tags to be added to a new IP set resource.

$sel:detectorId:CreateIPSet', createIPSet_detectorId - The unique ID of the detector of the GuardDuty account that you want to create an IPSet for.

$sel:name:CreateIPSet', createIPSet_name - The user-friendly name to identify the IPSet.

Allowed characters are alphanumerics, spaces, hyphens (-), and underscores (_).

$sel:format:CreateIPSet', createIPSet_format - The format of the file that contains the IPSet.

$sel:location:CreateIPSet', createIPSet_location - The URI of the file that contains the IPSet. For example: https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key.

$sel:activate:CreateIPSet', createIPSet_activate - A Boolean value that indicates whether GuardDuty is to start using the uploaded IPSet.

Request Lenses

createIPSet_clientToken :: Lens' CreateIPSet (Maybe Text) Source #

The idempotency token for the create request.

createIPSet_tags :: Lens' CreateIPSet (Maybe (HashMap Text Text)) Source #

The tags to be added to a new IP set resource.

createIPSet_detectorId :: Lens' CreateIPSet Text Source #

The unique ID of the detector of the GuardDuty account that you want to create an IPSet for.

createIPSet_name :: Lens' CreateIPSet Text Source #

The user-friendly name to identify the IPSet.

Allowed characters are alphanumerics, spaces, hyphens (-), and underscores (_).

createIPSet_format :: Lens' CreateIPSet IpSetFormat Source #

The format of the file that contains the IPSet.

createIPSet_location :: Lens' CreateIPSet Text Source #

The URI of the file that contains the IPSet. For example: https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key.

createIPSet_activate :: Lens' CreateIPSet Bool Source #

A Boolean value that indicates whether GuardDuty is to start using the uploaded IPSet.

Destructuring the Response

data CreateIPSetResponse Source #

See: newCreateIPSetResponse smart constructor.

Constructors

CreateIPSetResponse'
Fields httpStatus :: Int The response's http status code. ipSetId :: Text The ID of the IPSet resource.

Instances

Instances details

Eq CreateIPSetResponse Source #
Instance details Defined in Amazonka.GuardDuty.CreateIPSet Methods (==) :: CreateIPSetResponse -> CreateIPSetResponse -> Bool # (/=) :: CreateIPSetResponse -> CreateIPSetResponse -> Bool #
Read CreateIPSetResponse Source #
Instance details Defined in Amazonka.GuardDuty.CreateIPSet Methods readsPrec :: Int -> ReadS CreateIPSetResponse # readList :: ReadS [CreateIPSetResponse] # readPrec :: ReadPrec CreateIPSetResponse # readListPrec :: ReadPrec [CreateIPSetResponse] #
Show CreateIPSetResponse Source #
Instance details Defined in Amazonka.GuardDuty.CreateIPSet Methods showsPrec :: Int -> CreateIPSetResponse -> ShowS # show :: CreateIPSetResponse -> String # showList :: [CreateIPSetResponse] -> ShowS #
Generic CreateIPSetResponse Source #
Instance details Defined in Amazonka.GuardDuty.CreateIPSet Associated Types type Rep CreateIPSetResponse :: Type -> Type # Methods from :: CreateIPSetResponse -> Rep CreateIPSetResponse x # to :: Rep CreateIPSetResponse x -> CreateIPSetResponse #
NFData CreateIPSetResponse Source #
Instance details Defined in Amazonka.GuardDuty.CreateIPSet Methods rnf :: CreateIPSetResponse -> () #
type Rep CreateIPSetResponse Source #
Instance details Defined in Amazonka.GuardDuty.CreateIPSet type Rep CreateIPSetResponse = D1 ('MetaData "CreateIPSetResponse" "Amazonka.GuardDuty.CreateIPSet" "libZSservicesZSamazonka-guarddutyZSamazonka-guardduty" 'False) (C1 ('MetaCons "CreateIPSetResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "ipSetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newCreateIPSetResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateIPSetResponse'`
-> Text	`$sel:ipSetId:CreateIPSetResponse'`
-> CreateIPSetResponse

Create a value of CreateIPSetResponse 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:httpStatus:CreateIPSetResponse', createIPSetResponse_httpStatus - The response's http status code.

$sel:ipSetId:CreateIPSetResponse', createIPSetResponse_ipSetId - The ID of the IPSet resource.

Response Lenses

createIPSetResponse_httpStatus :: Lens' CreateIPSetResponse Int Source #

The response's http status code.

createIPSetResponse_ipSetId :: Lens' CreateIPSetResponse Text Source #

The ID of the IPSet resource.