iam_saml_federation
Maintain IAM SAML federation configuration
Collection: community.aws
Full Name: community.aws.iam_saml_federation
Synopsis
Maintain IAM SAML federation configuration
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| access_key | str | |||
| aws_ca_bundle | path | |||
| aws_config | dict | |||
| debug_botocore_endpoint_logs | bool | false | ||
| endpoint_url | str | |||
| name | str | yes | ||
| profile | str | |||
| region | str | |||
| saml_metadata_document | str | |||
| secret_key | str | |||
| session_token | str | |||
| state | str | present | ||
| validate_certs | bool | true |
Example
yaml
# 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