community / community.aws / 0.1.2 / module / iam_saml_federation Maintain IAM SAML federation configuration. | "added in version" 1.0.0 of community.aws" Authors: Tony (@axc450), Aidan Rowe (@aidan-)community.aws.iam_saml_federation (0.1.2) — module
Install with ansible-galaxy collection install community.aws:==0.1.2
collections: - name: community.aws version: 0.1.2
Provides a mechanism to manage AWS IAM SAML Identity Federation providers (create/update/delete metadata).
# Note: These examples do not set authentication details, see the AWS Guide for details. # It is assumed that their matching environment variables are set. # Creates a new iam saml identity provider if not present - name: saml provider community.aws.iam_saml_federation: name: example1 # the > below opens an indented block, so no escaping/quoting is needed when in the indentation level under this key saml_metadata_document: > <?xml version="1.0"?>... <md:EntityDescriptor
# Creates a new iam saml identity provider if not present - name: saml provider community.aws.iam_saml_federation: name: example2 saml_metadata_document: "{{ item }}" with_file: /path/to/idp/metdata.xml
# Removes iam saml identity provider - name: remove saml provider community.aws.iam_saml_federation: name: example3 state: absent
name: description: - The name of the provider to create. required: true type: str state: choices: - present - absent default: present description: - Whether to create or delete identity provider. If 'present' is specified it will attempt to update the identity provider matching the name field. type: str region: aliases: - aws_region - ec2_region description: - 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 U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region) type: str ec2_url: aliases: - aws_endpoint_url - endpoint_url description: - 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. type: str profile: aliases: - aws_profile description: - Using I(profile) will override I(aws_access_key), I(aws_secret_key) and I(security_token) and support for passing them at the same time as I(profile) has been deprecated. - I(aws_access_key), I(aws_secret_key) and I(security_token) will be made mutually exclusive with I(profile) after 2022-06-01. type: str aws_config: description: - A dictionary to modify the botocore configuration. - Parameters can be found at U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config). - Only the 'user_agent' key is used for boto modules. See U(http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto) for more boto configuration. type: dict aws_ca_bundle: description: - The location of a CA Bundle to use when validating SSL certificates. - Not used by boto 2 based modules. - 'Note: The CA Bundle is read ''module'' side and may need to be explicitly copied from the controller if not run locally.' type: path aws_access_key: aliases: - ec2_access_key - access_key description: - C(AWS access key). If not set then the value of the C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY) or C(EC2_ACCESS_KEY) environment variable is used. - If I(profile) is set this parameter is ignored. - Passing the I(aws_access_key) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. type: str aws_secret_key: aliases: - ec2_secret_key - secret_key description: - C(AWS secret key). If not set then the value of the C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY), or C(EC2_SECRET_KEY) environment variable is used. - If I(profile) is set this parameter is ignored. - Passing the I(aws_secret_key) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. type: str security_token: aliases: - aws_security_token - access_token description: - C(AWS STS security token). If not set then the value of the C(AWS_SECURITY_TOKEN) or C(EC2_SECURITY_TOKEN) environment variable is used. - If I(profile) is set this parameter is ignored. - Passing the I(security_token) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. type: str validate_certs: default: true description: - When set to "no", SSL certificates will not be validated for communication with the AWS APIs. type: bool saml_metadata_document: description: - The XML document generated by an identity provider (IdP) that supports SAML 2.0. type: str debug_botocore_endpoint_logs: default: 'no' description: - 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. type: bool
saml_provider: contains: arn: description: The ARN of the identity provider. returned: present sample: arn:aws:iam::123456789012:saml-provider/my_saml_provider type: str create_date: description: The date and time when the SAML provider was created in ISO 8601 date-time format. returned: present sample: '2017-02-08T04:36:28+00:00' type: str expire_date: description: The expiration date and time for the SAML provider in ISO 8601 date-time format. returned: present sample: '2017-02-08T04:36:28+00:00' type: str metadata_document: description: The XML metadata document that includes information about an identity provider. returned: present type: str description: Details of the SAML Identity Provider that was created/modified. returned: present type: complex