Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Launch Darkly
  3. API Docs
  4. RelayProxyConfiguration
Launch Darkly v0.0.6 published on Sunday, Feb 19, 2023 by lbrlabs
lbrlabs/pulumi-launchdarkly

launchdarkly.RelayProxyConfiguration

Explore with Pulumi AI

launchdarkly logo
Launch Darkly v0.0.6 published on Sunday, Feb 19, 2023 by lbrlabs
lbrlabs/pulumi-launchdarkly

    Import

    Relay Proxy configurations can be imported using the configuration’s unique 24 character ID, e.g.

     $ pulumi import launchdarkly:index/relayProxyConfiguration:RelayProxyConfiguration example 51d440e30c9ff61457c710f6

    The unique relay proxy ID can be found in the relay proxy edit page URL, which you can locate by clicking the three dot menu on your relay proxy item in the UI and selecting ‘Edit configuration’https://app.launchdarkly.com/settings/relay/THIS_IS_YOUR_RELAY_PROXY_ID/edit

    Example Usage

    using System.Collections.Generic;
using Pulumi;
using Launchdarkly = Lbrlabs.PulumiPackage.Launchdarkly;

return await Deployment.RunAsync(() => 
{
    var example = new Launchdarkly.RelayProxyConfiguration("example", new()
    {
        Policies = new[]
        {
            new Launchdarkly.Inputs.RelayProxyConfigurationPolicyArgs
            {
                Actions = new[]
                {
                    "*",
                },
                Effect = "allow",
                Resources = new[]
                {
                    "proj/*:env/*",
                },
            },
        },
    });

});

    package main

