2.233.0

interface CfnIPSetMixinProps

LanguageType name
.NETAmazon.CDK.Mixins.Preview.AWS.GuardDuty.Mixins.CfnIPSetMixinProps
Gogithub.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsguardduty/mixins#CfnIPSetMixinProps
Javasoftware.amazon.awscdk.mixins.preview.services.guardduty.mixins.CfnIPSetMixinProps
Pythonaws_cdk.mixins_preview.aws_guardduty.mixins.CfnIPSetMixinProps
TypeScript @aws-cdk/mixins-preview » aws_guardduty » mixins » CfnIPSetMixinProps

Properties for CfnIPSetPropsMixin.

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 { mixins as guardduty_mixins } from '@aws-cdk/mixins-preview/aws-guardduty';
const cfnIPSetMixinProps: guardduty_mixins.CfnIPSetMixinProps = {
  activate: false,
  detectorId: 'detectorId',
  expectedBucketOwner: 'expectedBucketOwner',
  format: 'format',
  location: 'location',
  name: 'name',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

NameTypeDescription
activate?boolean | IResolvableA boolean value that determines if GuardDuty can start using this list for custom threat detection.
detectorId?stringThe unique ID of the detector of the GuardDuty account for which you want to create an IPSet.
expectedBucketOwner?stringThe AWS account ID that owns the Amazon S3 bucket specified in the Location field.
format?stringThe format of the file that contains the IPSet.
location?stringThe URI of the file that contains the IPSet.
name?stringThe user-friendly name to identify the IPSet.
tags?CfnTag[]The tags to be added to a new threat entity set resource.

activate?

Type: boolean | IResolvable (optional)

A boolean value that determines if GuardDuty can start using this list for custom threat detection.

For GuardDuty to prevent generating findings based on an activity associated with these entries, this list must be active.

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

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.

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

expectedBucketOwner?

Type: string (optional)

The AWS account ID that owns the Amazon S3 bucket specified in the Location field.

When you provide this account ID, GuardDuty will validate that the S3 bucket belongs to this account. If you don't specify an account ID owner, GuardDuty doesn't perform any validation.

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

format?

Type: string (optional)

The format of the file that contains the IPSet.

For information about supported formats, see List formats in the Amazon GuardDuty User Guide .

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

location?

Type: string (optional)

The URI of the file that contains the IPSet.

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

name?

Type: string (optional)

The user-friendly name to identify the IPSet.

The name of your list must be unique within an AWS account and Region. Valid characters are alphanumeric, whitespace, dash (-), and underscores (_).

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

tags?

Type: CfnTag[] (optional)

The tags to be added to a new threat entity set resource.

Each tag consists of a key and an optional value, both of which you define.

For more information, see Tag .

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

← PreviousNext →