Step Functions

4 resource kinds. Generated from the operator's CRD schemas.

API Group: aws.konfig.io/v1alpha1

Activity # GA

Activity is the Schema for managing Step Functions activities.

kubectl get activities · example on GitHub

Example

# Activity — Step Functions
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/sfn.html#activity
apiVersion: aws.konfig.io/v1alpha1
kind: Activity
metadata:
  name: example-activity
  namespace: default
spec:
  name: example-activity
  providerRef:
    name: example-activity
    region: us-east-1
  tags:
    environment: dev
    team: platform

Spec

Field	Type	Required	Description
`name`	string	yes	Name is the name of the activity.
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`tags`	map<string>	—	Tags are metadata tags for the activity.

Status

Field	Type	Required	Description
`activityARN`	string	—	ActivityARN is the ARN of the activity.
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`lastSyncTime`	string	—	LastSyncTime is when the resource was last successfully reconciled.
`observedGeneration`	integer	—	ObservedGeneration is the most recent .metadata.generation reconciled.

SFNStateMachineAlias # CLOUD CONTROL · AWS::StepFunctions::StateMachineAlias

SFNStateMachineAlias manages AWS::StepFunctions::StateMachineAlias through the AWS Cloud Control API.

kubectl get sfnstatemachinealiases · example on GitHub

Example

# SFNStateMachineAlias — Step Functions
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/sfn.html#sfnstatemachinealias
apiVersion: aws.konfig.io/v1alpha1
kind: SFNStateMachineAlias
metadata:
  name: example-sfnstatemachinealias
  namespace: default
spec:
  deploymentPreference:
    alarms:
    - example
    interval: 1
    percentage: 1
    stateMachineVersionArn: arn:aws:iam::123456789012:role/example-role
    type: LINEAR
  description: Managed by konfig-konector
  name: example-sfnstatemachinealias
  providerRef:
    name: example-sfnstatemachinealias
    region: us-east-1
  routingConfiguration:
  - stateMachineVersionArn: arn:aws:iam::123456789012:role/example-role
    weight: 1
  stateMachineArn: arn:aws:iam::123456789012:role/example-role

Spec

Field	Type	Required	Description
`deploymentPreference`	object	—	SFNStateMachineAliasDeploymentPreference is a nested property type of AWS::StepFunctions::StateMachineAlias.
`deploymentPreference.alarms`	array<string>	—	A list of CloudWatch alarm names that will be monitored during the deployment.
`deploymentPreference.interval`	integer	—	The time in minutes between each traffic shifting increment.
`deploymentPreference.percentage`	integer	—	The percentage of traffic to shift to the new version in each increment.
`deploymentPreference.stateMachineVersionArn`	string	yes
`deploymentPreference.type`	enum	yes	The type of deployment to perform. Allowed: `LINEAR, ALL_AT_ONCE, CANARY`
`description`	string	—	An optional description of the alias.
`name`	string	—	The alias name.
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`routingConfiguration`	array<object>	—
`routingConfiguration[].stateMachineVersionArn`	string	yes	The Amazon Resource Name (ARN) that identifies one or two state machine versions defined in the routing configuration.
`routingConfiguration[].weight`	integer	yes	The percentage of traffic you want to route to the state machine version.
`stateMachineArn`	string	—

Status

Field	Type	Required	Description
`arn`	string	—	The ARN of the alias.
`attempt`	integer	—	Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`identifier`	string	—	Identifier is the Cloud Control primary identifier of the resource.
`lastSyncTime`	string	—
`observedGeneration`	integer	—
`operation`	string	—	Operation is the in-flight operation (CREATE, UPDATE, DELETE).
`operationStatus`	string	—	OperationStatus is the last reported operation status.
`requestToken`	string	—	RequestToken tracks an in-flight asynchronous operation.

SFNStateMachineVersion # CLOUD CONTROL · AWS::StepFunctions::StateMachineVersion

SFNStateMachineVersion manages AWS::StepFunctions::StateMachineVersion through the AWS Cloud Control API.

kubectl get sfnstatemachineversions · example on GitHub

Example

# SFNStateMachineVersion — Step Functions
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/sfn.html#sfnstatemachineversion
apiVersion: aws.konfig.io/v1alpha1
kind: SFNStateMachineVersion
metadata:
  name: example-sfnstatemachineversion
  namespace: default
spec:
  description: Managed by konfig-konector
  providerRef:
    name: example-sfnstatemachineversion
    region: us-east-1
  stateMachineArn: arn:aws:iam::123456789012:role/example-role

Spec

Field	Type	Required	Description
`description`	string	—	Create-only in AWS: changing it requires replacing the resource.
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`stateMachineArn`	string	yes	Create-only in AWS: changing it requires replacing the resource.
`stateMachineRevisionId`	string	—	Create-only in AWS: changing it requires replacing the resource.

Status

Field	Type	Required	Description
`arn`	string	—	Read-only: reported by AWS after creation.
`attempt`	integer	—	Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`identifier`	string	—	Identifier is the Cloud Control primary identifier of the resource.
`lastSyncTime`	string	—
`observedGeneration`	integer	—
`operation`	string	—	Operation is the in-flight operation (CREATE, UPDATE, DELETE).
`operationStatus`	string	—	OperationStatus is the last reported operation status.
`requestToken`	string	—	RequestToken tracks an in-flight asynchronous operation.

StateMachine # GA

StateMachine is the Schema for managing Step Functions state machines.

kubectl get statemachines · example on GitHub

Example

# StateMachine — Step Functions
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/sfn.html#statemachine
apiVersion: aws.konfig.io/v1alpha1
kind: StateMachine
metadata:
  name: example-statemachine
  namespace: default
spec:
  definition: example
  name: example-statemachine
  providerRef:
    name: example-statemachine
    region: us-east-1
  roleARN: arn:aws:iam::123456789012:role/example-role
  tags:
    environment: dev
    team: platform
  type: STANDARD

Spec

Field	Type	Required	Description
`definition`	string	yes	Definition is the Amazon States Language definition (JSON string).
`name`	string	yes	Name is the name of the state machine.
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`roleARN`	string	yes	RoleARN is the IAM role ARN for executing the state machine.
`tags`	map<string>	—	Tags are metadata tags for the state machine.
`type`	enum	—	Type is STANDARD or EXPRESS. Allowed: `STANDARD, EXPRESS`

Status

Field	Type	Required	Description
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`lastSyncTime`	string	—	LastSyncTime is when the resource was last successfully reconciled.
`observedGeneration`	integer	—	ObservedGeneration is the most recent .metadata.generation reconciled.
`stateMachineARN`	string	—	StateMachineARN is the ARN of the state machine.
`status`	string	—	Status is the current status of the state machine (ACTIVE, DELETING).