import (
	"github.com/lbrlabs/pulumi-launchdarkly/sdk/go/launchdarkly"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := launchdarkly.NewRelayProxyConfiguration(ctx, "example", &launchdarkly.RelayProxyConfigurationArgs{
			Policies: launchdarkly.RelayProxyConfigurationPolicyArray{
				&launchdarkly.RelayProxyConfigurationPolicyArgs{
					Actions: pulumi.StringArray{
						pulumi.String("*"),
					},
					Effect: pulumi.String("allow"),
					Resources: pulumi.StringArray{
						pulumi.String("proj/*:env/*"),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.launchdarkly.RelayProxyConfiguration;
import com.pulumi.launchdarkly.RelayProxyConfigurationArgs;
import com.pulumi.launchdarkly.inputs.RelayProxyConfigurationPolicyArgs;
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 example = new RelayProxyConfiguration("example", RelayProxyConfigurationArgs.builder()        
            .policies(RelayProxyConfigurationPolicyArgs.builder()
                .actions("*")
                .effect("allow")
                .resources("proj/*:env/*")
                .build())
            .build());

    }
}

    import pulumi
import lbrlabs_pulumi_launchdarkly as launchdarkly

example = launchdarkly.RelayProxyConfiguration("example", policies=[launchdarkly.RelayProxyConfigurationPolicyArgs(
    actions=["*"],
    effect="allow",
    resources=["proj/*:env/*"],
)])

    import * as pulumi from "@pulumi/pulumi";
import * as launchdarkly from "@lbrlabs/pulumi-launchdarkly";

const example = new launchdarkly.RelayProxyConfiguration("example", {policies: [{
    actions: ["*"],
    effect: "allow",
    resources: ["proj/*:env/*"],
}]});

    resources:
  example:
    type: launchdarkly:RelayProxyConfiguration
    properties:
      policies:
        - actions:
            - '*'
          effect: allow
          resources:
            - proj/*:env/*

    Create RelayProxyConfiguration Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new RelayProxyConfiguration(name: string, args: RelayProxyConfigurationArgs, opts?: CustomResourceOptions);
    @overload
def RelayProxyConfiguration(resource_name: str,
                            args: RelayProxyConfigurationArgs,
                            opts: Optional[ResourceOptions] = None)

@overload
def RelayProxyConfiguration(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            policies: Optional[Sequence[RelayProxyConfigurationPolicyArgs]] = None,
                            name: Optional[str] = None)
    func NewRelayProxyConfiguration(ctx *Context, name string, args RelayProxyConfigurationArgs, opts ...ResourceOption) (*RelayProxyConfiguration, error)
    public RelayProxyConfiguration(string name, RelayProxyConfigurationArgs args, CustomResourceOptions? opts = null)
    public RelayProxyConfiguration(String name, RelayProxyConfigurationArgs args)
public RelayProxyConfiguration(String name, RelayProxyConfigurationArgs args, CustomResourceOptions options)

    type: launchdarkly:RelayProxyConfiguration
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 RelayProxyConfigurationArgs
    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 RelayProxyConfigurationArgs
    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 RelayProxyConfigurationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RelayProxyConfigurationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RelayProxyConfigurationArgs
    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 relayProxyConfigurationResource = new Launchdarkly.RelayProxyConfiguration("relayProxyConfigurationResource", new()
{
    Policies = new[]
    {
        new Launchdarkly.Inputs.RelayProxyConfigurationPolicyArgs
        {
            Effect = "string",
            Actions = new[]
            {
                "string",
            },
            NotActions = new[]
            {
                "string",
            },
            NotResources = new[]
            {
                "string",
            },
            Resources = new[]
            {
                "string",
            },
        },
    },
    Name = "string",
});

    example, err := launchdarkly.NewRelayProxyConfiguration(ctx, "relayProxyConfigurationResource", &launchdarkly.RelayProxyConfigurationArgs{
	Policies: launchdarkly.RelayProxyConfigurationPolicyArray{
		&launchdarkly.RelayProxyConfigurationPolicyArgs{
			Effect: pulumi.String("string"),
			Actions: pulumi.StringArray{
				pulumi.String("string"),
			},
			NotActions: pulumi.StringArray{
				pulumi.String("string"),
			},
			NotResources: pulumi.StringArray{
				pulumi.String("string"),
			},
			Resources: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	Name: pulumi.String("string"),
})

    var relayProxyConfigurationResource = new RelayProxyConfiguration("relayProxyConfigurationResource", RelayProxyConfigurationArgs.builder()
    .policies(RelayProxyConfigurationPolicyArgs.builder()
        .effect("string")
        .actions("string")
        .notActions("string")
        .notResources("string")
        .resources("string")
        .build())
    .name("string")
    .build());

    relay_proxy_configuration_resource = launchdarkly.RelayProxyConfiguration("relayProxyConfigurationResource",
    policies=[{
        "effect": "string",
        "actions": ["string"],
        "not_actions": ["string"],
        "not_resources": ["string"],
        "resources": ["string"],
    }],
    name="string")

    const relayProxyConfigurationResource = new launchdarkly.RelayProxyConfiguration("relayProxyConfigurationResource", {
    policies: [{
        effect: "string",
        actions: ["string"],
        notActions: ["string"],
        notResources: ["string"],
        resources: ["string"],
    }],
    name: "string",
});

    type: launchdarkly:RelayProxyConfiguration
properties:
    name: string
    policies:
        - actions:
            - string
          effect: string
          notActions:
            - string
          notResources:
            - string
          resources:
            - string

    RelayProxyConfiguration 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 RelayProxyConfiguration resource accepts the following input properties:

    Policies List<Lbrlabs.PulumiPackage.Launchdarkly.Inputs.RelayProxyConfigurationPolicy>
    The Relay Proxy configuration's rule policy block. This determines what content the Relay Proxy receives. To learn more, read Understanding policies.
    Name string
    The human-readable name for your Relay Proxy configuration.
    Policies []RelayProxyConfigurationPolicyArgs
    The Relay Proxy configuration's rule policy block. This determines what content the Relay Proxy receives. To learn more, read Understanding policies.
    Name string
    The human-readable name for your Relay Proxy configuration.
    policies List<RelayProxyConfigurationPolicy>
    The Relay Proxy configuration's rule policy block. This determines what content the Relay Proxy receives. To learn more, read Understanding policies.
    name String
    The human-readable name for your Relay Proxy configuration.
    policies RelayProxyConfigurationPolicy[]
    The Relay Proxy configuration's rule policy block. This determines what content the Relay Proxy receives. To learn more, read Understanding policies.
    name string
    The human-readable name for your Relay Proxy configuration.
    policies Sequence[RelayProxyConfigurationPolicyArgs]
    The Relay Proxy configuration's rule policy block. This determines what content the Relay Proxy receives. To learn more, read Understanding policies.
    name str
    The human-readable name for your Relay Proxy configuration.
    policies List<Property Map>
    The Relay Proxy configuration's rule policy block. This determines what content the Relay Proxy receives. To learn more, read Understanding policies.
    name String
    The human-readable name for your Relay Proxy configuration.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the RelayProxyConfiguration resource produces the following output properties:

    DisplayKey string
    The last 4 characters of the Relay Proxy configuration's unique key.
    FullKey string
    The Relay Proxy configuration's unique key. Because the full_key is only exposed upon creation, it will not be available if the resource is imported.
    Id string
    The provider-assigned unique ID for this managed resource.
    DisplayKey string
    The last 4 characters of the Relay Proxy configuration's unique key.
    FullKey string
    The Relay Proxy configuration's unique key. Because the full_key is only exposed upon creation, it will not be available if the resource is imported.
    Id string
    The provider-assigned unique ID for this managed resource.
    displayKey String
    The last 4 characters of the Relay Proxy configuration's unique key.
    fullKey String
    The Relay Proxy configuration's unique key. Because the full_key is only exposed upon creation, it will not be available if the resource is imported.
    id String
    The provider-assigned unique ID for this managed resource.
    displayKey string
    The last 4 characters of the Relay Proxy configuration's unique key.
    fullKey string
    The Relay Proxy configuration's unique key. Because the full_key is only exposed upon creation, it will not be available if the resource is imported.
    id string
    The provider-assigned unique ID for this managed resource.
    display_key str
    The last 4 characters of the Relay Proxy configuration's unique key.
    full_key str
    The Relay Proxy configuration's unique key. Because the full_key is only exposed upon creation, it will not be available if the resource is imported.
    id str
    The provider-assigned unique ID for this managed resource.
    displayKey String
    The last 4 characters of the Relay Proxy configuration's unique key.
    fullKey String
    The Relay Proxy configuration's unique key. Because the full_key is only exposed upon creation, it will not be available if the resource is imported.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing RelayProxyConfiguration Resource

    Get an existing RelayProxyConfiguration 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?: RelayProxyConfigurationState, opts?: CustomResourceOptions): RelayProxyConfiguration
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        display_key: Optional[str] = None,
        full_key: Optional[str] = None,
        name: Optional[str] = None,
        policies: Optional[Sequence[RelayProxyConfigurationPolicyArgs]] = None) -> RelayProxyConfiguration
    func GetRelayProxyConfiguration(ctx *Context, name string, id IDInput, state *RelayProxyConfigurationState, opts ...ResourceOption) (*RelayProxyConfiguration, error)
    public static RelayProxyConfiguration Get(string name, Input<string> id, RelayProxyConfigurationState? state, CustomResourceOptions? opts = null)
    public static RelayProxyConfiguration get(String name, Output<String> id, RelayProxyConfigurationState 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.
    The following state arguments are supported:
    DisplayKey string
    The last 4 characters of the Relay Proxy configuration's unique key.
    FullKey string
    The Relay Proxy configuration's unique key. Because the full_key is only exposed upon creation, it will not be available if the resource is imported.
    Name string
    The human-readable name for your Relay Proxy configuration.
    Policies List<Lbrlabs.PulumiPackage.Launchdarkly.Inputs.RelayProxyConfigurationPolicy>
    The Relay Proxy configuration's rule policy block. This determines what content the Relay Proxy receives. To learn more, read Understanding policies.
    DisplayKey string
    The last 4 characters of the Relay Proxy configuration's unique key.
    FullKey string
    The Relay Proxy configuration's unique key. Because the full_key is only exposed upon creation, it will not be available if the resource is imported.
    Name string
    The human-readable name for your Relay Proxy configuration.
    Policies []RelayProxyConfigurationPolicyArgs
    The Relay Proxy configuration's rule policy block. This determines what content the Relay Proxy receives. To learn more, read Understanding policies.
    displayKey String
    The last 4 characters of the Relay Proxy configuration's unique key.
    fullKey String
    The Relay Proxy configuration's unique key. Because the full_key is only exposed upon creation, it will not be available if the resource is imported.
    name String
    The human-readable name for your Relay Proxy configuration.
    policies List<RelayProxyConfigurationPolicy>
    The Relay Proxy configuration's rule policy block. This determines what content the Relay Proxy receives. To learn more, read Understanding policies.
    displayKey string
    The last 4 characters of the Relay Proxy configuration's unique key.
    fullKey string
    The Relay Proxy configuration's unique key. Because the full_key is only exposed upon creation, it will not be available if the resource is imported.
    name string
    The human-readable name for your Relay Proxy configuration.
    policies RelayProxyConfigurationPolicy[]
    The Relay Proxy configuration's rule policy block. This determines what content the Relay Proxy receives. To learn more, read Understanding policies.
    display_key str
    The last 4 characters of the Relay Proxy configuration's unique key.
    full_key str
    The Relay Proxy configuration's unique key. Because the full_key is only exposed upon creation, it will not be available if the resource is imported.
    name str
    The human-readable name for your Relay Proxy configuration.
    policies Sequence[RelayProxyConfigurationPolicyArgs]
    The Relay Proxy configuration's rule policy block. This determines what content the Relay Proxy receives. To learn more, read Understanding policies.
    displayKey String
    The last 4 characters of the Relay Proxy configuration's unique key.
    fullKey String
    The Relay Proxy configuration's unique key. Because the full_key is only exposed upon creation, it will not be available if the resource is imported.
    name String
    The human-readable name for your Relay Proxy configuration.
    policies List<Property Map>
    The Relay Proxy configuration's rule policy block. This determines what content the Relay Proxy receives. To learn more, read Understanding policies.

    Supporting Types

    RelayProxyConfigurationPolicy, RelayProxyConfigurationPolicyArgs

    Effect string
    • Either allow or deny. This argument defines whether the rule policy allows or denies access to the named resources and actions.
    Actions List<string>
    The list of action specifiers defining the actions to which the rule policy applies. Either actions or not_actions must be specified. For a list of available actions read Actions reference.
    NotActions List<string>
    The list of action specifiers defining the actions to which the rule policy does not apply. Either actions or not_actions must be specified. For a list of available actions read Actions reference.
    NotResources List<string>
    • The list of resource specifiers defining the resources to which the rule policy does not apply. Either resources or not_resources must be specified. For a list of available resources read Understanding resource types and scopes.
    Resources List<string>
    • The list of resource specifiers defining the resources to which the rule policy applies. Either resources or not_resources must be specified. For a list of available resources read Understanding resource types and scopes.
    Effect string
    • Either allow or deny. This argument defines whether the rule policy allows or denies access to the named resources and actions.
    Actions []string
    The list of action specifiers defining the actions to which the rule policy applies. Either actions or not_actions must be specified. For a list of available actions read Actions reference.
    NotActions []string
    The list of action specifiers defining the actions to which the rule policy does not apply. Either actions or not_actions must be specified. For a list of available actions read Actions reference.
    NotResources []string
    • The list of resource specifiers defining the resources to which the rule policy does not apply. Either resources or not_resources must be specified. For a list of available resources read Understanding resource types and scopes.
    Resources []string
    • The list of resource specifiers defining the resources to which the rule policy applies. Either resources or not_resources must be specified. For a list of available resources read Understanding resource types and scopes.
    effect String
    • Either allow or deny. This argument defines whether the rule policy allows or denies access to the named resources and actions.
    actions List<String>
    The list of action specifiers defining the actions to which the rule policy applies. Either actions or not_actions must be specified. For a list of available actions read Actions reference.
    notActions List<String>
    The list of action specifiers defining the actions to which the rule policy does not apply. Either actions or not_actions must be specified. For a list of available actions read Actions reference.
    notResources List<String>
    • The list of resource specifiers defining the resources to which the rule policy does not apply. Either resources or not_resources must be specified. For a list of available resources read Understanding resource types and scopes.
    resources List<String>
    • The list of resource specifiers defining the resources to which the rule policy applies. Either resources or not_resources must be specified. For a list of available resources read Understanding resource types and scopes.
    effect string
    • Either allow or deny. This argument defines whether the rule policy allows or denies access to the named resources and actions.
    actions string[]
    The list of action specifiers defining the actions to which the rule policy applies. Either actions or not_actions must be specified. For a list of available actions read Actions reference.
    notActions string[]
    The list of action specifiers defining the actions to which the rule policy does not apply. Either actions or not_actions must be specified. For a list of available actions read Actions reference.
    notResources string[]
    • The list of resource specifiers defining the resources to which the rule policy does not apply. Either resources or not_resources must be specified. For a list of available resources read Understanding resource types and scopes.
    resources string[]
    • The list of resource specifiers defining the resources to which the rule policy applies. Either resources or not_resources must be specified. For a list of available resources read Understanding resource types and scopes.
    effect str
    • Either allow or deny. This argument defines whether the rule policy allows or denies access to the named resources and actions.
    actions Sequence[str]
    The list of action specifiers defining the actions to which the rule policy applies. Either actions or not_actions must be specified. For a list of available actions read Actions reference.
    not_actions Sequence[str]
    The list of action specifiers defining the actions to which the rule policy does not apply. Either actions or not_actions must be specified. For a list of available actions read Actions reference.
    not_resources Sequence[str]
    • The list of resource specifiers defining the resources to which the rule policy does not apply. Either resources or not_resources must be specified. For a list of available resources read Understanding resource types and scopes.
    resources Sequence[str]
    • The list of resource specifiers defining the resources to which the rule policy applies. Either resources or not_resources must be specified. For a list of available resources read Understanding resource types and scopes.
    effect String
    • Either allow or deny. This argument defines whether the rule policy allows or denies access to the named resources and actions.
    actions List<String>
    The list of action specifiers defining the actions to which the rule policy applies. Either actions or not_actions must be specified. For a list of available actions read Actions reference.
    notActions List<String>
    The list of action specifiers defining the actions to which the rule policy does not apply. Either actions or not_actions must be specified. For a list of available actions read Actions reference.
    notResources List<String>
    • The list of resource specifiers defining the resources to which the rule policy does not apply. Either resources or not_resources must be specified. For a list of available resources read Understanding resource types and scopes.
    resources List<String>
    • The list of resource specifiers defining the resources to which the rule policy applies. Either resources or not_resources must be specified. For a list of available resources read Understanding resource types and scopes.

    Package Details

    Repository
    launchdarkly lbrlabs/pulumi-launchdarkly
    License
    Notes
    This Pulumi package is based on the launchdarkly Terraform Provider.
    launchdarkly logo
    Launch Darkly v0.0.6 published on Sunday, Feb 19, 2023 by lbrlabs
    lbrlabs/pulumi-launchdarkly