Launch Darkly

v0.0.3 published on Sunday, Sep 18, 2022 by lbrlabs

getFeatureFlag

Provides a LaunchDarkly feature flag data source.

This data source allows you to retrieve feature flag information from your LaunchDarkly organization.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var example = Launchdarkly.GetFeatureFlag.Invoke(new()
    {
        Key = "example-flag",
        ProjectKey = "example-project",
    });

});
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.LookupFeatureFlag(ctx, &GetFeatureFlagArgs{
			Key:        "example-flag",
			ProjectKey: "example-project",
		}, nil)
		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.LaunchdarklyFunctions;
import com.pulumi.launchdarkly.inputs.GetFeatureFlagArgs;
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) {
        final var example = LaunchdarklyFunctions.getFeatureFlag(GetFeatureFlagArgs.builder()
            .key("example-flag")
            .projectKey("example-project")
            .build());

    }
}
import pulumi
import pulumi_launchdarkly as launchdarkly

example = launchdarkly.get_feature_flag(key="example-flag",
    project_key="example-project")
import * as pulumi from "@pulumi/pulumi";
import * as launchdarkly from "@pulumi/launchdarkly";

const example = pulumi.output(launchdarkly.getFeatureFlag({
    key: "example-flag",
    projectKey: "example-project",
}));
variables:
  example:
    Fn::Invoke:
      Function: launchdarkly:getFeatureFlag
      Arguments:
        key: example-flag
        projectKey: example-project

Using getFeatureFlag

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getFeatureFlag(args: GetFeatureFlagArgs, opts?: InvokeOptions): Promise<GetFeatureFlagResult>
function getFeatureFlagOutput(args: GetFeatureFlagOutputArgs, opts?: InvokeOptions): Output<GetFeatureFlagResult>
def get_feature_flag(archived: Optional[bool] = None,
                     custom_properties: Optional[Sequence[GetFeatureFlagCustomProperty]] = None,
                     defaults: Optional[GetFeatureFlagDefaults] = None,
                     description: Optional[str] = None,
                     include_in_snippet: Optional[bool] = None,
                     key: Optional[str] = None,
                     maintainer_id: Optional[str] = None,
                     project_key: Optional[str] = None,
                     tags: Optional[Sequence[str]] = None,
                     temporary: Optional[bool] = None,
                     variations: Optional[Sequence[GetFeatureFlagVariation]] = None,
                     opts: Optional[InvokeOptions] = None) -> GetFeatureFlagResult
