interface CfnIPSetProps
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.GuardDuty.CfnIPSetProps |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awsguardduty#CfnIPSetProps |
 Java | software.amazon.awscdk.services.guardduty.CfnIPSetProps |
 Python | aws_cdk.aws_guardduty.CfnIPSetProps |
 TypeScript | aws-cdk-lib » aws_guardduty » CfnIPSetProps |
Properties for defining a CfnIPSet.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-ipset.html
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_guardduty as guardduty } from 'aws-cdk-lib';
const cfnIPSetProps: guardduty.CfnIPSetProps = {
format: 'format',
location: 'location',
// the properties below are optional
activate: false,
detectorId: 'detectorId',
name: 'name',
tags: [{
key: 'key',
value: 'value',
}],
};
Properties
| Name | Type | Description |
|---|---|---|
| format | string | The format of the file that contains the IPSet. |
| location | string | The URI of the file that contains the IPSet. |
| activate? | boolean | IResolvable | Indicates whether or not GuardDuty uses the IPSet . |
| detector | string | The unique ID of the detector of the GuardDuty account for which you want to create an IPSet. |
| name? | string | The user-friendly name to identify the IPSet. |
| tags? | Cfn[] | The tags to be added to a new IP set resource. |
format
Type:
string
The format of the file that contains the IPSet.
location
Type:
string
The URI of the file that contains the IPSet.
activate?
Type:
boolean | IResolvable
(optional)
Indicates whether or not GuardDuty uses the IPSet .
detectorId?
Type:
string
(optional)
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?
Type:
string
(optional)
The user-friendly name to identify the IPSet.
Allowed characters are alphanumeric, whitespace, dash (-), and underscores (_).
tags?
Type:
Cfn[]
(optional)
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 .