community / community.aws / 3.4.0 / module / aws_step_functions_state_machine Manage AWS Step Functions state machines | "added in version" 1.0.0 of community.aws" Authors: Tom De Keyser (@tdekeyser)community.aws.aws_step_functions_state_machine (3.4.0) — module
Install with ansible-galaxy collection install community.aws:==3.4.0
collections: - name: community.aws version: 3.4.0
Create, update and delete state machines in AWS Step Functions.
Calling the module in C(state=present) for an existing AWS Step Functions state machine will attempt to update the state machine definition, IAM Role, or tags with the provided data.
# Create a new AWS Step Functions state machine - name: Setup HelloWorld state machine community.aws.aws_step_functions_state_machine: name: "HelloWorldStateMachine" definition: "{{ lookup('file','state_machine.json') }}" role_arn: arn:aws:iam::987654321012:role/service-role/invokeLambdaStepFunctionsRole tags: project: helloWorld
# Update an existing state machine - name: Change IAM Role and tags of HelloWorld state machine community.aws.aws_step_functions_state_machine: name: HelloWorldStateMachine definition: "{{ lookup('file','state_machine.json') }}" role_arn: arn:aws:iam::987654321012:role/service-role/anotherStepFunctionsRole tags: otherTag: aDifferentTag
# Remove the AWS Step Functions state machine - name: Delete HelloWorld state machine community.aws.aws_step_functions_state_machine: name: HelloWorldStateMachine state: absent
name: description: - Name of the state machine required: true type: str tags: description: - A hash/dictionary of tags to add to the new state machine or to add/remove from an existing one. type: dict state: choices: - present - absent default: present description: - Desired state for the state machine 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 role_arn: description: - The ARN of the IAM Role that will be used by the state machine for its executions. - This parameter is required when C(state=present). 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 definition: description: - The Amazon States Language definition of the state machine. See U(https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html) for more information on the Amazon States Language. - This parameter is required when C(state=present). type: json purge_tags: default: true description: - If yes, 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. type: bool 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 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
state_machine_arn: description: ARN of the AWS Step Functions state machine returned: always type: str