def get_feature_flag_output(archived: Optional[pulumi.Input[bool]] = None,
                     custom_properties: Optional[pulumi.Input[Sequence[pulumi.Input[GetFeatureFlagCustomPropertyArgs]]]] = None,
                     defaults: Optional[pulumi.Input[GetFeatureFlagDefaultsArgs]] = None,
                     description: Optional[pulumi.Input[str]] = None,
                     include_in_snippet: Optional[pulumi.Input[bool]] = None,
                     key: Optional[pulumi.Input[str]] = None,
                     maintainer_id: Optional[pulumi.Input[str]] = None,
                     project_key: Optional[pulumi.Input[str]] = None,
                     tags: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                     temporary: Optional[pulumi.Input[bool]] = None,
                     variations: Optional[pulumi.Input[Sequence[pulumi.Input[GetFeatureFlagVariationArgs]]]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetFeatureFlagResult]
func LookupFeatureFlag(ctx *Context, args *LookupFeatureFlagArgs, opts ...InvokeOption) (*LookupFeatureFlagResult, error)
func LookupFeatureFlagOutput(ctx *Context, args *LookupFeatureFlagOutputArgs, opts ...InvokeOption) LookupFeatureFlagResultOutput

> Note: This function is named LookupFeatureFlag in the Go SDK.

public static class GetFeatureFlag 
{
    public static Task<GetFeatureFlagResult> InvokeAsync(GetFeatureFlagArgs args, InvokeOptions? opts = null)
    public static Output<GetFeatureFlagResult> Invoke(GetFeatureFlagInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetFeatureFlagResult> getFeatureFlag(GetFeatureFlagArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: launchdarkly:index/getFeatureFlag:getFeatureFlag
  Arguments:
    # Arguments dictionary

The following arguments are supported:

Key string

The unique feature flag key that references the flag in your application code.

ProjectKey string

The feature flag's project key.

Archived bool
CustomProperties List<Lbrlabs.PulumiPackage.Launchdarkly.Inputs.GetFeatureFlagCustomProperty>

List of nested blocks describing the feature flag's custom properties. To learn more, read Nested Custom Properties.

Defaults Lbrlabs.PulumiPackage.Launchdarkly.Inputs.GetFeatureFlagDefaults

A map describing the index of the variation served when the flag is on for new environments. To learn more, read Nested Defaults Blocks.

Description string

The variation's description.

IncludeInSnippet bool
MaintainerId string

The feature flag maintainer's 24 character alphanumeric team member ID.

Tags List<string>

Set of feature flag tags.

Temporary bool

Whether the flag is a temporary flag.

Variations List<Lbrlabs.PulumiPackage.Launchdarkly.Inputs.GetFeatureFlagVariation>

List of nested blocks describing the variations associated with the feature flag. To learn more, read Nested Variations Blocks.

Key string

The unique feature flag key that references the flag in your application code.

ProjectKey string

The feature flag's project key.

Archived bool
CustomProperties []GetFeatureFlagCustomProperty

List of nested blocks describing the feature flag's custom properties. To learn more, read Nested Custom Properties.

Defaults GetFeatureFlagDefaults

A map describing the index of the variation served when the flag is on for new environments. To learn more, read Nested Defaults Blocks.

Description string

The variation's description.

IncludeInSnippet bool
MaintainerId string

The feature flag maintainer's 24 character alphanumeric team member ID.

Tags []string

Set of feature flag tags.

Temporary bool

Whether the flag is a temporary flag.

Variations []GetFeatureFlagVariation

List of nested blocks describing the variations associated with the feature flag. To learn more, read Nested Variations Blocks.

key String

The unique feature flag key that references the flag in your application code.

projectKey String

The feature flag's project key.

archived Boolean
customProperties List<GetFeatureFlagCustomProperty>

List of nested blocks describing the feature flag's custom properties. To learn more, read Nested Custom Properties.

defaults GetFeatureFlagDefaults

A map describing the index of the variation served when the flag is on for new environments. To learn more, read Nested Defaults Blocks.

description String

The variation's description.

includeInSnippet Boolean
maintainerId String

The feature flag maintainer's 24 character alphanumeric team member ID.

tags List<String>

Set of feature flag tags.

temporary Boolean

Whether the flag is a temporary flag.

variations List<GetFeatureFlagVariation>

List of nested blocks describing the variations associated with the feature flag. To learn more, read Nested Variations Blocks.

key string

The unique feature flag key that references the flag in your application code.

projectKey string

The feature flag's project key.

archived boolean
customProperties GetFeatureFlagCustomProperty[]

List of nested blocks describing the feature flag's custom properties. To learn more, read Nested Custom Properties.

defaults GetFeatureFlagDefaults

A map describing the index of the variation served when the flag is on for new environments. To learn more, read Nested Defaults Blocks.

description string

The variation's description.

includeInSnippet boolean
maintainerId string

The feature flag maintainer's 24 character alphanumeric team member ID.

tags string[]

Set of feature flag tags.

temporary boolean

Whether the flag is a temporary flag.

variations GetFeatureFlagVariation[]

List of nested blocks describing the variations associated with the feature flag. To learn more, read Nested Variations Blocks.

key str

The unique feature flag key that references the flag in your application code.

project_key str

The feature flag's project key.

archived bool
custom_properties Sequence[GetFeatureFlagCustomProperty]

List of nested blocks describing the feature flag's custom properties. To learn more, read Nested Custom Properties.

defaults GetFeatureFlagDefaults

A map describing the index of the variation served when the flag is on for new environments. To learn more, read Nested Defaults Blocks.

description str

The variation's description.

include_in_snippet bool
maintainer_id str

The feature flag maintainer's 24 character alphanumeric team member ID.

tags Sequence[str]

Set of feature flag tags.

temporary bool

Whether the flag is a temporary flag.

variations Sequence[GetFeatureFlagVariation]

List of nested blocks describing the variations associated with the feature flag. To learn more, read Nested Variations Blocks.

key String

The unique feature flag key that references the flag in your application code.

projectKey String

The feature flag's project key.

archived Boolean
customProperties List<Property Map>

List of nested blocks describing the feature flag's custom properties. To learn more, read Nested Custom Properties.

defaults Property Map

A map describing the index of the variation served when the flag is on for new environments. To learn more, read Nested Defaults Blocks.

description String

The variation's description.

includeInSnippet Boolean
maintainerId String

The feature flag maintainer's 24 character alphanumeric team member ID.

tags List<String>

Set of feature flag tags.

temporary Boolean

Whether the flag is a temporary flag.

variations List<Property Map>

List of nested blocks describing the variations associated with the feature flag. To learn more, read Nested Variations Blocks.

getFeatureFlag Result

The following output properties are available:

ClientSideAvailabilities List<Lbrlabs.PulumiPackage.Launchdarkly.Outputs.GetFeatureFlagClientSideAvailability>

A map describing whether this flag has been made available to the client-side JavaScript SDK. To learn more, read Nested Client-Side Availability Block.

Defaults Lbrlabs.PulumiPackage.Launchdarkly.Outputs.GetFeatureFlagDefaults

A map describing the index of the variation served when the flag is on for new environments. To learn more, read Nested Defaults Blocks.

Id string

The provider-assigned unique ID for this managed resource.

Key string

The unique custom property key.

MaintainerId string

The feature flag maintainer's 24 character alphanumeric team member ID.

Name string

The name of the custom property.

ProjectKey string
VariationType string

The feature flag's variation type: boolean, string, number or json.

Variations List<Lbrlabs.PulumiPackage.Launchdarkly.Outputs.GetFeatureFlagVariation>

List of nested blocks describing the variations associated with the feature flag. To learn more, read Nested Variations Blocks.

Archived bool
CustomProperties List<Lbrlabs.PulumiPackage.Launchdarkly.Outputs.GetFeatureFlagCustomProperty>

List of nested blocks describing the feature flag's custom properties. To learn more, read Nested Custom Properties.

Description string

The variation's description.

IncludeInSnippet bool
Tags List<string>

Set of feature flag tags.

Temporary bool

Whether the flag is a temporary flag.

ClientSideAvailabilities []GetFeatureFlagClientSideAvailability

A map describing whether this flag has been made available to the client-side JavaScript SDK. To learn more, read Nested Client-Side Availability Block.

Defaults GetFeatureFlagDefaults

A map describing the index of the variation served when the flag is on for new environments. To learn more, read Nested Defaults Blocks.

Id string

The provider-assigned unique ID for this managed resource.

Key string

The unique custom property key.

MaintainerId string

The feature flag maintainer's 24 character alphanumeric team member ID.

Name string

The name of the custom property.

ProjectKey string
VariationType string

The feature flag's variation type: boolean, string, number or json.

Variations []GetFeatureFlagVariation

List of nested blocks describing the variations associated with the feature flag. To learn more, read Nested Variations Blocks.

Archived bool
CustomProperties []GetFeatureFlagCustomProperty

List of nested blocks describing the feature flag's custom properties. To learn more, read Nested Custom Properties.

Description string

The variation's description.

IncludeInSnippet bool
Tags []string

Set of feature flag tags.

Temporary bool

Whether the flag is a temporary flag.

clientSideAvailabilities List<GetFeatureFlagClientSideAvailability>

A map describing whether this flag has been made available to the client-side JavaScript SDK. To learn more, read Nested Client-Side Availability Block.

defaults GetFeatureFlagDefaults

A map describing the index of the variation served when the flag is on for new environments. To learn more, read Nested Defaults Blocks.

id String

The provider-assigned unique ID for this managed resource.

key String

The unique custom property key.

maintainerId String

The feature flag maintainer's 24 character alphanumeric team member ID.

name String

The name of the custom property.

projectKey String
variationType String

The feature flag's variation type: boolean, string, number or json.

variations List<GetFeatureFlagVariation>

List of nested blocks describing the variations associated with the feature flag. To learn more, read Nested Variations Blocks.

archived Boolean
customProperties List<GetFeatureFlagCustomProperty>

List of nested blocks describing the feature flag's custom properties. To learn more, read Nested Custom Properties.

description String

The variation's description.

includeInSnippet Boolean
tags List<String>

Set of feature flag tags.

temporary Boolean

Whether the flag is a temporary flag.

clientSideAvailabilities GetFeatureFlagClientSideAvailability[]

A map describing whether this flag has been made available to the client-side JavaScript SDK. To learn more, read Nested Client-Side Availability Block.

defaults GetFeatureFlagDefaults

A map describing the index of the variation served when the flag is on for new environments. To learn more, read Nested Defaults Blocks.

id string

The provider-assigned unique ID for this managed resource.

key string

The unique custom property key.

maintainerId string

The feature flag maintainer's 24 character alphanumeric team member ID.

name string

The name of the custom property.

projectKey string
variationType string

The feature flag's variation type: boolean, string, number or json.

variations GetFeatureFlagVariation[]

List of nested blocks describing the variations associated with the feature flag. To learn more, read Nested Variations Blocks.

archived boolean
customProperties GetFeatureFlagCustomProperty[]

List of nested blocks describing the feature flag's custom properties. To learn more, read Nested Custom Properties.

description string

The variation's description.

includeInSnippet boolean
tags string[]

Set of feature flag tags.

temporary boolean

Whether the flag is a temporary flag.

client_side_availabilities Sequence[GetFeatureFlagClientSideAvailability]

A map describing whether this flag has been made available to the client-side JavaScript SDK. To learn more, read Nested Client-Side Availability Block.

defaults GetFeatureFlagDefaults

A map describing the index of the variation served when the flag is on for new environments. To learn more, read Nested Defaults Blocks.

id str

The provider-assigned unique ID for this managed resource.

key str

The unique custom property key.

maintainer_id str

The feature flag maintainer's 24 character alphanumeric team member ID.

name str

The name of the custom property.

project_key str
variation_type str

The feature flag's variation type: boolean, string, number or json.

variations Sequence[GetFeatureFlagVariation]

List of nested blocks describing the variations associated with the feature flag. To learn more, read Nested Variations Blocks.

archived bool
custom_properties Sequence[GetFeatureFlagCustomProperty]

List of nested blocks describing the feature flag's custom properties. To learn more, read Nested Custom Properties.

description str

The variation's description.

include_in_snippet bool
tags Sequence[str]

Set of feature flag tags.

temporary bool

Whether the flag is a temporary flag.

clientSideAvailabilities List<Property Map>

A map describing whether this flag has been made available to the client-side JavaScript SDK. To learn more, read Nested Client-Side Availability Block.

defaults Property Map

A map describing the index of the variation served when the flag is on for new environments. To learn more, read Nested Defaults Blocks.

id String

The provider-assigned unique ID for this managed resource.

key String

The unique custom property key.

maintainerId String

The feature flag maintainer's 24 character alphanumeric team member ID.

name String

The name of the custom property.

projectKey String
variationType String

The feature flag's variation type: boolean, string, number or json.

variations List<Property Map>

List of nested blocks describing the variations associated with the feature flag. To learn more, read Nested Variations Blocks.

archived Boolean
customProperties List<Property Map>

List of nested blocks describing the feature flag's custom properties. To learn more, read Nested Custom Properties.

description String

The variation's description.

includeInSnippet Boolean
tags List<String>

Set of feature flag tags.

temporary Boolean

Whether the flag is a temporary flag.

Supporting Types

GetFeatureFlagClientSideAvailability

UsingEnvironmentId bool

When set to true, this flag is available to SDKs using the client-side ID.

UsingMobileKey bool

When set to true, this flag is available to SDKs using a mobile key.

UsingEnvironmentId bool

When set to true, this flag is available to SDKs using the client-side ID.

UsingMobileKey bool

When set to true, this flag is available to SDKs using a mobile key.

usingEnvironmentId Boolean

When set to true, this flag is available to SDKs using the client-side ID.

usingMobileKey Boolean

When set to true, this flag is available to SDKs using a mobile key.

usingEnvironmentId boolean

When set to true, this flag is available to SDKs using the client-side ID.

usingMobileKey boolean

When set to true, this flag is available to SDKs using a mobile key.

using_environment_id bool

When set to true, this flag is available to SDKs using the client-side ID.

using_mobile_key bool

When set to true, this flag is available to SDKs using a mobile key.

usingEnvironmentId Boolean

When set to true, this flag is available to SDKs using the client-side ID.

usingMobileKey Boolean

When set to true, this flag is available to SDKs using a mobile key.

GetFeatureFlagCustomProperty

Key string

The unique feature flag key that references the flag in your application code.

Name string

The name of the custom property.

Values List<string>

The list of custom property value strings.

Key string

The unique feature flag key that references the flag in your application code.

Name string

The name of the custom property.

Values []string

The list of custom property value strings.

key String

The unique feature flag key that references the flag in your application code.

name String

The name of the custom property.

values List<String>

The list of custom property value strings.

key string

The unique feature flag key that references the flag in your application code.

name string

The name of the custom property.

values string[]

The list of custom property value strings.

key str

The unique feature flag key that references the flag in your application code.

name str

The name of the custom property.

values Sequence[str]

The list of custom property value strings.

key String

The unique feature flag key that references the flag in your application code.

name String

The name of the custom property.

values List<String>

The list of custom property value strings.

GetFeatureFlagDefaults

OffVariation int

(Required) The index of the variation the flag will default to in all new environments when off.

OnVariation int

(Required) The index of the variation the flag will default to in all new environments when on.

OffVariation int

(Required) The index of the variation the flag will default to in all new environments when off.

OnVariation int

(Required) The index of the variation the flag will default to in all new environments when on.

offVariation Integer

(Required) The index of the variation the flag will default to in all new environments when off.

onVariation Integer

(Required) The index of the variation the flag will default to in all new environments when on.

offVariation number

(Required) The index of the variation the flag will default to in all new environments when off.

onVariation number

(Required) The index of the variation the flag will default to in all new environments when on.

off_variation int

(Required) The index of the variation the flag will default to in all new environments when off.

on_variation int

(Required) The index of the variation the flag will default to in all new environments when on.

offVariation Number

(Required) The index of the variation the flag will default to in all new environments when off.

onVariation Number

(Required) The index of the variation the flag will default to in all new environments when on.

GetFeatureFlagVariation

Value string

The list of custom property value strings.

Description string

The variation's description.

Name string

The name of the custom property.

Value string

The list of custom property value strings.

Description string

The variation's description.

Name string

The name of the custom property.

value String

The list of custom property value strings.

description String

The variation's description.

name String

The name of the custom property.

value string

The list of custom property value strings.

description string

The variation's description.

name string

The name of the custom property.

value str

The list of custom property value strings.

description str

The variation's description.

name str

The name of the custom property.

value String

The list of custom property value strings.

description String

The variation's description.

name String

The name of the custom property.

Package Details

Repository
https://github.com/lbrlabs/pulumi-launchdarkly
License
Notes

This Pulumi package is based on the launchdarkly Terraform Provider.