launchdarkly_user_segment – Manage User Segments¶
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. |
|
description
string
|
Add a user friendly description for this user segment.
|
|
environment_key
string
/ required
|
A unique key that will be used to reference the environment.
|
|
excluded
list
|
Manage a list of excluded users for the user segment.
|
|
included
list
|
Manage a list of included users for the user segment.
|
|
name
string
/ required
|
Display name for the user segment.
|
|
project_key
-
|
Default: "default"
|
Project key will group flags together
|
state
-
|
|
Indicate desired state of the resource
|
tags
list
|
Manage a list of tags associated with the user segment.
|
|
user_segment_key
-
|
A unique key that will be used to reference the user segment in this environment.
|
Examples¶
# Create a new LaunchDarkly User Segment
- launchdarkly_user_segment:
state: present
project_key: test-project-1
environment_key: test-environment-1
user_segment_key: test-key-1
name: "Test Segment"
description: "This is a testing segment"
rules:
- clauses:
- attribute: test-attribute
op: contains
values:
- 2
- 3
negate: true
tags:
- blue
- green
included:
- test1@example.com
- test2@example.com
excluded:
- test3@example.com
- test4@example.com
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.