@pulumi/cloudngfwaws
Version:
A Pulumi package for creating and managing Cloud NGFW for AWS resources.
346 lines (345 loc) • 10.3 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
* import * as cloudngfwaws from "@pulumi/cloudngfwaws";
*
* const rs = new cloudngfwaws.CommitRulestack("rs", {rulestack: "my-rulestack"});
* 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 example = new cloudngfwaws.Ngfw("example", {
* name: "example-instance",
* description: "Example description",
* endpoints: [{
* subnetId: subnet1.id,
* mode: "ServiceManaged",
* vpcId: exampleVpc.id,
* accountId: "12345678",
* }],
* rulestack: rs.rulestack,
* tags: {
* Foo: "bar",
* },
* });
* const subnet2 = new aws.index.Subnet("subnet2", {
* vpcId: myVpc.id,
* cidrBlock: "172.16.20.0/24",
* availabilityZone: "us-west-2b",
* tags: {
* name: "tf-example",
* },
* });
* ```
*
* ## Import
*
* import name is <account_id>:<name>
*
* ```sh
* $ pulumi import cloudngfwaws:index/ngfw:Ngfw example 12345678:example-instance
* ```
*/
export declare class Ngfw extends pulumi.CustomResource {
/**
* Get an existing Ngfw 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?: NgfwState, opts?: pulumi.CustomResourceOptions): Ngfw;
/**
* Returns true if the given object is an instance of Ngfw. 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 Ngfw;
/**
* The description.
*/
readonly accountId: pulumi.Output<string | undefined>;
/**
* The list of allowed accounts for this NGFW.
*/
readonly allowlistAccounts: pulumi.Output<string[] | undefined>;
/**
* App-ID version number.
*/
readonly appIdVersion: pulumi.Output<string>;
/**
* Automatic App-ID upgrade version number. Defaults to `true`.
*/
readonly automaticUpgradeAppIdVersion: pulumi.Output<boolean | undefined>;
/**
* The list of availability zones for this NGFW.
*/
readonly azLists: pulumi.Output<string[]>;
/**
* Enables or disables change protection for the NGFW.
*/
readonly changeProtections: pulumi.Output<string[]>;
/**
* The update token.
*/
readonly deploymentUpdateToken: pulumi.Output<string>;
/**
* The NGFW description.
*/
readonly description: pulumi.Output<string | undefined>;
readonly egressNats: pulumi.Output<outputs.NgfwEgressNat[]>;
/**
* Set endpoint mode from the following options. Valid values are `ServiceManaged` or `CustomerManaged`.
*/
readonly endpointMode: pulumi.Output<string | undefined>;
/**
* The endpoint service name.
*/
readonly endpointServiceName: pulumi.Output<string>;
readonly endpoints: pulumi.Output<outputs.NgfwEndpoint[] | undefined>;
/**
* The Firewall ID.
*/
readonly firewallId: pulumi.Output<string>;
/**
* The global rulestack for this NGFW.
*/
readonly globalRulestack: pulumi.Output<string | undefined>;
/**
* The link ID.
*/
readonly linkId: pulumi.Output<string>;
/**
* The link status.
*/
readonly linkStatus: pulumi.Output<string>;
/**
* Share NGFW with Multiple VPCs. This feature can be enabled only if the endpointMode is CustomerManaged.
*/
readonly multiVpc: pulumi.Output<boolean>;
/**
* The NGFW name.
*/
readonly name: pulumi.Output<string>;
readonly privateAccesses: pulumi.Output<outputs.NgfwPrivateAccess[]>;
/**
* The rulestack for this NGFW.
*/
readonly rulestack: pulumi.Output<string | undefined>;
readonly statuses: pulumi.Output<outputs.NgfwStatus[]>;
/**
* Subnet mappings.
*/
readonly subnetMappings: pulumi.Output<outputs.NgfwSubnetMapping[] | undefined>;
/**
* The tags.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
}>;
/**
* The update token.
*/
readonly updateToken: pulumi.Output<string>;
readonly userIds: pulumi.Output<outputs.NgfwUserId[]>;
/**
* The VPC ID for the NGFW.
*/
readonly vpcId: pulumi.Output<string | undefined>;
/**
* Create a Ngfw 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: NgfwArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Ngfw resources.
*/
export interface NgfwState {
/**
* The description.
*/
accountId?: pulumi.Input<string>;
/**
* The list of allowed accounts for this NGFW.
*/
allowlistAccounts?: pulumi.Input<pulumi.Input<string>[]>;
/**
* App-ID version number.
*/
appIdVersion?: pulumi.Input<string>;
/**
* Automatic App-ID upgrade version number. Defaults to `true`.
*/
automaticUpgradeAppIdVersion?: pulumi.Input<boolean>;
/**
* The list of availability zones for this NGFW.
*/
azLists?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Enables or disables change protection for the NGFW.
*/
changeProtections?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The update token.
*/
deploymentUpdateToken?: pulumi.Input<string>;
/**
* The NGFW description.
*/
description?: pulumi.Input<string>;
egressNats?: pulumi.Input<pulumi.Input<inputs.NgfwEgressNat>[]>;
/**
* Set endpoint mode from the following options. Valid values are `ServiceManaged` or `CustomerManaged`.
*/
endpointMode?: pulumi.Input<string>;
/**
* The endpoint service name.
*/
endpointServiceName?: pulumi.Input<string>;
endpoints?: pulumi.Input<pulumi.Input<inputs.NgfwEndpoint>[]>;
/**
* The Firewall ID.
*/
firewallId?: pulumi.Input<string>;
/**
* The global rulestack for this NGFW.
*/
globalRulestack?: pulumi.Input<string>;
/**
* The link ID.
*/
linkId?: pulumi.Input<string>;
/**
* The link status.
*/
linkStatus?: pulumi.Input<string>;
/**
* Share NGFW with Multiple VPCs. This feature can be enabled only if the endpointMode is CustomerManaged.
*/
multiVpc?: pulumi.Input<boolean>;
/**
* The NGFW name.
*/
name?: pulumi.Input<string>;
privateAccesses?: pulumi.Input<pulumi.Input<inputs.NgfwPrivateAccess>[]>;
/**
* The rulestack for this NGFW.
*/
rulestack?: pulumi.Input<string>;
statuses?: pulumi.Input<pulumi.Input<inputs.NgfwStatus>[]>;
/**
* Subnet mappings.
*/
subnetMappings?: pulumi.Input<pulumi.Input<inputs.NgfwSubnetMapping>[]>;
/**
* The tags.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The update token.
*/
updateToken?: pulumi.Input<string>;
userIds?: pulumi.Input<pulumi.Input<inputs.NgfwUserId>[]>;
/**
* The VPC ID for the NGFW.
*/
vpcId?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Ngfw resource.
*/
export interface NgfwArgs {
/**
* The description.
*/
accountId?: pulumi.Input<string>;
/**
* The list of allowed accounts for this NGFW.
*/
allowlistAccounts?: pulumi.Input<pulumi.Input<string>[]>;
/**
* App-ID version number.
*/
appIdVersion?: pulumi.Input<string>;
/**
* Automatic App-ID upgrade version number. Defaults to `true`.
*/
automaticUpgradeAppIdVersion?: pulumi.Input<boolean>;
/**
* The list of availability zones for this NGFW.
*/
azLists: pulumi.Input<pulumi.Input<string>[]>;
/**
* Enables or disables change protection for the NGFW.
*/
changeProtections?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The NGFW description.
*/
description?: pulumi.Input<string>;
egressNats?: pulumi.Input<pulumi.Input<inputs.NgfwEgressNat>[]>;
/**
* Set endpoint mode from the following options. Valid values are `ServiceManaged` or `CustomerManaged`.
*/
endpointMode?: pulumi.Input<string>;
endpoints?: pulumi.Input<pulumi.Input<inputs.NgfwEndpoint>[]>;
/**
* The global rulestack for this NGFW.
*/
globalRulestack?: pulumi.Input<string>;
/**
* The link ID.
*/
linkId?: pulumi.Input<string>;
/**
* Share NGFW with Multiple VPCs. This feature can be enabled only if the endpointMode is CustomerManaged.
*/
multiVpc?: pulumi.Input<boolean>;
/**
* The NGFW name.
*/
name?: pulumi.Input<string>;
privateAccesses?: pulumi.Input<pulumi.Input<inputs.NgfwPrivateAccess>[]>;
/**
* The rulestack for this NGFW.
*/
rulestack?: pulumi.Input<string>;
/**
* Subnet mappings.
*/
subnetMappings?: pulumi.Input<pulumi.Input<inputs.NgfwSubnetMapping>[]>;
/**
* The tags.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
userIds?: pulumi.Input<pulumi.Input<inputs.NgfwUserId>[]>;
/**
* The VPC ID for the NGFW.
*/
vpcId?: pulumi.Input<string>;
}