We recommend new projects start with resources from the AWS provider.
aws-native.guardduty.IpSet
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
Resource Type definition for AWS::GuardDuty::IPSet
Create IpSet Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new IpSet(name: string, args: IpSetArgs, opts?: CustomResourceOptions);
@overload
def IpSet(resource_name: str,
args: IpSetArgs,
opts: Optional[ResourceOptions] = None)
@overload
def IpSet(resource_name: str,
opts: Optional[ResourceOptions] = None,
format: Optional[str] = None,
location: Optional[str] = None,
activate: Optional[bool] = None,
detector_id: Optional[str] = None,
name: Optional[str] = None,
tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
func NewIpSet(ctx *Context, name string, args IpSetArgs, opts ...ResourceOption) (*IpSet, error)
public IpSet(string name, IpSetArgs args, CustomResourceOptions? opts = null)
type: aws-native:guardduty:IpSet
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args IpSetArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args IpSetArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args IpSetArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args IpSetArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args IpSetArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
IpSet Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The IpSet resource accepts the following input properties:
- Format string
- The format of the file that contains the IPSet.
- Location string
- The URI of the file that contains the IPSet.
- Activate bool
- Indicates whether or not GuardDuty uses the
IPSet
. - Detector
Id string 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.- Name string
The user-friendly name to identify the IPSet.
Allowed characters are alphanumeric, whitespace, dash (-), and underscores (_).
- List<Pulumi.
Aws Native. Inputs. Tag> The tags to be added to a new IP set resource. Each tag consists of a key and an optional value, both of which you define.
For more information, see Tag .
- Format string
- The format of the file that contains the IPSet.
- Location string
- The URI of the file that contains the IPSet.
- Activate bool
- Indicates whether or not GuardDuty uses the
IPSet
. - Detector
Id string 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.- Name string
The user-friendly name to identify the IPSet.
Allowed characters are alphanumeric, whitespace, dash (-), and underscores (_).
- Tag
Args The tags to be added to a new IP set resource. Each tag consists of a key and an optional value, both of which you define.
For more information, see Tag .
- format String
- The format of the file that contains the IPSet.
- location String
- The URI of the file that contains the IPSet.
- activate Boolean
- Indicates whether or not GuardDuty uses the
IPSet
. - detector
Id String 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.- name String
The user-friendly name to identify the IPSet.
Allowed characters are alphanumeric, whitespace, dash (-), and underscores (_).
- List<Tag>
The tags to be added to a new IP set resource. Each tag consists of a key and an optional value, both of which you define.
For more information, see Tag .
- format string
- The format of the file that contains the IPSet.
- location string
- The URI of the file that contains the IPSet.
- activate boolean
- Indicates whether or not GuardDuty uses the
IPSet
. - detector
Id string 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.- name string
The user-friendly name to identify the IPSet.
Allowed characters are alphanumeric, whitespace, dash (-), and underscores (_).
- Tag[]
The tags to be added to a new IP set resource. Each tag consists of a key and an optional value, both of which you define.
For more information, see Tag .
- format str
- The format of the file that contains the IPSet.
- location str
- The URI of the file that contains the IPSet.
- activate bool
- Indicates whether or not GuardDuty uses the
IPSet
. - detector_
id str 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.- name str
The user-friendly name to identify the IPSet.
Allowed characters are alphanumeric, whitespace, dash (-), and underscores (_).
- Sequence[Tag
Args] The tags to be added to a new IP set resource. Each tag consists of a key and an optional value, both of which you define.
For more information, see Tag .
- format String
- The format of the file that contains the IPSet.
- location String
- The URI of the file that contains the IPSet.
- activate Boolean
- Indicates whether or not GuardDuty uses the
IPSet
. - detector
Id String 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.- name String
The user-friendly name to identify the IPSet.
Allowed characters are alphanumeric, whitespace, dash (-), and underscores (_).
- List<Property Map>
The tags to be added to a new IP set resource. Each tag consists of a key and an optional value, both of which you define.
For more information, see Tag .
Outputs
All input properties are implicitly available as output properties. Additionally, the IpSet resource produces the following output properties:
Supporting Types
Tag, TagArgs
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.