1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. guardduty
  5. IpSet

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi

aws-native.guardduty.IpSet

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi

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)
public IpSet(String name, IpSetArgs args)
public IpSet(String name, IpSetArgs args, CustomResourceOptions options)
type: aws-native:guardduty:IpSet
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. IpSetArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. IpSetArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. IpSetArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. 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 This property is required. string
The format of the file that contains the IPSet.
Location This property is required. string
The URI of the file that contains the IPSet.
Activate bool
Indicates whether or not GuardDuty uses the IPSet .
DetectorId 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 (_).

Tags List<Pulumi.AwsNative.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 This property is required. string
The format of the file that contains the IPSet.
Location This property is required. string
The URI of the file that contains the IPSet.
Activate bool
Indicates whether or not GuardDuty uses the IPSet .
DetectorId 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 (_).

Tags TagArgs

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 This property is required. String
The format of the file that contains the IPSet.
location This property is required. String
The URI of the file that contains the IPSet.
activate Boolean
Indicates whether or not GuardDuty uses the IPSet .
detectorId 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 (_).

tags 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 This property is required. string
The format of the file that contains the IPSet.
location This property is required. string
The URI of the file that contains the IPSet.
activate boolean
Indicates whether or not GuardDuty uses the IPSet .
detectorId 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 (_).

tags 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 This property is required. str
The format of the file that contains the IPSet.
location This property is required. 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 (_).

tags Sequence[TagArgs]

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 This property is required. String
The format of the file that contains the IPSet.
location This property is required. String
The URI of the file that contains the IPSet.
activate Boolean
Indicates whether or not GuardDuty uses the IPSet .
detectorId 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 (_).

tags 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:

AwsId string
Id string
The provider-assigned unique ID for this managed resource.
AwsId string
Id string
The provider-assigned unique ID for this managed resource.
awsId String
id String
The provider-assigned unique ID for this managed resource.
awsId string
id string
The provider-assigned unique ID for this managed resource.
aws_id str
id str
The provider-assigned unique ID for this managed resource.
awsId String
id String
The provider-assigned unique ID for this managed resource.

Supporting Types

Tag
, TagArgs

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi