SSM Quick Setup

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

API Group: aws.konfig.io/v1alpha1

SSMQuickSetupConfigurationManager # CLOUD CONTROL · AWS::SSMQuickSetup::ConfigurationManager

SSMQuickSetupConfigurationManager manages AWS::SSMQuickSetup::ConfigurationManager through the AWS Cloud Control API.

kubectl get ssmquicksetupconfigurationmanagers · example on GitHub

Example

# SSMQuickSetupConfigurationManager — SSM Quick Setup
# 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/ssmquicksetup.html#ssmquicksetupconfigurationmanager
apiVersion: aws.konfig.io/v1alpha1
kind: SSMQuickSetupConfigurationManager
metadata:
  name: example-ssmquicksetupconfigurationmanager
  namespace: default
spec:
  configurationDefinitions:
  - localDeploymentAdministrationRoleArn: arn:aws:iam::123456789012:role/example-role
    localDeploymentExecutionRoleName: example-ssmquicksetupconfigurationmanager
    parameters:
      key: value
    type: example
    typeVersion: '1.0'
  description: Managed by konfig-konector
  name: example-ssmquicksetupconfigurationmanager
  providerRef:
    name: example-ssmquicksetupconfigurationmanager
    region: us-east-1
  tags:
    environment: dev
    team: platform

Spec

Field	Type	Required	Description
`configurationDefinitions`	array<object>	yes
`configurationDefinitions[].id`	string	—
`configurationDefinitions[].localDeploymentAdministrationRoleArn`	string	—
`configurationDefinitions[].localDeploymentExecutionRoleName`	string	—
`configurationDefinitions[].parameters`	map<string>	yes
`configurationDefinitions[].type`	string	yes
`configurationDefinitions[].typeVersion`	string	—
`description`	string	—
`name`	string	—
`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>	—

Status

Field	Type	Required	Description
`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.
`createdAt`	string	—	Read-only: reported by AWS after creation.
`identifier`	string	—	Identifier is the Cloud Control primary identifier of the resource.
`lastModifiedAt`	string	—	Read-only: reported by AWS after creation.
`lastSyncTime`	string	—
`managerArn`	string	—	Read-only: reported by AWS after creation.
`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.
`statusSummaries`	array<object>	—	Read-only: reported by AWS after creation.
`statusSummaries[].lastUpdatedAt`	string	yes
`statusSummaries[].status`	enum	—	Allowed: `INITIALIZING, DEPLOYING, SUCCEEDED, DELETING, STOPPING, FAILED, STOPPED, DELETE_FAILED…`
`statusSummaries[].statusDetails`	map<string>	—
`statusSummaries[].statusMessage`	string	—
`statusSummaries[].statusType`	enum	yes	Allowed: `Deployment, AsyncExecutions`

SSMQuickSetupLifecycleAutomation # CLOUD CONTROL · AWS::SSMQuickSetup::LifecycleAutomation

SSMQuickSetupLifecycleAutomation manages AWS::SSMQuickSetup::LifecycleAutomation through the AWS Cloud Control API.

kubectl get ssmquicksetuplifecycleautomations · example on GitHub

Example

# SSMQuickSetupLifecycleAutomation — SSM Quick Setup
# 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/ssmquicksetup.html#ssmquicksetuplifecycleautomation
apiVersion: aws.konfig.io/v1alpha1
kind: SSMQuickSetupLifecycleAutomation
metadata:
  name: example-ssmquicksetuplifecycleautomation
  namespace: default
spec:
  automationDocument: example
  automationParameters: {}
  providerRef:
    name: example-ssmquicksetuplifecycleautomation
    region: us-east-1
  resourceKey: example
  tags:
    environment: dev
    team: platform

Spec

Field	Type	Required	Description
`automationDocument`	string	yes	The name of the Automation document to execute
`automationParameters`	map<string>	yes
`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.
`resourceKey`	string	yes	A unique identifier used for generating a unique logical ID for the custom resource Create-only in AWS: changing it requires replacing the resource.
`tags`	map<string>	—

Status

Field	Type	Required	Description
`associationId`	string	—	The id from the association that is returned when creating the association 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.