launchdarkly_environment – Create Launchdarkly Project specific Environment¶
New in version 0.1.0.
Parameters¶
Parameter | Choices/Defaults | Comments |
---|---|---|
api_key
string
/ required
|
LaunchDarkly API Key. May be set as
LAUNCHDARKLY_ACCESS_TOKEN environment variable. |
|
color
string
|
Color used in dashboard for the environment.
|
|
confirm_changes
boolean
|
|
Determines if this environment requires confirmation for flag and segment changes.
|
default_track_events
boolean
|
|
Set to `true` to send detailed event information for new flags.
|
default_ttl
integer
|
TTL is only used in our PHP SDK.
|
|
environment_key
string
/ required
|
A unique key that will be used to reference the flag in your code.
|
|
name
string
|
Display name for the environment.
|
|
project_key
-
|
Default: "default"
|
Project key will group flags together
|
require_comments
boolean
|
|
Determines if this environment requires comments for flag and segment changes.
|
secure_mode
-
|
Determines if this environment is in safe mode.
|
|
state
string
|
|
Indicate desired state of the resource
|
tags
string
|
An array of tags for this environment.
|
Examples¶
---
# Create a new LaunchDarkly Environment
- launchdarkly_environment:
state: present
project_key: test-project-1
environment_key: test_environment-1
color: C9C9C9
# Create a new LaunchDarkly Environment and tag it
- launchdarkly_environment:
state: present
project_key: test-project-1
environment_key: test_environment-1
color: C9C9C9
tags:
- blue
- green
Return Values¶
Common return values are documented here, the following are the fields unique to this :
Key | Returned | Description |
---|---|---|
environment
dictionary
|
on success |
Returns dictionary containing an Environment
|
Status¶
This is not guaranteed to have a backwards compatible interface. [preview]
This is maintained by the Ansible Community. [community]
Hint
If you notice any issues in this documentation, you can edit this document to improve it.
Hint
Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.