@volcengine/pulumi
Version:
A Pulumi package for creating and managing volcengine cloud resources.
167 lines (166 loc) • 5.43 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Provides a resource to manage vpc prefix list
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as volcengine from "@volcengine/pulumi";
*
* const foo = new volcengine.vpc.PrefixList("foo", {
* description: "acc test description",
* ipVersion: "IPv4",
* maxEntries: 7,
* prefixListEntries: [
* {
* cidr: "192.168.4.0/28",
* description: "acc-test-1",
* },
* {
* cidr: "192.168.9.0/28",
* description: "acc-test-4",
* },
* {
* cidr: "192.168.8.0/28",
* description: "acc-test-5",
* },
* ],
* prefixListName: "acc-test-prefix",
* tags: [{
* key: "tf-key1",
* value: "tf-value1",
* }],
* });
* ```
*
* ## Import
*
* VpcPrefixList can be imported using the id, e.g.
*
* ```sh
* $ pulumi import volcengine:vpc/prefixList:PrefixList default resource_id
* ```
*/
export declare class PrefixList extends pulumi.CustomResource {
/**
* Get an existing PrefixList 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?: PrefixListState, opts?: pulumi.CustomResourceOptions): PrefixList;
/**
* Returns true if the given object is an instance of PrefixList. 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 PrefixList;
/**
* The description of the prefix list.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* IP version type. Possible values:
* IPv4 (default): IPv4 type.
* IPv6: IPv6 type.
*/
readonly ipVersion: pulumi.Output<string>;
/**
* Maximum number of entries, which is the maximum number of entries that can be added to the prefix list. The value range is 1 to 200.
*/
readonly maxEntries: pulumi.Output<number>;
/**
* Collection of resources associated with VPC prefix list.
*/
readonly prefixListAssociations: pulumi.Output<outputs.vpc.PrefixListPrefixListAssociation[]>;
/**
* Prefix list entry list.
*/
readonly prefixListEntries: pulumi.Output<outputs.vpc.PrefixListPrefixListEntry[] | undefined>;
/**
* The name of the prefix list.
*/
readonly prefixListName: pulumi.Output<string>;
/**
* Tags.
*/
readonly tags: pulumi.Output<outputs.vpc.PrefixListTag[] | undefined>;
/**
* Create a PrefixList 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: PrefixListArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering PrefixList resources.
*/
export interface PrefixListState {
/**
* The description of the prefix list.
*/
description?: pulumi.Input<string>;
/**
* IP version type. Possible values:
* IPv4 (default): IPv4 type.
* IPv6: IPv6 type.
*/
ipVersion?: pulumi.Input<string>;
/**
* Maximum number of entries, which is the maximum number of entries that can be added to the prefix list. The value range is 1 to 200.
*/
maxEntries?: pulumi.Input<number>;
/**
* Collection of resources associated with VPC prefix list.
*/
prefixListAssociations?: pulumi.Input<pulumi.Input<inputs.vpc.PrefixListPrefixListAssociation>[]>;
/**
* Prefix list entry list.
*/
prefixListEntries?: pulumi.Input<pulumi.Input<inputs.vpc.PrefixListPrefixListEntry>[]>;
/**
* The name of the prefix list.
*/
prefixListName?: pulumi.Input<string>;
/**
* Tags.
*/
tags?: pulumi.Input<pulumi.Input<inputs.vpc.PrefixListTag>[]>;
}
/**
* The set of arguments for constructing a PrefixList resource.
*/
export interface PrefixListArgs {
/**
* The description of the prefix list.
*/
description?: pulumi.Input<string>;
/**
* IP version type. Possible values:
* IPv4 (default): IPv4 type.
* IPv6: IPv6 type.
*/
ipVersion?: pulumi.Input<string>;
/**
* Maximum number of entries, which is the maximum number of entries that can be added to the prefix list. The value range is 1 to 200.
*/
maxEntries: pulumi.Input<number>;
/**
* Prefix list entry list.
*/
prefixListEntries?: pulumi.Input<pulumi.Input<inputs.vpc.PrefixListPrefixListEntry>[]>;
/**
* The name of the prefix list.
*/
prefixListName?: pulumi.Input<string>;
/**
* Tags.
*/
tags?: pulumi.Input<pulumi.Input<inputs.vpc.PrefixListTag>[]>;
}