Skip to content

Latest commit

 

History

History
545 lines (507 loc) · 29.6 KB

community.missing_collection.aws_appstream_info_module.rst

File metadata and controls

545 lines (507 loc) · 29.6 KB
Raw

community.missing_collection.aws_appstream_info

Get details about Amazon AppStream 2.0.

Version added: 0.0.2

Synopsis

Requirements

The below requirements are needed on the host that executes this module.

  • boto
  • boto3
  • botocore
  • python >= 2.6

Parameters

Parameter Choices/Defaults Comments
authentication_type
string
    Choices:
  • API
  • SAML
  • USERPOOL ←
what type of authentication for describe_user?
aws_access_key
string
AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
If profile is set this parameter is ignored.
Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: ec2_access_key, access_key
aws_ca_bundle
path
The location of a CA Bundle to use when validating SSL certificates.
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
aws_config
dictionary
A dictionary to modify the botocore configuration.
Only the 'user_agent' key is used for boto modules. See http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto for more boto configuration.
aws_secret_key
string
AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
If profile is set this parameter is ignored.
Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: ec2_secret_key, secret_key
debug_botocore_endpoint_logs
boolean
    Choices:
  • no ←
  • yes
Use a botocore.endpoint logger to parse the unique (rather than total) "resource:action" API calls made during a task, outputing the set to the resource_actions key in the task results. Use the aws_resource_action callback to output to total list made during a playbook. The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also be used.
describe_directory_configs
boolean
    Choices:
  • no
  • yes
do you want to describe all appstreams directory configs or given names of directory configs?
describe_fleets
boolean
    Choices:
  • no
  • yes
do you want to describe all appstreams fleet or given names of fleets?
describe_image_builders
boolean
    Choices:
  • no
  • yes
do you want to describe all appstreams image builders or given names of builders?
describe_images
boolean
    Choices:
  • no
  • yes
do you want to describe all appstreams images or given names of images?
describe_users
boolean
    Choices:
  • no
  • yes
do you want to describe appstreams user or given authentication_type?
ec2_url
string
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
image_type
string
    Choices:
  • PUBLIC ←
  • PRIVATE
  • SHARED
what type of image will be decribed?
names
list
Default:
[]
can be names of the fleets to describe?
can be names of the stacks to describe?
can be aws app stream directory names to describe?
can be names of the image builders to describe?
can be names of the public or private images to describe?
profile
string
Uses a boto profile. Only works with boto >= 2.24.0.
Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

aliases: aws_profile
region
string
The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region

aliases: aws_region, ec2_region
security_token
string
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
If profile is set this parameter is ignored.
Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: aws_security_token, access_token
validate_certs
boolean
    Choices:
  • no
  • yes ←
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.

Notes

Note

  • If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence AWS_URL or EC2_URL, AWS_PROFILE or AWS_DEFAULT_PROFILE, AWS_ACCESS_KEY_ID or AWS_ACCESS_KEY or EC2_ACCESS_KEY, AWS_SECRET_ACCESS_KEY or AWS_SECRET_KEY or EC2_SECRET_KEY, AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN, AWS_REGION or EC2_REGION, AWS_CA_BUNDLE
  • Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html
  • AWS_REGION or EC2_REGION can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file

Examples

- name: "describe all fleets of aws app streams"
  aws_appstream_info:
    describe_fleets: true

- name: "describe all directory configs of aws app streams"
  aws_appstream_info:
    describe_directory_configs: true

- name: "describe all image builder of aws app streams"
  aws_appstream_info:
    describe_image_builders: true

- name: "describe all images of aws app streams"
  aws_appstream_info:
    describe_images: true
    image_type: 'PRIVATE'

- name: "describe all users of aws app streams"
  aws_appstream_info:
    describe_users: true
    authentication_type: 'USERPOOL'

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
directory_configs
list
when `names` and `describe_directory_configs` are defined and success
Retrieves a list that describes one or more specified Directory Config objects for AppStream 2.0, if the names for these objects are provided.

Sample:
[{'directory_name': 'string', 'organizational_unit_distinguished_names': [], 'service_account_credentials': {}, 'created_time': 'datetime(2015', 1: None, '1)': None}]
fleets
list
when `names` and `describe_fleets` are defined and success
Retrieves a list that describes one or more specified fleets, if the fleet names are provided.

Sample:
[{'arn': 'string', 'name': 'string', 'display_name': 'string', 'description': 'string', 'image_name': 'string', 'image_arn': 'string', 'instance_type': 'string', 'fleet_type': 'ALWAYS_ON', 'compute_capacity_status': {}, 'max_user_duration_in_seconds': 123, 'disconnect_timeout_in_seconds': 123, 'state': 'STARTING', 'vpc_config': {}, 'created_time': 'datetime(2015', 1: None, '1)': None, 'fleet_errors': [], 'enable_default_internet_access': True, 'domain_join_info': {}, 'idle_disconnect_timeout_in_seconds': 123, 'iam_role_arn': 'string', 'stream_view': 'APP'}]
image_builders
list
when `names` and `describe_image_builders` are defined and success
Retrieves a list that describes one or more specified image builders, if the image builder names are provided.

Sample:
[{'name': 'string', 'arn': 'string', 'image_arn': 'string', 'description': 'string', 'display_name': 'string', 'vpc_config': {}, 'instance_type': 'string', 'platform': 'WINDOWS', 'iam_role_arn': 'string', 'state': 'PENDING', 'state_change_reason': {}, 'created_time': 'datetime(2015', 1: None, '1)': None, 'enable_default_internet_access': True, 'domain_join_info': {}, 'network_access_configuration': {}, 'image_builder_errors': [], 'appstream_agent_version': 'string', 'access_endpoints': []}]
images
list
when `names` and `describe_images` and `image_type` are defined and success
Retrieves a list that describes one or more specified images, if the image names are provided.

Sample:
[{'name': 'string', 'arn': 'string', 'base_image_arn': 'string', 'display_name': 'string', 'state': 'PENDING', 'visibility': 'PUBLIC', 'image_builder_supported': 'True|False', 'image_builder_name': 'string', 'platform': 'WINDOWS', 'description': 'string', 'state_change_reason': {}, 'applications': [], 'created_time': 'datetime(2016', 10: None, '11)': None, 'public_base_image_released_date': 'datetime(2015', 1: None, '1)': None, 'appstream_agent_version': 'string', 'image_permissions': {}}]
stacks
list
when `names` and `describe_stacks` are defined and success
Retrieves a list that describes one or more specified stacks, if the stack names are provided.

Sample:
[{'arn': 'string', 'name': 'string', 'description': 'string', 'display_name': 'string', 'created_time': 'datetime(2015', 1: None, '1)': None, 'storage_connectors': [], 'redirect_url': 'string', 'feedback_url': 'string', 'stack_errors': [], 'user_settings': [], 'application_settings': {}, 'access_endpoints': [], 'embed_host_domains': []}]
users
list
when `describe_users` and `authentication_type` are defined and success
Retrieves a list that describes one or more specified users in the user pool.

Sample:
[{'arn': 'string', 'user_name': 'string', 'enabled': True, 'status': 'string', 'first_name': 'string', 'last_name': 'string', 'created_time': 'datetime(2015', 1: None, '1)': None, 'authentication_type': 'USERPOOL'}]


Status

Authors