@pulumi/scm
Version:
A Pulumi package for managing resources on Strata Cloud Manager.. Based on terraform-provider-scm: version v0.2.1
144 lines (143 loc) • 4.88 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "./types/output";
/**
* SyslogServerProfile data source
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scm from "@pulumi/scm";
*
* //
* // Data source to retrieve a single SCM Syslog Server Profile object by its ID.
* //
* // Replace the ID with the UUID of the SCM Syslog Server Profile you want to find.
* const scmSyslogServerProf = scm.getSyslogServerProfile({
* id: "69f7ee97-7c0a-416d-a28d-d45929851f6e",
* });
* export const scmSyslogServerProfileDetails = {
* profileId: scmSyslogServerProf.then(scmSyslogServerProf => scmSyslogServerProf.id),
* folder: scmSyslogServerProf.then(scmSyslogServerProf => scmSyslogServerProf.folder),
* name: scmSyslogServerProf.then(scmSyslogServerProf => scmSyslogServerProf.name),
* };
* ```
*/
export declare function getSyslogServerProfile(args: GetSyslogServerProfileArgs, opts?: pulumi.InvokeOptions): Promise<GetSyslogServerProfileResult>;
/**
* A collection of arguments for invoking getSyslogServerProfile.
*/
export interface GetSyslogServerProfileArgs {
/**
* 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;
/**
* The UUID of the syslog server profile
*/
id: string;
/**
* The name of the syslog server profile
*/
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 getSyslogServerProfile.
*/
export interface GetSyslogServerProfileResult {
/**
* The device in which the resource is defined
* > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
*/
readonly device: string;
/**
* The folder in which the resource is defined
* > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
*/
readonly folder: string;
/**
* Format
*/
readonly format: outputs.GetSyslogServerProfileFormat;
/**
* The UUID of the syslog server profile
*/
readonly id: string;
/**
* The name of the syslog server profile
*/
readonly name: string;
/**
* A list of syslog server configurations. At least one server is required.
*/
readonly servers: outputs.GetSyslogServerProfileServer[];
/**
* 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;
}
/**
* SyslogServerProfile data source
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scm from "@pulumi/scm";
*
* //
* // Data source to retrieve a single SCM Syslog Server Profile object by its ID.
* //
* // Replace the ID with the UUID of the SCM Syslog Server Profile you want to find.
* const scmSyslogServerProf = scm.getSyslogServerProfile({
* id: "69f7ee97-7c0a-416d-a28d-d45929851f6e",
* });
* export const scmSyslogServerProfileDetails = {
* profileId: scmSyslogServerProf.then(scmSyslogServerProf => scmSyslogServerProf.id),
* folder: scmSyslogServerProf.then(scmSyslogServerProf => scmSyslogServerProf.folder),
* name: scmSyslogServerProf.then(scmSyslogServerProf => scmSyslogServerProf.name),
* };
* ```
*/
export declare function getSyslogServerProfileOutput(args: GetSyslogServerProfileOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetSyslogServerProfileResult>;
/**
* A collection of arguments for invoking getSyslogServerProfile.
*/
export interface GetSyslogServerProfileOutputArgs {
/**
* 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>;
/**
* The UUID of the syslog server profile
*/
id: pulumi.Input<string>;
/**
* The name of the syslog server profile
*/
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>;
}