@pulumi/cloudngfwaws
Version:
A Pulumi package for creating and managing Cloud NGFW for AWS resources.
192 lines (191 loc) • 5.67 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
* Resource for NGFW log profile manipulation.
*
* ## Admin Permission Type
*
* * `Firewall`
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
* import * as cloudngfwaws from "@pulumi/cloudngfwaws";
*
* const exampleVpc = new aws.index.Vpc("example", {
* cidrBlock: "172.16.0.0/16",
* tags: {
* name: "tf-example",
* },
* });
* const subnet1 = new aws.index.Subnet("subnet1", {
* vpcId: myVpc.id,
* cidrBlock: "172.16.10.0/24",
* availabilityZone: "us-west-2a",
* tags: {
* name: "tf-example",
* },
* });
* const subnet2 = new aws.index.Subnet("subnet2", {
* vpcId: myVpc.id,
* cidrBlock: "172.16.20.0/24",
* availabilityZone: "us-west-2b",
* tags: {
* name: "tf-example",
* },
* });
* const x = new cloudngfwaws.Ngfw("x", {
* name: "example-instance",
* vpcId: exampleVpc.id,
* accountId: "12345678",
* description: "Example description",
* endpointMode: "ServiceManaged",
* subnetMappings: [
* {
* subnetId: subnet1.id,
* },
* {
* subnetId: subnet2.id,
* },
* ],
* rulestack: "example-rulestack",
* tags: {
* Foo: "bar",
* },
* });
* const example = new cloudngfwaws.NgfwLogProfile("example", {
* ngfw: x.name,
* accountId: x.accountId,
* logDestinations: [
* {
* destinationType: "S3",
* destination: "my-s3-bucket",
* logType: "TRAFFIC",
* },
* {
* destinationType: "CloudWatchLogs",
* destination: "panw-log-group",
* logType: "THREAT",
* },
* ],
* });
* ```
*
* ## Import
*
* import name is <account_id>:<ngfw>
*
* ```sh
* $ pulumi import cloudngfwaws:index/ngfwLogProfile:NgfwLogProfile example 12345678:example-instance
* ```
*/
export declare class NgfwLogProfile extends pulumi.CustomResource {
/**
* Get an existing NgfwLogProfile resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: NgfwLogProfileState, opts?: pulumi.CustomResourceOptions): NgfwLogProfile;
/**
* Returns true if the given object is an instance of NgfwLogProfile. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is NgfwLogProfile;
/**
* The unique ID of the account.
*/
readonly accountId: pulumi.Output<string>;
/**
* Enable advanced threat logging.
*/
readonly advancedThreatLog: pulumi.Output<boolean | undefined>;
/**
* The CloudWatch metric namespace.
*/
readonly cloudWatchMetricNamespace: pulumi.Output<string | undefined>;
/**
* Cloudwatch metric fields.
*/
readonly cloudwatchMetricFields: pulumi.Output<string[] | undefined>;
/**
* List of log destinations.
*/
readonly logDestinations: pulumi.Output<outputs.NgfwLogProfileLogDestination[]>;
/**
* The name of the NGFW.
*/
readonly ngfw: pulumi.Output<string>;
/**
* Create a NgfwLogProfile resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: NgfwLogProfileArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering NgfwLogProfile resources.
*/
export interface NgfwLogProfileState {
/**
* The unique ID of the account.
*/
accountId?: pulumi.Input<string>;
/**
* Enable advanced threat logging.
*/
advancedThreatLog?: pulumi.Input<boolean>;
/**
* The CloudWatch metric namespace.
*/
cloudWatchMetricNamespace?: pulumi.Input<string>;
/**
* Cloudwatch metric fields.
*/
cloudwatchMetricFields?: pulumi.Input<pulumi.Input<string>[]>;
/**
* List of log destinations.
*/
logDestinations?: pulumi.Input<pulumi.Input<inputs.NgfwLogProfileLogDestination>[]>;
/**
* The name of the NGFW.
*/
ngfw?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a NgfwLogProfile resource.
*/
export interface NgfwLogProfileArgs {
/**
* The unique ID of the account.
*/
accountId: pulumi.Input<string>;
/**
* Enable advanced threat logging.
*/
advancedThreatLog?: pulumi.Input<boolean>;
/**
* The CloudWatch metric namespace.
*/
cloudWatchMetricNamespace?: pulumi.Input<string>;
/**
* Cloudwatch metric fields.
*/
cloudwatchMetricFields?: pulumi.Input<pulumi.Input<string>[]>;
/**
* List of log destinations.
*/
logDestinations: pulumi.Input<pulumi.Input<inputs.NgfwLogProfileLogDestination>[]>;
/**
* The name of the NGFW.
*/
ngfw: pulumi.Input<string>;
}