community / community.aws / 5.1.0 / module / eks_fargate_profile Manage EKS Fargate Profile | "added in version" 4.0.0 of community.aws" Authors: Tiago Jarra (@tjarra)community.aws.eks_fargate_profile (5.1.0) — module
Install with ansible-galaxy collection install community.aws:==5.1.0
collections: - name: community.aws version: 5.1.0
Manage EKS Fargate Profile.
# Note: These examples do not set authentication details, see the AWS Guide for details. - name: Create an EKS Fargate Profile community.aws.eks_fargate_profile: name: test_fargate cluster_name: test_cluster role_arn: my_eks_role subnets: - subnet-aaaa1111 selectors: - namespace: nm-test labels: - label1: test state: present wait: true
- name: Remove an EKS Fargate Profile community.aws.eks_fargate_profile: name: test_fargate cluster_name: test_cluster wait: true state: absent
name: description: Name of EKS Fargate Profile. required: true type: str tags: aliases: - resource_tags description: - A dictionary representing the tags to be applied to the resource. - If the I(tags) parameter is not set then tags will not be modified. required: false type: dict wait: default: false description: Specifies whether the module waits until the profile is created or deleted before moving on. type: bool state: choices: - absent - present default: present description: Create or delete the Fargate Profile. type: str region: aliases: - aws_region - ec2_region description: - The AWS region to use. - For global services such as IAM, Route53 and CloudFront, I(region) is ignored. - The C(AWS_REGION) or C(EC2_REGION) environment variables may also be used. - See the Amazon AWS documentation for more information U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region). - The C(ec2_region) alias has been deprecated and will be removed in a release after 2024-12-01 - Support for the C(EC2_REGION) environment variable has been deprecated and will be removed in a release after 2024-12-01. type: str profile: aliases: - aws_profile description: - A named AWS profile to use for authentication. - See the AWS documentation for more information about named profiles U(https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html). - The C(AWS_PROFILE) environment variable may also be used. - The I(profile) option is mutually exclusive with the I(aws_access_key), I(aws_secret_key) and I(security_token) options. type: str subnets: description: - list of subnet IDs for the Kubernetes cluster. - Required when I(state=present). elements: str type: list role_arn: description: - ARN of IAM role used by the EKS cluster. - Required when I(state=present). type: str selectors: description: - A list of selectors to use in fargate profile. - Required when I(state=present). elements: dict suboptions: labels: default: {} description: A dictionary of labels used in fargate profile. type: dict namespace: description: A namespace used in fargate profile. type: str type: list access_key: aliases: - aws_access_key_id - aws_access_key - ec2_access_key description: - AWS access key ID. - See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys). - The C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY) or C(EC2_ACCESS_KEY) environment variables may also be used in decreasing order of preference. - The I(aws_access_key) and I(profile) options are mutually exclusive. - The I(aws_access_key_id) alias was added in release 5.1.0 for consistency with the AWS botocore SDK. - The I(ec2_access_key) alias has been deprecated and will be removed in a release after 2024-12-01. - Support for the C(EC2_ACCESS_KEY) environment variable has been deprecated and will be removed in a release after 2024-12-01. type: str aws_config: description: - A dictionary to modify the botocore configuration. - Parameters can be found in the AWS documentation U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config). type: dict purge_tags: default: true description: - If I(purge_tags=true) and I(tags) is set, existing tags will be purged from the resource to match exactly what is defined by I(tags) parameter. - If the I(tags) parameter is not set then tags will not be modified, even if I(purge_tags=True). - Tag keys beginning with C(aws:) are reserved by Amazon and can not be modified. As such they will be ignored for the purposes of the I(purge_tags) parameter. See the Amazon documentation for more information U(https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions). required: false type: bool secret_key: aliases: - aws_secret_access_key - aws_secret_key - ec2_secret_key description: - AWS secret access key. - See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys). - The C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY), or C(EC2_SECRET_KEY) environment variables may also be used in decreasing order of preference. - The I(secret_key) and I(profile) options are mutually exclusive. - The I(aws_secret_access_key) alias was added in release 5.1.0 for consistency with the AWS botocore SDK. - The I(ec2_secret_key) alias has been deprecated and will be removed in a release after 2024-12-01. - Support for the C(EC2_SECRET_KEY) environment variable has been deprecated and will be removed in a release after 2024-12-01. type: str cluster_name: description: Name of EKS Cluster. required: true type: str endpoint_url: aliases: - ec2_url - aws_endpoint_url - s3_url description: - URL to connect to instead of the default AWS endpoints. While this can be used to connection to other AWS-compatible services the amazon.aws and community.aws collections are only tested against AWS. - The C(AWS_URL) or C(EC2_URL) environment variables may also be used, in decreasing order of preference. - The I(ec2_url) and I(s3_url) aliases have been deprecated and will be removed in a release after 2024-12-01. - Support for the C(EC2_URL) environment variable has been deprecated and will be removed in a release after 2024-12-01. type: str wait_timeout: default: 1200 description: The duration in seconds to wait for the cluster to become active. Defaults to 1200 seconds (20 minutes). type: int aws_ca_bundle: description: - The location of a CA Bundle to use when validating SSL certificates. - The C(AWS_CA_BUNDLE) environment variable may also be used. type: path session_token: aliases: - aws_session_token - security_token - aws_security_token - access_token description: - AWS STS session token for use with temporary credentials. - See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys). - The C(AWS_SESSION_TOKEN), C(AWS_SECURITY_TOKEN) or C(EC2_SECURITY_TOKEN) environment variables may also be used in decreasing order of preference. - The I(security_token) and I(profile) options are mutually exclusive. - Aliases I(aws_session_token) and I(session_token) were added in release 3.2.0, with the parameter being renamed from I(security_token) to I(session_token) in release 6.0.0. - The I(security_token), I(aws_security_token), and I(access_token) aliases have been deprecated and will be removed in a release after 2024-12-01. - Support for the C(EC2_SECRET_KEY) and C(AWS_SECURITY_TOKEN) environment variables has been deprecated and will be removed in a release after 2024-12-01. type: str validate_certs: default: true description: - When set to C(false), SSL certificates will not be validated for communication with the AWS APIs. - Setting I(validate_certs=false) is strongly discouraged, as an alternative, consider setting I(aws_ca_bundle) instead. type: bool debug_botocore_endpoint_logs: default: false description: - Use a C(botocore.endpoint) logger to parse the unique (rather than total) C("resource:action") API calls made during a task, outputing the set to the resource_actions key in the task results. Use the C(aws_resource_action) callback to output to total list made during a playbook. - The C(ANSIBLE_DEBUG_BOTOCORE_LOGS) environment variable may also be used. type: bool
cluster_name: description: Name of EKS Cluster. returned: when state is present sample: test-cluster type: str created_at: description: Fargate Profile creation date and time. returned: when state is present sample: '2022-01-18T20:00:00.111000+00:00' type: str fargate_profile_arn: description: ARN of the Fargate Profile. returned: when state is present sample: arn:aws:eks:us-east-1:1231231123:safd type: str fargate_profile_name: description: Name of Fargate Profile. returned: when state is present sample: test_profile type: str pod_execution_role_arn: description: ARN of the IAM Role used by Fargate Profile. returned: when state is present sample: arn:aws:eks:us-east-1:1231231123:role/asdf type: str selectors: contains: labels: description: List of kubernetes labels used in profile. returned: when state is present sample: - label1: test1 - label2: test2 type: list namespace: description: Name of the kubernetes namespace used in profile. returned: when state is present sample: nm-test type: str description: Selector configuration. returned: when state is present type: complex status: description: status of the EKS Fargate Profile. returned: when state is present sample: - CREATING - ACTIVE type: str subnets: description: List of subnets used in Fargate Profile. returned: when state is present sample: - subnet-qwerty123 - subnet-asdfg456 type: list tags: description: A dictionary of resource tags. returned: when state is present sample: env: test foo: bar type: dict