@pulumi/scm
Version:
A Pulumi package for managing resources on Strata Cloud Manager.. Based on terraform-provider-scm: version v0.2.1
251 lines (250 loc) • 7.48 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
* IkeGateway resource
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scm from "@pulumi/scm";
*
* // The scm_ike_crypto_profile resource is a prerequisite for the IKE gateway.
* const scmIkeGwCryptoProfile1 = new scm.IkeCryptoProfile("scm_ike_gw_crypto_profile_1", {
* folder: "Remote Networks",
* name: "scm_ike_gw_crypto_profile_1",
* hashes: ["sha256"],
* dhGroups: ["group14"],
* encryptions: ["aes-256-cbc"],
* });
* // This is the main scm_ike_gateway resource.
* const scmIkeGateway1 = new scm.IkeGateway("scm_ike_gateway_1", {
* folder: "Remote Networks",
* name: "scm_ike_gateway_1",
* authentication: {
* preSharedKey: {
* key: "123456",
* },
* },
* peerAddress: {
* ip: "2.2.2.4",
* },
* peerId: {
* type: "ipaddr",
* id: "10.3.3.4",
* },
* localId: {
* type: "ipaddr",
* id: "10.3.4.4",
* },
* protocol: {
* ikev1: {
* ikeCryptoProfile: scmIkeGwCryptoProfile1.name,
* dpd: {
* enable: true,
* },
* },
* ikev2: {
* ikeCryptoProfile: scmIkeGwCryptoProfile1.name,
* dpd: {
* enable: true,
* },
* },
* },
* });
* ```
*/
export declare class IkeGateway extends pulumi.CustomResource {
/**
* Get an existing IkeGateway 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?: IkeGatewayState, opts?: pulumi.CustomResourceOptions): IkeGateway;
/**
* Returns true if the given object is an instance of IkeGateway. 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 IkeGateway;
/**
* Authentication
*/
readonly authentication: pulumi.Output<outputs.IkeGatewayAuthentication>;
/**
* The device in which the resource is defined
*/
readonly device: pulumi.Output<string | undefined>;
/**
* Map of sensitive values returned from the API.
*/
readonly encryptedValues: pulumi.Output<{
[key: string]: string;
}>;
/**
* The folder in which the resource is defined
*
* > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
*/
readonly folder: pulumi.Output<string | undefined>;
/**
* Local address
*/
readonly localAddress: pulumi.Output<outputs.IkeGatewayLocalAddress>;
/**
* Local id
*/
readonly localId: pulumi.Output<outputs.IkeGatewayLocalId | undefined>;
/**
* Alphanumeric string begin with letter: [0-9a-zA-Z._-]
*/
readonly name: pulumi.Output<string>;
/**
* Peer address
*/
readonly peerAddress: pulumi.Output<outputs.IkeGatewayPeerAddress>;
/**
* Peer id
*/
readonly peerId: pulumi.Output<outputs.IkeGatewayPeerId | undefined>;
/**
* Protocol
*/
readonly protocol: pulumi.Output<outputs.IkeGatewayProtocol>;
/**
* Protocol common
*/
readonly protocolCommon: pulumi.Output<outputs.IkeGatewayProtocolCommon>;
/**
* The snippet in which the resource is defined
*
* > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
*/
readonly snippet: pulumi.Output<string | undefined>;
readonly tfid: pulumi.Output<string>;
/**
* Create a IkeGateway 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: IkeGatewayArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering IkeGateway resources.
*/
export interface IkeGatewayState {
/**
* Authentication
*/
authentication?: pulumi.Input<inputs.IkeGatewayAuthentication>;
/**
* The device in which the resource is defined
*/
device?: pulumi.Input<string>;
/**
* Map of sensitive values returned from the API.
*/
encryptedValues?: pulumi.Input<{
[key: string]: 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>;
/**
* Local address
*/
localAddress?: pulumi.Input<inputs.IkeGatewayLocalAddress>;
/**
* Local id
*/
localId?: pulumi.Input<inputs.IkeGatewayLocalId>;
/**
* Alphanumeric string begin with letter: [0-9a-zA-Z._-]
*/
name?: pulumi.Input<string>;
/**
* Peer address
*/
peerAddress?: pulumi.Input<inputs.IkeGatewayPeerAddress>;
/**
* Peer id
*/
peerId?: pulumi.Input<inputs.IkeGatewayPeerId>;
/**
* Protocol
*/
protocol?: pulumi.Input<inputs.IkeGatewayProtocol>;
/**
* Protocol common
*/
protocolCommon?: pulumi.Input<inputs.IkeGatewayProtocolCommon>;
/**
* The snippet in which the resource is defined
*
* > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
*/
snippet?: pulumi.Input<string>;
tfid?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a IkeGateway resource.
*/
export interface IkeGatewayArgs {
/**
* Authentication
*/
authentication: pulumi.Input<inputs.IkeGatewayAuthentication>;
/**
* The device in which the resource is defined
*/
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>;
/**
* Local address
*/
localAddress?: pulumi.Input<inputs.IkeGatewayLocalAddress>;
/**
* Local id
*/
localId?: pulumi.Input<inputs.IkeGatewayLocalId>;
/**
* Alphanumeric string begin with letter: [0-9a-zA-Z._-]
*/
name?: pulumi.Input<string>;
/**
* Peer address
*/
peerAddress: pulumi.Input<inputs.IkeGatewayPeerAddress>;
/**
* Peer id
*/
peerId?: pulumi.Input<inputs.IkeGatewayPeerId>;
/**
* Protocol
*/
protocol: pulumi.Input<inputs.IkeGatewayProtocol>;
/**
* Protocol common
*/
protocolCommon?: pulumi.Input<inputs.IkeGatewayProtocolCommon>;
/**
* The snippet in which the resource is defined
*
* > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
*/
snippet?: pulumi.Input<string>;
}