CfnIPSetProps

class aws_cdk.aws_guardduty.CfnIPSetProps(*, format, location, activate=None, detector_id=None, name=None, tags=None)

Bases: object

Properties for defining a CfnIPSet.

Parameters:
  • format (str) – The format of the file that contains the IPSet.

  • location (str) – The URI of the file that contains the IPSet.

  • activate (Union[bool, IResolvable, None]) – Indicates whether or not GuardDuty uses the IPSet .

  • detector_id (Optional[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 (Optional[str]) – The user-friendly name to identify the IPSet. Allowed characters are alphanumeric, whitespace, dash (-), and underscores (_).

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – 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 .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-ipset.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_guardduty as guardduty

cfn_iPSet_props = guardduty.CfnIPSetProps(
    format="format",
    location="location",

    # the properties below are optional
    activate=False,
    detector_id="detectorId",
    name="name",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

activate

Indicates whether or not GuardDuty uses the IPSet .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-ipset.html#cfn-guardduty-ipset-activate

detector_id

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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-ipset.html#cfn-guardduty-ipset-detectorid

format

The format of the file that contains the IPSet.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-ipset.html#cfn-guardduty-ipset-format

location

The URI of the file that contains the IPSet.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-ipset.html#cfn-guardduty-ipset-location

name

The user-friendly name to identify the IPSet.

Allowed characters are alphanumeric, whitespace, dash (-), and underscores (_).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-ipset.html#cfn-guardduty-ipset-name

tags

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 .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-ipset.html#cfn-guardduty-ipset-tags