@pulumi/openstack
Version:
A Pulumi package for creating and managing OpenStack cloud resources.
177 lines (176 loc) • 6.17 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Manages a V2 Neutron BGP Peer resource within OpenStack.
*
* This resource allows you to configure a BGP peer that can be associated with a
* BGP speaker to exchange routing information.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as openstack from "@pulumi/openstack";
*
* const peer1 = new openstack.networking.BgpPeerV2("peer_1", {
* name: "bgp_peer_1",
* peerIp: "192.0.2.10",
* remoteAs: 65001,
* authType: "md5",
* password: "supersecret",
* });
* ```
*
* ## Import
*
* BGP peers can be imported using their ID:
*
* ```sh
* $ pulumi import openstack:networking/bgpPeerV2:BgpPeerV2 peer1 a1b2c3d4-e5f6-7890-abcd-1234567890ef
* ```
*/
export declare class BgpPeerV2 extends pulumi.CustomResource {
/**
* Get an existing BgpPeerV2 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?: BgpPeerV2State, opts?: pulumi.CustomResourceOptions): BgpPeerV2;
/**
* Returns true if the given object is an instance of BgpPeerV2. 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 BgpPeerV2;
/**
* The authentication type to use. Can be one of `none`
* or `md5`. Defaults to `none`. If set to not `none`, the `password` argument
* must also be provided. Changing this creates a new BGP peer.
*/
readonly authType: pulumi.Output<string | undefined>;
/**
* A name for the BGP peer.
*/
readonly name: pulumi.Output<string>;
/**
* The password used for MD5 authentication. Must be set
* only when `authType` is not `none`.
*/
readonly password: pulumi.Output<string | undefined>;
/**
* The IP address of the BGP peer. Must be a valid IP
* address. Changing this creates a new BGP peer.
*/
readonly peerIp: pulumi.Output<string>;
/**
* The region in which to obtain the V2 Networking client.
* A Networking client is needed to create a Neutron network. If omitted, the
* `region` argument of the provider is used. Changing this creates a new BGP
* peer.
*/
readonly region: pulumi.Output<string>;
/**
* The AS number of the BGP peer. Changing this
* creates a new BGP peer.
*/
readonly remoteAs: pulumi.Output<number>;
/**
* The tenant/project ID. Required if admin privileges
* are used. Changing this creates a new BGP peer.
*/
readonly tenantId: pulumi.Output<string>;
/**
* Create a BgpPeerV2 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: BgpPeerV2Args, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering BgpPeerV2 resources.
*/
export interface BgpPeerV2State {
/**
* The authentication type to use. Can be one of `none`
* or `md5`. Defaults to `none`. If set to not `none`, the `password` argument
* must also be provided. Changing this creates a new BGP peer.
*/
authType?: pulumi.Input<string>;
/**
* A name for the BGP peer.
*/
name?: pulumi.Input<string>;
/**
* The password used for MD5 authentication. Must be set
* only when `authType` is not `none`.
*/
password?: pulumi.Input<string>;
/**
* The IP address of the BGP peer. Must be a valid IP
* address. Changing this creates a new BGP peer.
*/
peerIp?: pulumi.Input<string>;
/**
* The region in which to obtain the V2 Networking client.
* A Networking client is needed to create a Neutron network. If omitted, the
* `region` argument of the provider is used. Changing this creates a new BGP
* peer.
*/
region?: pulumi.Input<string>;
/**
* The AS number of the BGP peer. Changing this
* creates a new BGP peer.
*/
remoteAs?: pulumi.Input<number>;
/**
* The tenant/project ID. Required if admin privileges
* are used. Changing this creates a new BGP peer.
*/
tenantId?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a BgpPeerV2 resource.
*/
export interface BgpPeerV2Args {
/**
* The authentication type to use. Can be one of `none`
* or `md5`. Defaults to `none`. If set to not `none`, the `password` argument
* must also be provided. Changing this creates a new BGP peer.
*/
authType?: pulumi.Input<string>;
/**
* A name for the BGP peer.
*/
name?: pulumi.Input<string>;
/**
* The password used for MD5 authentication. Must be set
* only when `authType` is not `none`.
*/
password?: pulumi.Input<string>;
/**
* The IP address of the BGP peer. Must be a valid IP
* address. Changing this creates a new BGP peer.
*/
peerIp: pulumi.Input<string>;
/**
* The region in which to obtain the V2 Networking client.
* A Networking client is needed to create a Neutron network. If omitted, the
* `region` argument of the provider is used. Changing this creates a new BGP
* peer.
*/
region?: pulumi.Input<string>;
/**
* The AS number of the BGP peer. Changing this
* creates a new BGP peer.
*/
remoteAs: pulumi.Input<number>;
/**
* The tenant/project ID. Required if admin privileges
* are used. Changing this creates a new BGP peer.
*/
tenantId?: pulumi.Input<string>;
}