create_ip_set¶
Operation¶
async
¶
create_ip_set(input: CreateIPSetInput, plugins: list[Plugin] | None = None) -> CreateIPSetOutput
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 Amazon Web Services 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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
CreateIPSetInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
CreateIPSetOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for CreateIPSetInput structure.
Attributes¶
class-attribute
instance-attribute
¶
activate: bool | None = None
A Boolean value that indicates whether GuardDuty is to start using the uploaded IPSet.
class-attribute
instance-attribute
¶
client_token: str | None = None
The idempotency token for the create request.
class-attribute
instance-attribute
¶
detector_id: str | None = None
The unique ID of the detector of the GuardDuty account for which you want to create an IPSet.
To find the detectorId in the current Region, see the Settings page in
the GuardDuty console, or run the
ListDetectors
API.
class-attribute
instance-attribute
¶
expected_bucket_owner: str | None = None
The Amazon Web Services account ID that owns the Amazon S3 bucket specified in the location parameter.
class-attribute
instance-attribute
¶
format: IpSetFormat | None = None
The format of the file that contains the IPSet.
class-attribute
instance-attribute
¶
location: str | None = None
The URI of the file that contains the IPSet.
class-attribute
instance-attribute
¶
name: str | None = None
The user-friendly name to identify the IPSet.
Allowed characters are alphanumeric, whitespace, dash (-), and underscores (_).
class-attribute
instance-attribute
¶
tags: dict[str, str] | None = None
The tags to be added to a new IP set resource.