sdm.ProxyClusterKey
Explore with Pulumi AI
Proxy Cluster Keys are authentication keys for all proxies within a cluster. The proxies within a cluster share the same key. One cluster can have multiple keys in order to facilitate key rotation.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as sdm from "@pierskarsenbarg/sdm";
const testProxyClusterKey = new sdm.ProxyClusterKey("testProxyClusterKey", {proxyClusterId: "n-12345123"});
import pulumi
import pierskarsenbarg_pulumi_sdm as sdm
test_proxy_cluster_key = sdm.ProxyClusterKey("testProxyClusterKey", proxy_cluster_id="n-12345123")
package main
import (
"github.com/pierskarsenbarg/pulumi-sdm/sdk/go/sdm"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := sdm.NewProxyClusterKey(ctx, "testProxyClusterKey", &sdm.ProxyClusterKeyArgs{
ProxyClusterId: pulumi.String("n-12345123"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Sdm = PiersKarsenbarg.Sdm;
return await Deployment.RunAsync(() =>
{
var testProxyClusterKey = new Sdm.ProxyClusterKey("testProxyClusterKey", new()
{
ProxyClusterId = "n-12345123",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.sdm.ProxyClusterKey;
import com.pulumi.sdm.ProxyClusterKeyArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var testProxyClusterKey = new ProxyClusterKey("testProxyClusterKey", ProxyClusterKeyArgs.builder()
.proxyClusterId("n-12345123")
.build());
}
}
resources:
testProxyClusterKey:
type: sdm:ProxyClusterKey
properties:
proxyClusterId: n-12345123
This resource can be imported using the import command.
Create ProxyClusterKey Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ProxyClusterKey(name: string, args: ProxyClusterKeyArgs, opts?: CustomResourceOptions);
@overload
def ProxyClusterKey(resource_name: str,
args: ProxyClusterKeyArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ProxyClusterKey(resource_name: str,
opts: Optional[ResourceOptions] = None,
proxy_cluster_id: Optional[str] = None)
func NewProxyClusterKey(ctx *Context, name string, args ProxyClusterKeyArgs, opts ...ResourceOption) (*ProxyClusterKey, error)
public ProxyClusterKey(string name, ProxyClusterKeyArgs args, CustomResourceOptions? opts = null)
public ProxyClusterKey(String name, ProxyClusterKeyArgs args)
public ProxyClusterKey(String name, ProxyClusterKeyArgs args, CustomResourceOptions options)
type: sdm:ProxyClusterKey
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args ProxyClusterKeyArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ProxyClusterKeyArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ProxyClusterKeyArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ProxyClusterKeyArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ProxyClusterKeyArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var proxyClusterKeyResource = new Sdm.ProxyClusterKey("proxyClusterKeyResource", new()
{
ProxyClusterId = "string",
});
example, err := sdm.NewProxyClusterKey(ctx, "proxyClusterKeyResource", &sdm.ProxyClusterKeyArgs{
ProxyClusterId: pulumi.String("string"),
})
var proxyClusterKeyResource = new ProxyClusterKey("proxyClusterKeyResource", ProxyClusterKeyArgs.builder()
.proxyClusterId("string")
.build());
proxy_cluster_key_resource = sdm.ProxyClusterKey("proxyClusterKeyResource", proxy_cluster_id="string")
const proxyClusterKeyResource = new sdm.ProxyClusterKey("proxyClusterKeyResource", {proxyClusterId: "string"});
type: sdm:ProxyClusterKey
properties:
proxyClusterId: string
ProxyClusterKey Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The ProxyClusterKey resource accepts the following input properties:
- Proxy
Cluster stringId - The ID of the proxy cluster which this key authenticates to.
- Proxy
Cluster stringId - The ID of the proxy cluster which this key authenticates to.
- proxy
Cluster StringId - The ID of the proxy cluster which this key authenticates to.
- proxy
Cluster stringId - The ID of the proxy cluster which this key authenticates to.
- proxy_
cluster_ strid - The ID of the proxy cluster which this key authenticates to.
- proxy
Cluster StringId - The ID of the proxy cluster which this key authenticates to.
Outputs
All input properties are implicitly available as output properties. Additionally, the ProxyClusterKey resource produces the following output properties:
- id str
- The provider-assigned unique ID for this managed resource.
- secret_
key str
Look up Existing ProxyClusterKey Resource
Get an existing ProxyClusterKey resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: ProxyClusterKeyState, opts?: CustomResourceOptions): ProxyClusterKey
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
proxy_cluster_id: Optional[str] = None,
secret_key: Optional[str] = None) -> ProxyClusterKey
func GetProxyClusterKey(ctx *Context, name string, id IDInput, state *ProxyClusterKeyState, opts ...ResourceOption) (*ProxyClusterKey, error)
public static ProxyClusterKey Get(string name, Input<string> id, ProxyClusterKeyState? state, CustomResourceOptions? opts = null)
public static ProxyClusterKey get(String name, Output<String> id, ProxyClusterKeyState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Proxy
Cluster stringId - The ID of the proxy cluster which this key authenticates to.
- Secret
Key string
- Proxy
Cluster stringId - The ID of the proxy cluster which this key authenticates to.
- Secret
Key string
- proxy
Cluster StringId - The ID of the proxy cluster which this key authenticates to.
- secret
Key String
- proxy
Cluster stringId - The ID of the proxy cluster which this key authenticates to.
- secret
Key string
- proxy_
cluster_ strid - The ID of the proxy cluster which this key authenticates to.
- secret_
key str
- proxy
Cluster StringId - The ID of the proxy cluster which this key authenticates to.
- secret
Key String
Import
A ProxyClusterKey can be imported using the id, e.g.,
$ pulumi import sdm:index/proxyClusterKey:ProxyClusterKey example gk-12345678
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- sdm pierskarsenbarg/pulumi-sdm
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
sdm
Terraform Provider.