StateMachine
sfn.services.k8s.aws/v1alpha1
| Type | Link |
|---|---|
| GoDoc | sfn-controller/apis/v1alpha1#StateMachine |
Metadata
| Property | Value |
|---|---|
| Scope | Namespaced |
| Kind | StateMachine |
| ListKind | StateMachineList |
| Plural | statemachines |
| Singular | statemachine |
Spec
definition: string
loggingConfiguration:
destinations:
cloudWatchLogsLogGroup:
logGroupARN: string
includeExecutionData: boolean
level: string
name: string
roleARN: string
tags:
- key: string
value: string
tracingConfiguration:
enabled: boolean
type_: string
| Field | Description |
|---|---|
| definition Required | string The Amazon States Language definition of the state machine. See Amazon States Language (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html). |
| loggingConfiguration Optional | object Defines what execution history events are logged and where they are logged. By default, the level is set to OFF. For more information see Log Levels (https://docs.aws.amazon.com/step-functions/latest/dg/cloudwatch-log-level.html) in the AWS Step Functions User Guide. |
| loggingConfiguration.destinations Optional | array |
| loggingConfiguration.destinations.[] Required | object |
| loggingConfiguration.destinations.[].cloudWatchLogsLogGroup.logGroupARN Optional | string |
| loggingConfiguration.includeExecutionData Optional | boolean |
| loggingConfiguration.level Optional | string |
| name Required | string The name of the state machine. A name must not contain: * white space * brackets < > { } [ ] * wildcard characters ? * * special characters " # % \ ^ |
| roleARN Required | string The Amazon Resource Name (ARN) of the IAM role to use for this state machine. |
| tags Optional | array Tags to be added when creating a state machine. An array of key-value pairs. For more information, see Using Cost Allocation Tags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) in the AWS Billing and Cost Management User Guide, and Controlling Access Using IAM Tags (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html). Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @. |
| tags.[] Required | object Tags are key-value pairs that can be associated with Step Functions state machines and activities. |
| An array of key-value pairs. For more information, see Using Cost Allocation Tags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) in the AWS Billing and Cost Management User Guide, and Controlling Access Using IAM Tags (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html). | |
| Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @. | |
| tags.[].value Optional | string |
| tracingConfiguration Optional | object Selects whether AWS X-Ray tracing is enabled. |
| tracingConfiguration.enabled Optional | boolean |
| **type_** Optional | string Determines whether a Standard or Express state machine is created. The default is STANDARD. You cannot update the type of a state machine once it has been created. |
Status
ackResourceMetadata:
arn: string
ownerAccountID: string
region: string
conditions:
- lastTransitionTime: string
message: string
reason: string
status: string
type: string
creationDate: string
| Field | Description |
|---|---|
| ackResourceMetadata Optional | object All CRs managed by ACK have a common Status.ACKResourceMetadata member that is used to contain resource sync state, account ownership, constructed ARN for the resource |
| ackResourceMetadata.arn Optional | string ARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an “adopted” resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR’s Spec field values. TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse https://github.com/aws/aws-controllers-k8s/issues/270 |
| ackResourceMetadata.ownerAccountID Required | string OwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource. |
| ackResourceMetadata.region Required | string Region is the AWS region in which the resource exists or will exist. |
| conditions Optional | array All CRS managed by ACK have a common Status.Conditions member that contains a collection of ackv1alpha1.Condition objects that describe the various terminal states of the CR and its backend AWS service API resource |
| conditions.[] Required | object Condition is the common struct used by all CRDs managed by ACK service controllers to indicate terminal states of the CR and its backend AWS service API resource |
| conditions.[].message Optional | string A human readable message indicating details about the transition. |
| conditions.[].reason Optional | string The reason for the condition’s last transition. |
| conditions.[].status Optional | string Status of the condition, one of True, False, Unknown. |
| conditions.[].type Optional | string Type is the type of the Condition |
| creationDate Optional | string The date the state machine is created. |