software.amazon.awscdk.services.guardduty

Class CfnIPSet

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.guardduty.CfnIPSet

All Implemented Interfaces:

IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:35.413Z")
 @Stability(value=Stable)
public class CfnIPSet
extends CfnResource
implements IInspectable

A CloudFormation `AWS::GuardDuty::IPSet`.

The AWS::GuardDuty::IPSet resource specifies a new IPSet . An IPSet is a list of trusted IP addresses from which secure communication is allowed with AWS infrastructure and applications.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.guardduty.*;
 CfnIPSet cfnIPSet = CfnIPSet.Builder.create(this, "MyCfnIPSet")
         .activate(false)
         .detectorId("detectorId")
         .format("format")
         .location("location")
         // the properties below are optional
         .name("name")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnIPSet.Builder A fluent builder for CfnIPSet.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnIPSet(Construct scope, String id, CfnIPSetProps props) Create a new `AWS::GuardDuty::IPSet`.
protected	CfnIPSet(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnIPSet(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
Object	getActivate() Indicates whether or not uses the `IPSet` .
protected Map<String,Object>	getCfnProperties()
String	getDetectorId() The unique ID of the detector of the GuardDuty account that you want to create an IPSet for.
String	getFormat() The format of the file that contains the IPSet.
String	getLocation() The URI of the file that contains the IPSet.
String	getName() The user-friendly name to identify the IPSet.
TagManager	getTags() The tags to be added to a new IP set resource.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setActivate(Boolean value) Indicates whether or not uses the `IPSet` .
void	setActivate(IResolvable value) Indicates whether or not uses the `IPSet` .
void	setDetectorId(String value) The unique ID of the detector of the GuardDuty account that you want to create an IPSet for.
void	setFormat(String value) The format of the file that contains the IPSet.
void	setLocation(String value) The URI of the file that contains the IPSet.
void	setName(String value) The user-friendly name to identify the IPSet.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnIPSet

protected CfnIPSet(software.amazon.jsii.JsiiObjectRef objRef)

CfnIPSet

protected CfnIPSet(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnIPSet

@Stability(value=Stable)
public CfnIPSet(@NotNull
                                         Construct scope,
                                         @NotNull
                                         String id,
                                         @NotNull
                                         CfnIPSetProps props)

Create a new `AWS::GuardDuty::IPSet`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

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 .

getActivate

@Stability(value=Stable)
 @NotNull
public Object getActivate()

Indicates whether or not uses the `IPSet` .

setActivate

@Stability(value=Stable)
public void setActivate(@NotNull
                                                 Boolean value)

Indicates whether or not uses the `IPSet` .

setActivate

@Stability(value=Stable)
public void setActivate(@NotNull
                                                 IResolvable value)

Indicates whether or not uses the `IPSet` .

getDetectorId

@Stability(value=Stable)
 @NotNull
public String getDetectorId()

The unique ID of the detector of the GuardDuty account that you want to create an IPSet for.

setDetectorId

@Stability(value=Stable)
public void setDetectorId(@NotNull
                                                   String value)

The unique ID of the detector of the GuardDuty account that you want to create an IPSet for.

getFormat

@Stability(value=Stable)
 @NotNull
public String getFormat()

The format of the file that contains the IPSet.

setFormat

@Stability(value=Stable)
public void setFormat(@NotNull
                                               String value)

The format of the file that contains the IPSet.

getLocation

@Stability(value=Stable)
 @NotNull
public String getLocation()

The URI of the file that contains the IPSet.

setLocation

@Stability(value=Stable)
public void setLocation(@NotNull
                                                 String value)

The URI of the file that contains the IPSet.

getName

@Stability(value=Stable)
 @Nullable
public String getName()

The user-friendly name to identify the IPSet.

Allowed characters are alphanumerics, spaces, hyphens (-), and underscores (_).

setName

@Stability(value=Stable)
public void setName(@Nullable
                                             String value)

The user-friendly name to identify the IPSet.

Allowed characters are alphanumerics, spaces, hyphens (-), and underscores (_).