CloudFormation
16 resource kinds. Generated from the operator's CRD schemas.
aws.konfig.io/v1alpha1
CloudFormationChangeSet # CLOUD CONTROL · AWS::CloudFormation::ChangeSet
CloudFormationChangeSet manages AWS::CloudFormation::ChangeSet through the AWS Cloud Control API.
kubectl get cloudformationchangesets · example on GitHub
Example
# CloudFormationChangeSet — CloudFormation
# 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/cloudformation.html#cloudformationchangeset
apiVersion: aws.konfig.io/v1alpha1
kind: CloudFormationChangeSet
metadata:
name: example-cloudformationchangeset
namespace: default
spec:
capabilities:
- example
changeSetName: example-cloudformationchangeset
changeSetType: CREATE
deploymentMode: REVERT_DRIFT
description: Managed by konfig-konector
importExistingResources: false
includeNestedStacks: false
notificationARNs:
- example
onStackFailure: DO_NOTHING
providerRef:
name: example-cloudformationchangeset
region: us-east-1
roleARN: arn:aws:iam::123456789012:role/example-role
stackName: example-cloudformationchangeset
tags:
- key: example
value: example
templateBody: example
templateURL: example
usePreviousTemplate: false
Spec
| Field | Type | Required | Description |
|---|---|---|---|
capabilities | array<string> | — | The capabilities that are allowed in the stack. |
changeSetName | string | yes | The name of the change set. |
changeSetType | enum | — | The type of change set operation. Allowed: CREATE, UPDATE, IMPORT |
deploymentMode | enum | — | Determines how CloudFormation handles configuration drift during deployment. Allowed: REVERT_DRIFT |
description | string | — | A description to help you identify this change set. |
importExistingResources | boolean | — | Indicates if the change set imports resources that already exist. |
includeNestedStacks | boolean | — | Creates a change set for all nested stacks specified in the template. |
notificationARNs | array<string> | — | The ARNs of Amazon SNS topics that CloudFormation associates with the stack. |
onStackFailure | enum | — | Determines what action will be taken if stack creation fails. Allowed: DO_NOTHING, ROLLBACK, DELETE |
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 | — | The ARN of an IAM role that CloudFormation assumes when executing the change set. |
stackName | string | yes | The name or unique ID of the stack for which you are creating a change set. |
tags | array<object> | — | Key-value pairs to associate with the change set. |
tags[].key | string | yes | |
tags[].value | string | yes | |
templateBody | string | — | A structure that contains the body of the revised template. |
templateURL | string | — | The URL of the file that contains the revised template. |
usePreviousTemplate | boolean | — | Whether to reuse the template associated with the stack to create the change set. |
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). |
changeSetId | string | — | The ARN of the change set. |
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. |
creationTime | string | — | The time the change set was created. |
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. |
stackId | string | — | The unique ID of the stack. |
CloudFormationGeneratedTemplate # CLOUD CONTROL · AWS::CloudFormation::GeneratedTemplate
CloudFormationGeneratedTemplate manages AWS::CloudFormation::GeneratedTemplate through the AWS Cloud Control API.
kubectl get cloudformationgeneratedtemplates · example on GitHub
Example
# CloudFormationGeneratedTemplate — CloudFormation
# 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/cloudformation.html#cloudformationgeneratedtemplate
apiVersion: aws.konfig.io/v1alpha1
kind: CloudFormationGeneratedTemplate
metadata:
name: example-cloudformationgeneratedtemplate
namespace: default
spec:
generatedTemplateName: example-cloudformationgeneratedtemplate
providerRef:
name: example-cloudformationgeneratedtemplate
region: us-east-1
templateConfiguration:
deletionPolicy: DELETE
updateReplacePolicy: DELETE
Spec
| Field | Type | Required | Description |
|---|---|---|---|
generatedTemplateName | string | yes | The name assigned to the generated template. |
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. |
templateConfiguration | object | — | CloudFormationGeneratedTemplateTemplateConfiguration is a nested property type of AWS::CloudFormation::GeneratedTemplate. |
templateConfiguration.deletionPolicy | enum | — | The DeletionPolicy assigned to resources in the generated template. Allowed: DELETE, RETAIN |
templateConfiguration.updateReplacePolicy | enum | — | The UpdateReplacePolicy assigned to resources in the generated template. Allowed: DELETE, RETAIN |
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. |
creationTime | string | — | The time the generated template was created. |
generatedTemplateId | string | — | The Amazon Resource Name (ARN) of the generated template. |
identifier | string | — | Identifier is the Cloud Control primary identifier of the resource. |
lastSyncTime | string | — | |
lastUpdatedTime | string | — | The time the generated template was last updated. |
observedGeneration | integer | — | |
operation | string | — | Operation is the in-flight operation (CREATE, UPDATE, DELETE). |
operationStatus | string | — | OperationStatus is the last reported operation status. |
progress | object | — | Read-only: reported by AWS after creation. |
progress.resourcesFailed | integer | — | The number of resources that failed the template generation. |
progress.resourcesPending | integer | — | The number of resources that are still pending the template generation. |
progress.resourcesProcessing | integer | — | The number of resources that are in-process for the template generation. |
progress.resourcesSucceeded | integer | — | The number of resources that succeeded the template generation. |
requestToken | string | — | RequestToken tracks an in-flight asynchronous operation. |
status | enum | — | The status of the template generation. Allowed: CREATE_PENDING, UPDATE_PENDING, DELETE_PENDING, CREATE_IN_PROGRESS, UPDATE_IN_PROGRESS, DELETE_IN_PROGRESS, FAILED, COMPLETE |
totalWarnings | integer | — | The number of warnings generated for this template. |
CloudFormationGuardHook # CLOUD CONTROL · AWS::CloudFormation::GuardHook
CloudFormationGuardHook manages AWS::CloudFormation::GuardHook through the AWS Cloud Control API.
kubectl get cloudformationguardhooks · example on GitHub
Example
# CloudFormationGuardHook — CloudFormation
# 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/cloudformation.html#cloudformationguardhook
apiVersion: aws.konfig.io/v1alpha1
kind: CloudFormationGuardHook
metadata:
name: example-cloudformationguardhook
namespace: default
spec:
alias: example
executionRole: example
failureMode: FAIL
hookStatus: ENABLED
logBucket: example
providerRef:
name: example-cloudformationguardhook
region: us-east-1
ruleLocation:
uri: example
stackFilters:
filteringCriteria: ALL
stackNames:
exclude:
- example
include:
- example
targetOperations:
- example
Spec
| Field | Type | Required | Description |
|---|---|---|---|
alias | string | yes | The typename alias for the hook. |
executionRole | string | yes | The execution role ARN assumed by hooks to read Guard rules from S3 and write Guard outputs to S3. |
failureMode | enum | yes | Attribute to specify CloudFormation behavior on hook failure. Allowed: FAIL, WARN |
hookStatus | enum | yes | Attribute to specify which stacks this hook applies to or should get invoked for Allowed: ENABLED, DISABLED |
logBucket | string | — | S3 Bucket where the guard validate report will be uploaded to |
options | object | — | |
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. |
ruleLocation | object | yes | CloudFormationGuardHookS3Location is a nested property type of AWS::CloudFormation::GuardHook. |
ruleLocation.uri | string | yes | S3 uri of Guard files. |
ruleLocation.versionId | string | — | S3 object version |
stackFilters | object | — | Filters to allow hooks to target specific stack attributes |
stackFilters.filteringCriteria | enum | yes | Attribute to specify the filtering behavior. Allowed: ALL, ANY |
stackFilters.stackNames | object | — | List of stack names as filters |
stackFilters.stackNames.exclude | array<string> | — | List of stack names that the hook is going to be excluded from |
stackFilters.stackNames.include | array<string> | — | List of stack names that the hook is going to target |
stackFilters.stackRoles | object | — | List of stack roles that are performing the stack operations. |
stackFilters.stackRoles.exclude | array<object> | — | List of stack roles that the hook is going to be excluded from |
stackFilters.stackRoles.include | array<object> | — | List of stack roles that the hook is going to target |
targetFilters | object | — | Attribute to specify which targets should invoke the hook |
targetOperations | array<string> | yes | Which operations should this Hook run against? Resource changes, stacks or change sets. |
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. |
hookArn | string | — | The Amazon Resource Name (ARN) of the activated hook Read-only: reported by AWS after creation. |
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. |
CloudFormationHookDefaultVersion # CLOUD CONTROL · AWS::CloudFormation::HookDefaultVersion
CloudFormationHookDefaultVersion manages AWS::CloudFormation::HookDefaultVersion through the AWS Cloud Control API.
kubectl get cloudformationhookdefaultversions · example on GitHub
Example
# CloudFormationHookDefaultVersion — CloudFormation
# 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/cloudformation.html#cloudformationhookdefaultversion
apiVersion: aws.konfig.io/v1alpha1
kind: CloudFormationHookDefaultVersion
metadata:
name: example-cloudformationhookdefaultversion
namespace: default
spec:
providerRef:
name: example-cloudformationhookdefaultversion
region: us-east-1
typeName: example-cloudformationhookdefaultversion
typeVersionArn: arn:aws:iam::123456789012:role/example-role
Spec
| Field | Type | Required | Description |
|---|---|---|---|
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. |
typeName | string | — | The name of the type being registered. |
typeVersionArn | string | — | The Amazon Resource Name (ARN) of the type version. |
versionId | string | — | The ID of an existing version of the hook to set as the default. |
Status
| Field | Type | Required | Description |
|---|---|---|---|
arn | string | — | The Amazon Resource Name (ARN) of the type. |
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. |
CloudFormationHookTypeConfig # CLOUD CONTROL · AWS::CloudFormation::HookTypeConfig
CloudFormationHookTypeConfig manages AWS::CloudFormation::HookTypeConfig through the AWS Cloud Control API.
kubectl get cloudformationhooktypeconfigs · example on GitHub
Example
# CloudFormationHookTypeConfig — CloudFormation
# 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/cloudformation.html#cloudformationhooktypeconfig
apiVersion: aws.konfig.io/v1alpha1
kind: CloudFormationHookTypeConfig
metadata:
name: example-cloudformationhooktypeconfig
namespace: default
spec:
configuration: example
configurationAlias: default
providerRef:
name: example-cloudformationhooktypeconfig
region: us-east-1
typeArn: arn:aws:iam::123456789012:role/example-role
typeName: example-cloudformationhooktypeconfig
Spec
| Field | Type | Required | Description |
|---|---|---|---|
configuration | string | — | The configuration data for the extension, in this account and region. |
configurationAlias | enum | — | An alias by which to refer to this extension configuration data. Allowed: default |
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. |
typeArn | string | — | The Amazon Resource Name (ARN) of the type without version number. |
typeName | string | — | The name of the type being registered. |
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. |
configurationArn | string | — | The Amazon Resource Name (ARN) for the configuration data, in this account and region. |
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. |
CloudFormationHookVersion # CLOUD CONTROL · AWS::CloudFormation::HookVersion
CloudFormationHookVersion manages AWS::CloudFormation::HookVersion through the AWS Cloud Control API.
kubectl get cloudformationhookversions · example on GitHub
Example
# CloudFormationHookVersion — CloudFormation
# 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/cloudformation.html#cloudformationhookversion
apiVersion: aws.konfig.io/v1alpha1
kind: CloudFormationHookVersion
metadata:
name: example-cloudformationhookversion
namespace: default
spec:
executionRoleArn: arn:aws:iam::123456789012:role/example-role
loggingConfig:
logGroupName: example-cloudformationhookversion
logRoleArn: arn:aws:iam::123456789012:role/example-role
providerRef:
name: example-cloudformationhookversion
region: us-east-1
schemaHandlerPackage: example
typeName: example-cloudformationhookversion
Spec
| Field | Type | Required | Description |
|---|---|---|---|
executionRoleArn | string | — | The Amazon Resource Name (ARN) of the IAM execution role to use to register the type. |
loggingConfig | object | — | Specifies logging configuration information for a type. |
loggingConfig.logGroupName | string | — | The Amazon CloudWatch log group to which CloudFormation sends error logging information when invoking the type's handlers. |
loggingConfig.logRoleArn | string | — | The ARN of the role that CloudFormation should assume when sending log entries to CloudWatch logs. |
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. |
schemaHandlerPackage | string | yes | A url to the S3 bucket containing the schema handler package that contains the schema, event handlers, and associated files for the type you want to register. |
typeName | string | yes | The name of the type being registered. |
Status
| Field | Type | Required | Description |
|---|---|---|---|
arn | string | — | The Amazon Resource Name (ARN) of the type, here the HookVersion. |
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. |
isDefaultVersion | boolean | — | Indicates if this type version is the current default version Read-only: reported by AWS after creation. |
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. |
typeArn | string | — | The Amazon Resource Name (ARN) of the type without the versionID. |
versionId | string | — | The ID of the version of the type represented by this hook instance. |
visibility | enum | — | The scope at which the type is visible and usable in CloudFormation operations. Allowed: PUBLIC, PRIVATE |
CloudFormationLambdaHook # CLOUD CONTROL · AWS::CloudFormation::LambdaHook
CloudFormationLambdaHook manages AWS::CloudFormation::LambdaHook through the AWS Cloud Control API.
kubectl get cloudformationlambdahooks · example on GitHub
Example
# CloudFormationLambdaHook — CloudFormation
# 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/cloudformation.html#cloudformationlambdahook
apiVersion: aws.konfig.io/v1alpha1
kind: CloudFormationLambdaHook
metadata:
name: example-cloudformationlambdahook
namespace: default
spec:
alias: example
autoUpdate: false
executionRole: example
failureMode: FAIL
hookStatus: ENABLED
lambdaFunction: example
loggingConfig:
logGroupName: example-cloudformationlambdahook
logRoleArn: arn:aws:iam::123456789012:role/example-role
providerRef:
name: example-cloudformationlambdahook
region: us-east-1
stackFilters:
filteringCriteria: ALL
stackNames:
exclude:
- example
include:
- example
targetOperations:
- example
Spec
| Field | Type | Required | Description |
|---|---|---|---|
alias | string | yes | The typename alias for the hook. |
autoUpdate | boolean | — | Whether to automatically update the extension in this account and Region when a new minor version is published by the extension publisher. |
executionRole | string | yes | The execution role ARN assumed by Hooks to invoke Lambda. |
failureMode | enum | yes | Attribute to specify CloudFormation behavior on hook failure. Allowed: FAIL, WARN |
hookStatus | enum | yes | Attribute to specify which stacks this hook applies to or should get invoked for Allowed: ENABLED, DISABLED |
lambdaFunction | string | yes | Amazon Resource Name (ARN), Partial ARN, name, version, or alias of the Lambda function to invoke with this hook. |
loggingConfig | object | — | Contains logging configuration information for the hook. |
loggingConfig.logGroupName | string | yes | The Amazon CloudWatch Logs group to which CloudFormation sends error logging information when invoking the extension's handlers. |
loggingConfig.logRoleArn | string | yes | The ARN of the role that CloudFormation should assume when sending log entries to CloudWatch Logs. |
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. |
stackFilters | object | — | Filters to allow hooks to target specific stack attributes |
stackFilters.filteringCriteria | enum | yes | Attribute to specify the filtering behavior. Allowed: ALL, ANY |
stackFilters.stackNames | object | — | List of stack names as filters |
stackFilters.stackNames.exclude | array<string> | — | List of stack names that the hook is going to be excluded from |
stackFilters.stackNames.include | array<string> | — | List of stack names that the hook is going to target |
stackFilters.stackRoles | object | — | List of stack roles that are performing the stack operations. |
stackFilters.stackRoles.exclude | array<object> | — | List of stack roles that the hook is going to be excluded from |
stackFilters.stackRoles.include | array<object> | — | List of stack roles that the hook is going to target |
targetFilters | object | — | Attribute to specify which targets should invoke the hook |
targetOperations | array<string> | yes | Which operations should this Hook run against? Resource changes, stacks or change sets. |
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. |
hookArn | string | — | The Amazon Resource Name (ARN) of the activated hook Read-only: reported by AWS after creation. |
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. |
CloudFormationModuleDefaultVersion # CLOUD CONTROL · AWS::CloudFormation::ModuleDefaultVersion
CloudFormationModuleDefaultVersion manages AWS::CloudFormation::ModuleDefaultVersion through the AWS Cloud Control API.
kubectl get cloudformationmoduledefaultversions · example on GitHub
Example
# CloudFormationModuleDefaultVersion — CloudFormation
# 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/cloudformation.html#cloudformationmoduledefaultversion
apiVersion: aws.konfig.io/v1alpha1
kind: CloudFormationModuleDefaultVersion
metadata:
name: example-cloudformationmoduledefaultversion
namespace: default
spec:
arn: arn:aws:iam::123456789012:role/example-role
moduleName: example-cloudformationmoduledefaultversion
providerRef:
name: example-cloudformationmoduledefaultversion
region: us-east-1
Spec
| Field | Type | Required | Description |
|---|---|---|---|
arn | string | — | The Amazon Resource Name (ARN) of the module version to set as the default version. |
moduleName | string | — | The name of a module existing in the registry. |
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. |
versionId | string | — | The ID of an existing version of the named module to set as the default. |
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. |
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. |
CloudFormationModuleVersion # CLOUD CONTROL · AWS::CloudFormation::ModuleVersion
CloudFormationModuleVersion manages AWS::CloudFormation::ModuleVersion through the AWS Cloud Control API.
kubectl get cloudformationmoduleversions · example on GitHub
Example
# CloudFormationModuleVersion — CloudFormation
# 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/cloudformation.html#cloudformationmoduleversion
apiVersion: aws.konfig.io/v1alpha1
kind: CloudFormationModuleVersion
metadata:
name: example-cloudformationmoduleversion
namespace: default
spec:
moduleName: example-cloudformationmoduleversion
modulePackage: example
providerRef:
name: example-cloudformationmoduleversion
region: us-east-1
Spec
| Field | Type | Required | Description |
|---|---|---|---|
moduleName | string | yes | The name of the module being registered. |
modulePackage | string | yes | The url to the S3 bucket containing the schema and template fragment for the module you want to register. |
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. |
Status
| Field | Type | Required | Description |
|---|---|---|---|
arn | string | — | The Amazon Resource Name (ARN) of the module. |
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. |
description | string | — | The description of the registered module. |
documentationUrl | string | — | The URL of a page providing detailed documentation for this module. |
identifier | string | — | Identifier is the Cloud Control primary identifier of the resource. |
isDefaultVersion | boolean | — | Indicator of whether this module version is the current default version Read-only: reported by AWS after creation. |
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. |
schema | string | — | The schema defining input parameters to and resources generated by the module. |
timeCreated | string | — | The time that the specified module version was registered. |
versionId | string | — | The version ID of the module represented by this module instance. |
visibility | enum | — | The scope at which the type is visible and usable in CloudFormation operations. Allowed: PRIVATE |
CloudFormationPublicTypeVersion # CLOUD CONTROL · AWS::CloudFormation::PublicTypeVersion
CloudFormationPublicTypeVersion manages AWS::CloudFormation::PublicTypeVersion through the AWS Cloud Control API.
kubectl get cloudformationpublictypeversions · example on GitHub
Example
# CloudFormationPublicTypeVersion — CloudFormation
# 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/cloudformation.html#cloudformationpublictypeversion
apiVersion: aws.konfig.io/v1alpha1
kind: CloudFormationPublicTypeVersion
metadata:
name: example-cloudformationpublictypeversion
namespace: default
spec:
arn: arn:aws:iam::123456789012:role/example-role
logDeliveryBucket: example
providerRef:
name: example-cloudformationpublictypeversion
region: us-east-1
publicVersionNumber: example
type: RESOURCE
typeName: example-cloudformationpublictypeversion
Spec
| Field | Type | Required | Description |
|---|---|---|---|
arn | string | — | The Amazon Resource Number (ARN) of the extension. |
logDeliveryBucket | string | — | A url to the S3 bucket where logs for the testType run will be available 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. |
publicVersionNumber | string | — | The version number of a public third-party extension Create-only in AWS: changing it requires replacing the resource. |
type | enum | — | The kind of extension Create-only in AWS: changing it requires replacing the resource. Allowed: RESOURCE, MODULE, HOOK |
typeName | string | — | The name of the type being registered. |
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. |
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. |
publicTypeArn | string | — | The Amazon Resource Number (ARN) assigned to the public extension upon publication Read-only: reported by AWS after creation. |
publisherId | string | — | The reserved publisher id for this type, or the publisher id assigned by CloudFormation for publishing in this region. |
requestToken | string | — | RequestToken tracks an in-flight asynchronous operation. |
typeVersionArn | string | — | The Amazon Resource Number (ARN) of the extension with the versionId. |
CloudFormationPublisher # CLOUD CONTROL · AWS::CloudFormation::Publisher
CloudFormationPublisher manages AWS::CloudFormation::Publisher through the AWS Cloud Control API.
kubectl get cloudformationpublishers · example on GitHub
Example
# CloudFormationPublisher — CloudFormation
# 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/cloudformation.html#cloudformationpublisher
apiVersion: aws.konfig.io/v1alpha1
kind: CloudFormationPublisher
metadata:
name: example-cloudformationpublisher
namespace: default
spec:
acceptTermsAndConditions: false
connectionArn: arn:aws:iam::123456789012:role/example-role
providerRef:
name: example-cloudformationpublisher
region: us-east-1
Spec
| Field | Type | Required | Description |
|---|---|---|---|
acceptTermsAndConditions | boolean | yes | Whether you accept the terms and conditions for publishing extensions in the CloudFormation registry. |
connectionArn | string | — | If you are using a Bitbucket or GitHub account for identity verification, the Amazon Resource Name (ARN) for your connection to that account. |
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. |
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. |
identifier | string | — | Identifier is the Cloud Control primary identifier of the resource. |
identityProvider | enum | — | The type of account used as the identity provider when registering this publisher with CloudFormation. Allowed: AWS_Marketplace, GitHub, Bitbucket |
lastSyncTime | string | — | |
observedGeneration | integer | — | |
operation | string | — | Operation is the in-flight operation (CREATE, UPDATE, DELETE). |
operationStatus | string | — | OperationStatus is the last reported operation status. |
publisherId | string | — | The reserved publisher id for this type, or the publisher id assigned by CloudFormation for publishing in this region. |
publisherProfile | string | — | The URL to the publisher's profile with the identity provider. |
publisherStatus | enum | — | Whether the publisher is verified. Allowed: VERIFIED, UNVERIFIED |
requestToken | string | — | RequestToken tracks an in-flight asynchronous operation. |
CloudFormationResourceDefaultVersion # CLOUD CONTROL · AWS::CloudFormation::ResourceDefaultVersion
CloudFormationResourceDefaultVersion manages AWS::CloudFormation::ResourceDefaultVersion through the AWS Cloud Control API.
kubectl get cloudformationresourcedefaultversions · example on GitHub
Example
# CloudFormationResourceDefaultVersion — CloudFormation
# 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/cloudformation.html#cloudformationresourcedefaultversion
apiVersion: aws.konfig.io/v1alpha1
kind: CloudFormationResourceDefaultVersion
metadata:
name: example-cloudformationresourcedefaultversion
namespace: default
spec:
providerRef:
name: example-cloudformationresourcedefaultversion
region: us-east-1
typeName: example-cloudformationresourcedefaultversion
typeVersionArn: arn:aws:iam::123456789012:role/example-role
Spec
| Field | Type | Required | Description |
|---|---|---|---|
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. |
typeName | string | — | The name of the type being registered. |
typeVersionArn | string | — | The Amazon Resource Name (ARN) of the type version. |
versionId | string | — | The ID of an existing version of the resource to set as the default. |
Status
| Field | Type | Required | Description |
|---|---|---|---|
arn | string | — | The Amazon Resource Name (ARN) of the type. |
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. |
CloudFormationResourceVersion # CLOUD CONTROL · AWS::CloudFormation::ResourceVersion
CloudFormationResourceVersion manages AWS::CloudFormation::ResourceVersion through the AWS Cloud Control API.
kubectl get cloudformationresourceversions · example on GitHub
Example
# CloudFormationResourceVersion — CloudFormation
# 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/cloudformation.html#cloudformationresourceversion
apiVersion: aws.konfig.io/v1alpha1
kind: CloudFormationResourceVersion
metadata:
name: example-cloudformationresourceversion
namespace: default
spec:
executionRoleArn: arn:aws:iam::123456789012:role/example-role
loggingConfig:
logGroupName: example-cloudformationresourceversion
logRoleArn: arn:aws:iam::123456789012:role/example-role
providerRef:
name: example-cloudformationresourceversion
region: us-east-1
schemaHandlerPackage: example
typeName: example-cloudformationresourceversion
Spec
| Field | Type | Required | Description |
|---|---|---|---|
executionRoleArn | string | — | The Amazon Resource Name (ARN) of the IAM execution role to use to register the type. |
loggingConfig | object | — | Specifies logging configuration information for a type. |
loggingConfig.logGroupName | string | — | The Amazon CloudWatch log group to which CloudFormation sends error logging information when invoking the type's handlers. |
loggingConfig.logRoleArn | string | — | The ARN of the role that CloudFormation should assume when sending log entries to CloudWatch logs. |
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. |
schemaHandlerPackage | string | yes | A url to the S3 bucket containing the schema handler package that contains the schema, event handlers, and associated files for the type you want to register. |
typeName | string | yes | The name of the type being registered. |
Status
| Field | Type | Required | Description |
|---|---|---|---|
arn | string | — | The Amazon Resource Name (ARN) of the type, here the ResourceVersion. |
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. |
isDefaultVersion | boolean | — | Indicates if this type version is the current default version Read-only: reported by AWS after creation. |
lastSyncTime | string | — | |
observedGeneration | integer | — | |
operation | string | — | Operation is the in-flight operation (CREATE, UPDATE, DELETE). |
operationStatus | string | — | OperationStatus is the last reported operation status. |
provisioningType | enum | — | The provisioning behavior of the type. Allowed: NON_PROVISIONABLE, IMMUTABLE, FULLY_MUTABLE |
requestToken | string | — | RequestToken tracks an in-flight asynchronous operation. |
typeArn | string | — | The Amazon Resource Name (ARN) of the type without the versionID. |
versionId | string | — | The ID of the version of the type represented by this resource instance. |
visibility | enum | — | The scope at which the type is visible and usable in CloudFormation operations. Allowed: PUBLIC, PRIVATE |
CloudFormationStack # GA
CloudFormationStack is the Schema for managing CloudFormation stacks.
kubectl get cloudformationstacks · example on GitHub
Example
# CloudFormationStack — CloudFormation
# 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/cloudformation.html#cloudformationstack
apiVersion: aws.konfig.io/v1alpha1
kind: CloudFormationStack
metadata:
name: example-cloudformationstack
namespace: default
spec:
capabilities:
- example
parameters:
- parameterKey: example
parameterValue: example
providerRef:
name: example-cloudformationstack
region: us-east-1
stackName: example-cloudformationstack
tags:
environment: dev
team: platform
templateBody: example
templateURL: example
Spec
| Field | Type | Required | Description |
|---|---|---|---|
capabilities | array<string> | — | Capabilities is the list of CloudFormation capabilities (e.g. |
parameters | array<object> | — | Parameters is the list of template parameters. |
parameters[].parameterKey | string | yes | ParameterKey is the parameter key. |
parameters[].parameterValue | string | yes | ParameterValue is the parameter value. |
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. |
stackName | string | yes | StackName is the name of the stack. |
tags | map<string> | — | Tags are metadata tags for the stack. |
templateBody | string | — | TemplateBody is the CloudFormation template body (JSON or YAML string). |
templateURL | string | — | TemplateURL is an S3 URL for the template. |
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. |
stackID | string | — | StackID is the unique identifier (ARN) of the stack. |
stackStatus | string | — | StackStatus is the current status of the stack (CREATE_COMPLETE, UPDATE_COMPLETE, etc.). |
CloudFormationStackSet # GA
CloudFormationStackSet is the Schema for managing CloudFormation StackSets.
kubectl get cloudformationstacksets · example on GitHub
Example
# CloudFormationStackSet — CloudFormation
# 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/cloudformation.html#cloudformationstackset
apiVersion: aws.konfig.io/v1alpha1
kind: CloudFormationStackSet
metadata:
name: example-cloudformationstackset
namespace: default
spec:
capabilities:
- example
description: Managed by konfig-konector
parameters:
- parameterKey: example
parameterValue: example
providerRef:
name: example-cloudformationstackset
region: us-east-1
stackSetName: example-cloudformationstackset
tags:
environment: dev
team: platform
templateBody: example
templateURL: example
Spec
| Field | Type | Required | Description |
|---|---|---|---|
capabilities | array<string> | — | Capabilities is the list of CloudFormation capabilities. |
description | string | — | Description is a description of the StackSet. |
parameters | array<object> | — | Parameters is the list of template parameters. |
parameters[].parameterKey | string | yes | ParameterKey is the parameter key. |
parameters[].parameterValue | string | yes | ParameterValue is the parameter value. |
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. |
stackSetName | string | yes | StackSetName is the name of the StackSet. |
tags | map<string> | — | Tags are metadata tags for the StackSet. |
templateBody | string | — | TemplateBody is the CloudFormation template body (JSON or YAML string). |
templateURL | string | — | TemplateURL is an S3 URL for the template. |
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. |
stackSetID | string | — | StackSetID is the unique identifier of the StackSet. |
stackSetStatus | string | — | StackSetStatus is the current status of the StackSet. |
CloudFormationTypeActivation # CLOUD CONTROL · AWS::CloudFormation::TypeActivation
CloudFormationTypeActivation manages AWS::CloudFormation::TypeActivation through the AWS Cloud Control API.
kubectl get cloudformationtypeactivations · example on GitHub
Example
# CloudFormationTypeActivation — CloudFormation
# 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/cloudformation.html#cloudformationtypeactivation
apiVersion: aws.konfig.io/v1alpha1
kind: CloudFormationTypeActivation
metadata:
name: example-cloudformationtypeactivation
namespace: default
spec:
autoUpdate: false
executionRoleArn: arn:aws:iam::123456789012:role/example-role
loggingConfig:
logGroupName: example-cloudformationtypeactivation
logRoleArn: arn:aws:iam::123456789012:role/example-role
majorVersion: '1.0'
providerRef:
name: example-cloudformationtypeactivation
region: us-east-1
publicTypeArn: arn:aws:iam::123456789012:role/example-role
type: RESOURCE
typeName: example-cloudformationtypeactivation
typeNameAlias: example
versionBump: MAJOR
Spec
| Field | Type | Required | Description |
|---|---|---|---|
autoUpdate | boolean | — | Whether to automatically update the extension in this account and region when a new minor version is published by the extension publisher. |
executionRoleArn | string | — | The Amazon Resource Name (ARN) of the IAM execution role to use to register the type. |
loggingConfig | object | — | Specifies logging configuration information for a type. |
loggingConfig.logGroupName | string | — | The Amazon CloudWatch log group to which CloudFormation sends error logging information when invoking the type's handlers. |
loggingConfig.logRoleArn | string | — | The ARN of the role that CloudFormation should assume when sending log entries to CloudWatch logs. |
majorVersion | string | — | The Major Version of the type you want to enable |
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. |
publicTypeArn | string | — | The Amazon Resource Number (ARN) assigned to the public extension upon publication |
publisherId | string | — | The reserved publisher id for this type, or the publisher id assigned by CloudFormation for publishing in this region. |
type | enum | — | The kind of extension Allowed: RESOURCE, MODULE, HOOK |
typeName | string | — | The name of the type being registered. |
typeNameAlias | string | — | An alias to assign to the public extension in this account and region. |
versionBump | enum | — | Manually updates a previously-enabled type to a new major or minor version, if available. Allowed: MAJOR, MINOR |
Status
| Field | Type | Required | Description |
|---|---|---|---|
arn | string | — | The Amazon Resource Name (ARN) of the extension. |
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. |