@pulumi/cloudngfwaws
Version:
A Pulumi package for creating and managing Cloud NGFW for AWS resources.
145 lines (144 loc) • 4.11 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Data source for retrieving prefix list information.
*
* ## Admin Permission Type
*
* * `Rulestack` (for `scope="Local"`)
* * `Global Rulestack` (for `scope="Global"`)
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as cloudngfwaws from "@pulumi/cloudngfwaws";
*
* const r = new cloudngfwaws.Rulestack("r", {
* name: "my-rulestack",
* scope: "Local",
* accountId: "12345",
* description: "Made by Pulumi",
* profileConfig: {
* antiSpyware: "BestPractice",
* },
* });
* const example = cloudngfwaws.getPrefixListOutput({
* rulestack: r.name,
* name: "foobar",
* });
* ```
*/
export declare function getPrefixList(args: GetPrefixListArgs, opts?: pulumi.InvokeOptions): Promise<GetPrefixListResult>;
/**
* A collection of arguments for invoking getPrefixList.
*/
export interface GetPrefixListArgs {
/**
* Retrieve either the candidate or running config. Valid values are `candidate` or `running`. Defaults to `candidate`.
*/
configType?: string;
/**
* The name.
*/
name: string;
/**
* The rulestack.
*/
rulestack: string;
/**
* The rulestack's scope. A local rulestack will require that you've retrieved a LRA JWT. A global rulestack will require that you've retrieved a GRA JWT. Valid values are `Local` or `Global`. Defaults to `Local`.
*/
scope?: string;
}
/**
* A collection of values returned by getPrefixList.
*/
export interface GetPrefixListResult {
/**
* The audit comment.
*/
readonly auditComment: string;
/**
* Retrieve either the candidate or running config. Valid values are `candidate` or `running`. Defaults to `candidate`.
*/
readonly configType?: string;
/**
* The description.
*/
readonly description: string;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
/**
* The name.
*/
readonly name: string;
/**
* The prefix list.
*/
readonly prefixLists: string[];
/**
* The rulestack.
*/
readonly rulestack: string;
/**
* The rulestack's scope. A local rulestack will require that you've retrieved a LRA JWT. A global rulestack will require that you've retrieved a GRA JWT. Valid values are `Local` or `Global`. Defaults to `Local`.
*/
readonly scope?: string;
/**
* The update token.
*/
readonly updateToken: string;
}
/**
* Data source for retrieving prefix list information.
*
* ## Admin Permission Type
*
* * `Rulestack` (for `scope="Local"`)
* * `Global Rulestack` (for `scope="Global"`)
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as cloudngfwaws from "@pulumi/cloudngfwaws";
*
* const r = new cloudngfwaws.Rulestack("r", {
* name: "my-rulestack",
* scope: "Local",
* accountId: "12345",
* description: "Made by Pulumi",
* profileConfig: {
* antiSpyware: "BestPractice",
* },
* });
* const example = cloudngfwaws.getPrefixListOutput({
* rulestack: r.name,
* name: "foobar",
* });
* ```
*/
export declare function getPrefixListOutput(args: GetPrefixListOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetPrefixListResult>;
/**
* A collection of arguments for invoking getPrefixList.
*/
export interface GetPrefixListOutputArgs {
/**
* Retrieve either the candidate or running config. Valid values are `candidate` or `running`. Defaults to `candidate`.
*/
configType?: pulumi.Input<string>;
/**
* The name.
*/
name: pulumi.Input<string>;
/**
* The rulestack.
*/
rulestack: pulumi.Input<string>;
/**
* The rulestack's scope. A local rulestack will require that you've retrieved a LRA JWT. A global rulestack will require that you've retrieved a GRA JWT. Valid values are `Local` or `Global`. Defaults to `Local`.
*/
scope?: pulumi.Input<string>;
}