@pulumi/scm
Version:
A Pulumi package for managing resources on Strata Cloud Manager.. Based on terraform-provider-scm: version v0.2.1
141 lines (140 loc) • 4.5 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* BgpAuthProfile data source
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scm from "@pulumi/scm";
*
* // Look up BGP Auth Profile by its ID.
* const scmBgpAuthProfileDs = scm.getBgpAuthProfile({
* id: "f2ffd626-e92d-4de6-8ac1-37742fe80fb9",
* });
* export const bgpAuthProfileDataSourceResults = {
* id: scmBgpAuthProfileDs.then(scmBgpAuthProfileDs => scmBgpAuthProfileDs.id),
* name: scmBgpAuthProfileDs.then(scmBgpAuthProfileDs => scmBgpAuthProfileDs.name),
* secret: scmBgpAuthProfileDs.then(scmBgpAuthProfileDs => scmBgpAuthProfileDs.secret),
* folder: scmBgpAuthProfileDs.then(scmBgpAuthProfileDs => scmBgpAuthProfileDs.folder),
* };
* ```
*/
export declare function getBgpAuthProfile(args: GetBgpAuthProfileArgs, opts?: pulumi.InvokeOptions): Promise<GetBgpAuthProfileResult>;
/**
* A collection of arguments for invoking getBgpAuthProfile.
*/
export interface GetBgpAuthProfileArgs {
/**
* The device in which the resource is defined
* > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
*/
device?: string;
/**
* The folder in which the resource is defined
* > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
*/
folder?: string;
/**
* UUID of the resource
*/
id: string;
/**
* Profile name
*/
name?: string;
/**
* The snippet in which the resource is defined
* > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
*/
snippet?: string;
}
/**
* A collection of values returned by getBgpAuthProfile.
*/
export interface GetBgpAuthProfileResult {
/**
* The device in which the resource is defined
* > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
*/
readonly device: string;
/**
* Map of sensitive values returned from the API.
*/
readonly encryptedValues: {
[key: string]: string;
};
/**
* The folder in which the resource is defined
* > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
*/
readonly folder: string;
/**
* UUID of the resource
*/
readonly id: string;
/**
* Profile name
*/
readonly name: string;
/**
* BGP authentication key
*/
readonly secret: string;
/**
* The snippet in which the resource is defined
* > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
*/
readonly snippet: string;
readonly tfid: string;
}
/**
* BgpAuthProfile data source
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scm from "@pulumi/scm";
*
* // Look up BGP Auth Profile by its ID.
* const scmBgpAuthProfileDs = scm.getBgpAuthProfile({
* id: "f2ffd626-e92d-4de6-8ac1-37742fe80fb9",
* });
* export const bgpAuthProfileDataSourceResults = {
* id: scmBgpAuthProfileDs.then(scmBgpAuthProfileDs => scmBgpAuthProfileDs.id),
* name: scmBgpAuthProfileDs.then(scmBgpAuthProfileDs => scmBgpAuthProfileDs.name),
* secret: scmBgpAuthProfileDs.then(scmBgpAuthProfileDs => scmBgpAuthProfileDs.secret),
* folder: scmBgpAuthProfileDs.then(scmBgpAuthProfileDs => scmBgpAuthProfileDs.folder),
* };
* ```
*/
export declare function getBgpAuthProfileOutput(args: GetBgpAuthProfileOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetBgpAuthProfileResult>;
/**
* A collection of arguments for invoking getBgpAuthProfile.
*/
export interface GetBgpAuthProfileOutputArgs {
/**
* The device in which the resource is defined
* > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
*/
device?: pulumi.Input<string>;
/**
* The folder in which the resource is defined
* > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
*/
folder?: pulumi.Input<string>;
/**
* UUID of the resource
*/
id: pulumi.Input<string>;
/**
* Profile name
*/
name?: pulumi.Input<string>;
/**
* The snippet in which the resource is defined
* > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
*/
snippet?: pulumi.Input<string>;
}