Viewing docs for Launch Darkly v0.0.6
published on Sunday, Feb 19, 2023 by lbrlabs
published on Sunday, Feb 19, 2023 by lbrlabs
Viewing docs for Launch Darkly v0.0.6
published on Sunday, Feb 19, 2023 by lbrlabs
published on Sunday, Feb 19, 2023 by lbrlabs
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, &launchdarkly.LookupFeatureFlagArgs{
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 * as pulumi from "@pulumi/pulumi";
import * as launchdarkly from "@pulumi/launchdarkly";
const example = launchdarkly.getFeatureFlag({
key: "example-flag",
projectKey: "example-project",
});
import pulumi
import pulumi_launchdarkly as launchdarkly
example = launchdarkly.get_feature_flag(key="example-flag",
project_key="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,
client_side_availabilities: Optional[Sequence[GetFeatureFlagClientSideAvailability]] = 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,
client_side_availabilities: Optional[pulumi.Input[Sequence[pulumi.Input[GetFeatureFlagClientSideAvailabilityArgs]]]] = 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)
public static Output<GetFeatureFlagResult> getFeatureFlag(GetFeatureFlagArgs args, InvokeOptions options)
fn::invoke:
function: launchdarkly:index/getFeatureFlag:getFeatureFlag
arguments:
# arguments dictionaryThe following arguments are supported:
- Key string
- The unique feature flag key that references the flag in your application code.
- Project
Key string - The feature flag's project key.
- Archived bool
- Client
Side List<Lbrlabs.Availabilities Pulumi Package. Launchdarkly. Inputs. Get Feature Flag Client Side Availability> - 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.
- Custom
Properties List<Lbrlabs.Pulumi Package. Launchdarkly. Inputs. Get Feature Flag Custom Property> - List of nested blocks describing the feature flag's custom properties. To learn more, read Nested Custom Properties.
- Defaults
Lbrlabs.
Pulumi Package. Launchdarkly. Inputs. Get Feature Flag Defaults - 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.
- Include
In boolSnippet - Deprecated A boolean describing whether this flag has been made available to the client-side Javescript SDK using the client-side ID only.
include_in_snippetis now deprecated. Please retrieve information fromclient_side_availability.using_environment_idto maintain future compatability. - Maintainer
Id string - The feature flag maintainer's 24 character alphanumeric team member ID.
- List<string>
- Set of feature flag tags.
- Temporary bool
- Whether the flag is a temporary flag.
- Variations
List<Lbrlabs.
Pulumi Package. Launchdarkly. Inputs. Get Feature Flag Variation> - 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.
- Project
Key string - The feature flag's project key.
- Archived bool
- Client
Side []GetAvailabilities Feature Flag Client Side Availability - 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.
- Custom
Properties []GetFeature Flag Custom Property - List of nested blocks describing the feature flag's custom properties. To learn more, read Nested Custom Properties.
- Defaults
Get
Feature Flag Defaults - 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.
- Include
In boolSnippet - Deprecated A boolean describing whether this flag has been made available to the client-side Javescript SDK using the client-side ID only.
include_in_snippetis now deprecated. Please retrieve information fromclient_side_availability.using_environment_idto maintain future compatability. - Maintainer
Id string - The feature flag maintainer's 24 character alphanumeric team member ID.
- []string
- Set of feature flag tags.
- Temporary bool
- Whether the flag is a temporary flag.
- Variations
[]Get
Feature Flag Variation - 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.
- project
Key String - The feature flag's project key.
- archived Boolean
- client
Side List<GetAvailabilities Feature Flag Client Side Availability> - 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.
- custom
Properties List<GetFeature Flag Custom Property> - List of nested blocks describing the feature flag's custom properties. To learn more, read Nested Custom Properties.
- defaults
Get
Feature Flag Defaults - 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.
- include
In BooleanSnippet - Deprecated A boolean describing whether this flag has been made available to the client-side Javescript SDK using the client-side ID only.
include_in_snippetis now deprecated. Please retrieve information fromclient_side_availability.using_environment_idto maintain future compatability. - maintainer
Id String - The feature flag maintainer's 24 character alphanumeric team member ID.
- List<String>
- Set of feature flag tags.
- temporary Boolean
- Whether the flag is a temporary flag.
- variations
List<Get
Feature Flag Variation> - 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.
- project
Key string - The feature flag's project key.
- archived boolean
- client
Side GetAvailabilities Feature Flag Client Side Availability[] - 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.
- custom
Properties GetFeature Flag Custom Property[] - List of nested blocks describing the feature flag's custom properties. To learn more, read Nested Custom Properties.
- defaults
Get
Feature Flag Defaults - 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.
- include
In booleanSnippet - Deprecated A boolean describing whether this flag has been made available to the client-side Javescript SDK using the client-side ID only.
include_in_snippetis now deprecated. Please retrieve information fromclient_side_availability.using_environment_idto maintain future compatability. - maintainer
Id string - The feature flag maintainer's 24 character alphanumeric team member ID.
- string[]
- Set of feature flag tags.
- temporary boolean
- Whether the flag is a temporary flag.
- variations
Get
Feature Flag Variation[] - 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
- client_
side_ Sequence[Getavailabilities Feature Flag Client Side Availability] - 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.
- custom_
properties Sequence[GetFeature Flag Custom Property] - List of nested blocks describing the feature flag's custom properties. To learn more, read Nested Custom Properties.
- defaults
Get
Feature Flag Defaults - 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_ boolsnippet - Deprecated A boolean describing whether this flag has been made available to the client-side Javescript SDK using the client-side ID only.
include_in_snippetis now deprecated. Please retrieve information fromclient_side_availability.using_environment_idto maintain future compatability. - maintainer_
id str - The feature flag maintainer's 24 character alphanumeric team member ID.
- Sequence[str]
- Set of feature flag tags.
- temporary bool
- Whether the flag is a temporary flag.
- variations
Sequence[Get
Feature Flag Variation] - 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.
- project
Key String - The feature flag's project key.
- archived Boolean
- client
Side List<Property Map>Availabilities - 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.
- custom
Properties 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.
- include
In BooleanSnippet - Deprecated A boolean describing whether this flag has been made available to the client-side Javescript SDK using the client-side ID only.
include_in_snippetis now deprecated. Please retrieve information fromclient_side_availability.using_environment_idto maintain future compatability. - maintainer
Id String - The feature flag maintainer's 24 character alphanumeric team member ID.
- 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:
- Client
Side List<Lbrlabs.Availabilities Pulumi Package. Launchdarkly. Outputs. Get Feature Flag Client Side Availability> - 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.
Pulumi Package. Launchdarkly. Outputs. Get Feature Flag Defaults - 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.
- Include
In boolSnippet - Deprecated A boolean describing whether this flag has been made available to the client-side Javescript SDK using the client-side ID only.
include_in_snippetis now deprecated. Please retrieve information fromclient_side_availability.using_environment_idto maintain future compatability. - Key string
- The unique custom property key.
- Maintainer
Id string - The feature flag maintainer's 24 character alphanumeric team member ID.
- Name string
- The name of the custom property.
- Project
Key string - Variation
Type string - The feature flag's variation type:
boolean,string,numberorjson. - Variations
List<Lbrlabs.
Pulumi Package. Launchdarkly. Outputs. Get Feature Flag Variation> - List of nested blocks describing the variations associated with the feature flag. To learn more, read Nested Variations Blocks.
- Archived bool
- Custom
Properties List<Lbrlabs.Pulumi Package. Launchdarkly. Outputs. Get Feature Flag Custom Property> - List of nested blocks describing the feature flag's custom properties. To learn more, read Nested Custom Properties.
- Description string
- The variation's description.
- List<string>
- Set of feature flag tags.
- Temporary bool
- Whether the flag is a temporary flag.
- Client
Side []GetAvailabilities Feature Flag Client Side Availability - 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
Get
Feature Flag Defaults - 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.
- Include
In boolSnippet - Deprecated A boolean describing whether this flag has been made available to the client-side Javescript SDK using the client-side ID only.
include_in_snippetis now deprecated. Please retrieve information fromclient_side_availability.using_environment_idto maintain future compatability. - Key string
- The unique custom property key.
- Maintainer
Id string - The feature flag maintainer's 24 character alphanumeric team member ID.
- Name string
- The name of the custom property.
- Project
Key string - Variation
Type string - The feature flag's variation type:
boolean,string,numberorjson. - Variations
[]Get
Feature Flag Variation - List of nested blocks describing the variations associated with the feature flag. To learn more, read Nested Variations Blocks.
- Archived bool
- Custom
Properties []GetFeature Flag Custom Property - List of nested blocks describing the feature flag's custom properties. To learn more, read Nested Custom Properties.
- Description string
- The variation's description.
- []string
- Set of feature flag tags.
- Temporary bool
- Whether the flag is a temporary flag.
- client
Side List<GetAvailabilities Feature Flag Client Side Availability> - 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
Get
Feature Flag Defaults - 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.
- include
In BooleanSnippet - Deprecated A boolean describing whether this flag has been made available to the client-side Javescript SDK using the client-side ID only.
include_in_snippetis now deprecated. Please retrieve information fromclient_side_availability.using_environment_idto maintain future compatability. - key String
- The unique custom property key.
- maintainer
Id String - The feature flag maintainer's 24 character alphanumeric team member ID.
- name String
- The name of the custom property.
- project
Key String - variation
Type String - The feature flag's variation type:
boolean,string,numberorjson. - variations
List<Get
Feature Flag Variation> - List of nested blocks describing the variations associated with the feature flag. To learn more, read Nested Variations Blocks.
- archived Boolean
- custom
Properties List<GetFeature Flag Custom Property> - List of nested blocks describing the feature flag's custom properties. To learn more, read Nested Custom Properties.
- description String
- The variation's description.
- List<String>
- Set of feature flag tags.
- temporary Boolean
- Whether the flag is a temporary flag.
- client
Side GetAvailabilities Feature Flag Client Side Availability[] - 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
Get
Feature Flag Defaults - 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.
- include
In booleanSnippet - Deprecated A boolean describing whether this flag has been made available to the client-side Javescript SDK using the client-side ID only.
include_in_snippetis now deprecated. Please retrieve information fromclient_side_availability.using_environment_idto maintain future compatability. - key string
- The unique custom property key.
- maintainer
Id string - The feature flag maintainer's 24 character alphanumeric team member ID.
- name string
- The name of the custom property.
- project
Key string - variation
Type string - The feature flag's variation type:
boolean,string,numberorjson. - variations
Get
Feature Flag Variation[] - List of nested blocks describing the variations associated with the feature flag. To learn more, read Nested Variations Blocks.
- archived boolean
- custom
Properties GetFeature Flag Custom Property[] - List of nested blocks describing the feature flag's custom properties. To learn more, read Nested Custom Properties.
- description string
- The variation's description.
- string[]
- Set of feature flag tags.
- temporary boolean
- Whether the flag is a temporary flag.
- client_
side_ Sequence[Getavailabilities Feature Flag Client Side Availability] - 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
Get
Feature Flag Defaults - 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.
- include_
in_ boolsnippet - Deprecated A boolean describing whether this flag has been made available to the client-side Javescript SDK using the client-side ID only.
include_in_snippetis now deprecated. Please retrieve information fromclient_side_availability.using_environment_idto maintain future compatability. - 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,numberorjson. - variations
Sequence[Get
Feature Flag Variation] - List of nested blocks describing the variations associated with the feature flag. To learn more, read Nested Variations Blocks.
- archived bool
- custom_
properties Sequence[GetFeature Flag Custom Property] - List of nested blocks describing the feature flag's custom properties. To learn more, read Nested Custom Properties.
- description str
- The variation's description.
- Sequence[str]
- Set of feature flag tags.
- temporary bool
- Whether the flag is a temporary flag.
- client
Side List<Property Map>Availabilities - 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.
- include
In BooleanSnippet - Deprecated A boolean describing whether this flag has been made available to the client-side Javescript SDK using the client-side ID only.
include_in_snippetis now deprecated. Please retrieve information fromclient_side_availability.using_environment_idto maintain future compatability. - key String
- The unique custom property key.
- maintainer
Id String - The feature flag maintainer's 24 character alphanumeric team member ID.
- name String
- The name of the custom property.
- project
Key String - variation
Type String - The feature flag's variation type:
boolean,string,numberorjson. - 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
- custom
Properties 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.
- List<String>
- Set of feature flag tags.
- temporary Boolean
- Whether the flag is a temporary flag.
Supporting Types
GetFeatureFlagClientSideAvailability
- Using
Environment boolId - When set to true, this flag is available to SDKs using the client-side ID.
- Using
Mobile boolKey - When set to true, this flag is available to SDKs using a mobile key.
- Using
Environment boolId - When set to true, this flag is available to SDKs using the client-side ID.
- Using
Mobile boolKey - When set to true, this flag is available to SDKs using a mobile key.
- using
Environment BooleanId - When set to true, this flag is available to SDKs using the client-side ID.
- using
Mobile BooleanKey - When set to true, this flag is available to SDKs using a mobile key.
- using
Environment booleanId - When set to true, this flag is available to SDKs using the client-side ID.
- using
Mobile booleanKey - When set to true, this flag is available to SDKs using a mobile key.
- using_
environment_ boolid - When set to true, this flag is available to SDKs using the client-side ID.
- using_
mobile_ boolkey - When set to true, this flag is available to SDKs using a mobile key.
- using
Environment BooleanId - When set to true, this flag is available to SDKs using the client-side ID.
- using
Mobile BooleanKey - When set to true, this flag is available to SDKs using a mobile key.
GetFeatureFlagCustomProperty
GetFeatureFlagDefaults
- 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.
- 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.
- off
Variation Integer - (Required) The index of the variation the flag will default to in all new environments when off.
- on
Variation Integer - (Required) The index of the variation the flag will default to in all new environments when on.
- off
Variation number - (Required) The index of the variation the flag will default to in all new environments when off.
- on
Variation 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.
- off
Variation Number - (Required) The index of the variation the flag will default to in all new environments when off.
- on
Variation 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
- launchdarkly lbrlabs/pulumi-launchdarkly
- License
- Notes
- This Pulumi package is based on the
launchdarklyTerraform Provider.
Viewing docs for Launch Darkly v0.0.6
published on Sunday, Feb 19, 2023 by lbrlabs
published on Sunday, Feb 19, 2023 by lbrlabs
