IPSet
Provides a resource to manage a GuardDuty IPSet.
Note: Currently in GuardDuty, users from member accounts cannot upload and further manage IPSets. IPSets that are uploaded by the master account are imposed on GuardDuty functionality in its member accounts. See the GuardDuty API Documentation
Example Usage
using Pulumi;
using Aws = Pulumi.Aws;
class MyStack : Stack
{
public MyStack()
{
var master = new Aws.GuardDuty.Detector("master", new Aws.GuardDuty.DetectorArgs
{
Enable = true,
});
var bucket = new Aws.S3.Bucket("bucket", new Aws.S3.BucketArgs
{
Acl = "private",
});
var myIPSetBucketObject = new Aws.S3.BucketObject("myIPSetBucketObject", new Aws.S3.BucketObjectArgs
{
Acl = "public-read",
Bucket = bucket.Id,
Content = @"10.0.0.0/8
",
Key = "MyIPSet",
});
var myIPSetIPSet = new Aws.GuardDuty.IPSet("myIPSetIPSet", new Aws.GuardDuty.IPSetArgs
{
Activate = true,
DetectorId = master.Id,
Format = "TXT",
Location = Output.Tuple(myIPSetBucketObject.Bucket, myIPSetBucketObject.Key).Apply(values =>
{
var bucket = values.Item1;
var key = values.Item2;
return $"https://s3.amazonaws.com/{bucket}/{key}";
}),
});
}
}
package main
import (
"fmt"
"github.com/pulumi/pulumi-aws/sdk/v2/go/aws/guardduty"
"github.com/pulumi/pulumi-aws/sdk/v2/go/aws/s3"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
master, err := guardduty.NewDetector(ctx, "master", &guardduty.DetectorArgs{
Enable: pulumi.Bool(true),
})
if err != nil {
return err
}
bucket, err := s3.NewBucket(ctx, "bucket", &s3.BucketArgs{
Acl: pulumi.String("private"),
})
if err != nil {
return err
}
myIPSetBucketObject, err := s3.NewBucketObject(ctx, "myIPSetBucketObject", &s3.BucketObjectArgs{
Acl: pulumi.String("public-read"),
Bucket: bucket.ID(),
Content: pulumi.String(fmt.Sprintf("%v%v", "10.0.0.0/8\n", "\n")),
Key: pulumi.String("MyIPSet"),
})
if err != nil {
return err
}
_, err = guardduty.NewIPSet(ctx, "myIPSetIPSet", &guardduty.IPSetArgs{
Activate: pulumi.Bool(true),
DetectorId: master.ID(),
Format: pulumi.String("TXT"),
Location: pulumi.All(myIPSetBucketObject.Bucket, myIPSetBucketObject.Key).ApplyT(func(_args []interface{}) (string, error) {
bucket := _args[0].(string)
key := _args[1].(string)
return fmt.Sprintf("%v%v%v%v", "https://s3.amazonaws.com/", bucket, "/", key), nil
}).(pulumi.StringOutput),
})
if err != nil {
return err
}
return nil
})
}import pulumi
import pulumi_aws as aws
master = aws.guardduty.Detector("master", enable=True)
bucket = aws.s3.Bucket("bucket", acl="private")
my_ip_set_bucket_object = aws.s3.BucketObject("myIPSetBucketObject",
acl="public-read",
bucket=bucket.id,
content="""10.0.0.0/8
""",
key="MyIPSet")
my_ip_set_ip_set = aws.guardduty.IPSet("myIPSetIPSet",
activate=True,
detector_id=master.id,
format="TXT",
location=pulumi.Output.all(my_ip_set_bucket_object.bucket, my_ip_set_bucket_object.key).apply(lambda bucket, key: f"https://s3.amazonaws.com/{bucket}/{key}"))import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const master = new aws.guardduty.Detector("master", {
enable: true,
});
const bucket = new aws.s3.Bucket("bucket", {
acl: "private",
});
const myIPSetBucketObject = new aws.s3.BucketObject("MyIPSet", {
acl: "public-read",
bucket: bucket.id,
content: "10.0.0.0/8\n",
key: "MyIPSet",
});
const myIPSetIPSet = new aws.guardduty.IPSet("MyIPSet", {
activate: true,
detectorId: master.id,
format: "TXT",
location: pulumi.interpolate`https://s3.amazonaws.com/${myIPSetBucketObject.bucket}/${myIPSetBucketObject.key}`,
});Create a IPSet Resource
new IPSet(name: string, args: IPSetArgs, opts?: CustomResourceOptions);def IPSet(resource_name, opts=None, activate=None, detector_id=None, format=None, location=None, name=None, tags=None, __props__=None);public IPSet(string name, IPSetArgs args, CustomResourceOptions? opts = null)- name string
- The unique name of the resource.
- args IPSetArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- opts ResourceOptions
- A bag of options that control this resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args IPSetArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args IPSetArgs
- The arguments to resource properties.
- opts 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 Programming Model docs.
Inputs
The IPSet resource accepts the following input properties:
- Activate bool
Specifies whether GuardDuty is to start using the uploaded IPSet.
- Detector
Id string The detector ID of the GuardDuty.
- Format string
The format of the file that contains the IPSet. Valid values:
TXT|STIX|OTX_CSV|ALIEN_VAULT|PROOF_POINT|FIRE_EYE- Location string
The URI of the file that contains the IPSet.
- Name string
The friendly name to identify the IPSet.
- Dictionary<string, string>
Key-value map of resource tags.
- Activate bool
Specifies whether GuardDuty is to start using the uploaded IPSet.
- Detector
Id string The detector ID of the GuardDuty.
- Format string
The format of the file that contains the IPSet. Valid values:
TXT|STIX|OTX_CSV|ALIEN_VAULT|PROOF_POINT|FIRE_EYE- Location string
The URI of the file that contains the IPSet.
- Name string
The friendly name to identify the IPSet.
- map[string]string
Key-value map of resource tags.
- activate boolean
Specifies whether GuardDuty is to start using the uploaded IPSet.
- detector
Id string The detector ID of the GuardDuty.
- format string
The format of the file that contains the IPSet. Valid values:
TXT|STIX|OTX_CSV|ALIEN_VAULT|PROOF_POINT|FIRE_EYE- location string
The URI of the file that contains the IPSet.
- name string
The friendly name to identify the IPSet.
- {[key: string]: string}
Key-value map of resource tags.
- activate bool
Specifies whether GuardDuty is to start using the uploaded IPSet.
- detector_
id str The detector ID of the GuardDuty.
- format str
The format of the file that contains the IPSet. Valid values:
TXT|STIX|OTX_CSV|ALIEN_VAULT|PROOF_POINT|FIRE_EYE- location str
The URI of the file that contains the IPSet.
- name str
The friendly name to identify the IPSet.
- Dict[str, str]
Key-value map of resource tags.
Outputs
All input properties are implicitly available as output properties. Additionally, the IPSet resource produces the following output properties:
Look up an Existing IPSet Resource
Get an existing IPSet resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: IPSetState, opts?: CustomResourceOptions): IPSetstatic get(resource_name, id, opts=None, activate=None, arn=None, detector_id=None, format=None, location=None, name=None, tags=None, __props__=None);func GetIPSet(ctx *Context, name string, id IDInput, state *IPSetState, opts ...ResourceOption) (*IPSet, error)public static IPSet Get(string name, Input<string> id, IPSetState? state, CustomResourceOptions? opts = null)- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
The following state arguments are supported:
- Activate bool
Specifies whether GuardDuty is to start using the uploaded IPSet.
- Arn string
Amazon Resource Name (ARN) of the GuardDuty IPSet.
- Detector
Id string The detector ID of the GuardDuty.
- Format string
The format of the file that contains the IPSet. Valid values:
TXT|STIX|OTX_CSV|ALIEN_VAULT|PROOF_POINT|FIRE_EYE- Location string
The URI of the file that contains the IPSet.
- Name string
The friendly name to identify the IPSet.
- Dictionary<string, string>
Key-value map of resource tags.
- Activate bool
Specifies whether GuardDuty is to start using the uploaded IPSet.
- Arn string
Amazon Resource Name (ARN) of the GuardDuty IPSet.
- Detector
Id string The detector ID of the GuardDuty.
- Format string
The format of the file that contains the IPSet. Valid values:
TXT|STIX|OTX_CSV|ALIEN_VAULT|PROOF_POINT|FIRE_EYE- Location string
The URI of the file that contains the IPSet.
- Name string
The friendly name to identify the IPSet.
- map[string]string
Key-value map of resource tags.
- activate boolean
Specifies whether GuardDuty is to start using the uploaded IPSet.
- arn string
Amazon Resource Name (ARN) of the GuardDuty IPSet.
- detector
Id string The detector ID of the GuardDuty.
- format string
The format of the file that contains the IPSet. Valid values:
TXT|STIX|OTX_CSV|ALIEN_VAULT|PROOF_POINT|FIRE_EYE- location string
The URI of the file that contains the IPSet.
- name string
The friendly name to identify the IPSet.
- {[key: string]: string}
Key-value map of resource tags.
- activate bool
Specifies whether GuardDuty is to start using the uploaded IPSet.
- arn str
Amazon Resource Name (ARN) of the GuardDuty IPSet.
- detector_
id str The detector ID of the GuardDuty.
- format str
The format of the file that contains the IPSet. Valid values:
TXT|STIX|OTX_CSV|ALIEN_VAULT|PROOF_POINT|FIRE_EYE- location str
The URI of the file that contains the IPSet.
- name str
The friendly name to identify the IPSet.
- Dict[str, str]
Key-value map of resource tags.
Package Details
- Repository
- https://github.com/pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
awsTerraform Provider.