API Gateway
22 resource kinds. Generated from the operator's CRD schemas.
aws.konfig.io/v1alpha1
ApiGatewayAccount # CLOUD CONTROL · AWS::ApiGateway::Account ⚠ DESTRUCTIVE SCOPE
Caution, destructive scope: account-wide API Gateway settings singleton. Provided for completeness; do not use from application namespaces. Restrict with AWSProvider.allowedNamespaces and RBAC. ApiGatewayAccount manages AWS::ApiGateway::Account through the AWS Cloud Control API.
kubectl get apigatewayaccounts · example on GitHub
Example
# ApiGatewayAccount — API Gateway
# 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/apigateway.html#apigatewayaccount
apiVersion: aws.konfig.io/v1alpha1
kind: ApiGatewayAccount
metadata:
name: example-apigatewayaccount
namespace: default
spec:
cloudWatchRoleArn: arn:aws:iam::123456789012:role/example-role
providerRef:
name: example-apigatewayaccount
region: us-east-1
Spec
| Field | Type | Required | Description |
|---|---|---|---|
cloudWatchRoleArn | 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. |
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. |
id | string | — | 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. |
ApiGatewayApiKey # CLOUD CONTROL · AWS::ApiGateway::ApiKey ⚠ DESTRUCTIVE SCOPE
Caution, destructive scope: API key value is credential material. Provided for completeness; do not use from application namespaces. Restrict with AWSProvider.allowedNamespaces and RBAC. ApiGatewayApiKey manages AWS::ApiGateway::ApiKey through the AWS Cloud Control API.
kubectl get apigatewayapikeys · example on GitHub
Example
# ApiGatewayApiKey — API Gateway
# 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/apigateway.html#apigatewayapikey
apiVersion: aws.konfig.io/v1alpha1
kind: ApiGatewayApiKey
metadata:
name: example-apigatewayapikey
namespace: default
spec:
description: Managed by konfig-konector
enabled: true
generateDistinctId: false
name: example-apigatewayapikey
providerRef:
name: example-apigatewayapikey
region: us-east-1
stageKeys:
- stageName: example-apigatewayapikey
tags:
- key: example
value: example
value: example
Spec
| Field | Type | Required | Description |
|---|---|---|---|
customerId | string | — | |
description | string | — | |
enabled | boolean | — | |
generateDistinctId | boolean | — | Create-only in AWS: changing it requires replacing the resource. |
name | string | — | A name for the API key. |
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. |
stageKeys | array<object> | — | |
stageKeys[].restApiId | string | — | |
stageKeys[].stageName | string | — | |
tags | array<object> | — | |
tags[].key | string | yes | |
tags[].value | string | yes | |
value | string | — | Create-only in AWS: changing it requires replacing the resource. |
Status
| Field | Type | Required | Description |
|---|---|---|---|
apiKeyId | 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. |
ApiGatewayBasePathMapping # CLOUD CONTROL · AWS::ApiGateway::BasePathMapping
ApiGatewayBasePathMapping manages AWS::ApiGateway::BasePathMapping through the AWS Cloud Control API.
kubectl get apigatewaybasepathmappings · example on GitHub
Example
# ApiGatewayBasePathMapping — API Gateway
# 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/apigateway.html#apigatewaybasepathmapping
apiVersion: aws.konfig.io/v1alpha1
kind: ApiGatewayBasePathMapping
metadata:
name: example-apigatewaybasepathmapping
namespace: default
spec:
basePath: example
domainName: example-apigatewaybasepathmapping
providerRef:
name: example-apigatewaybasepathmapping
region: us-east-1
stage: example
Spec
| Field | Type | Required | Description |
|---|---|---|---|
basePath | string | — | Create-only in AWS: changing it requires replacing the resource. |
domainName | string | yes | 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. |
restApiId | string | — | |
stage | 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. |
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. |
ApiGatewayBasePathMappingV2 # CLOUD CONTROL · AWS::ApiGateway::BasePathMappingV2
ApiGatewayBasePathMappingV2 manages AWS::ApiGateway::BasePathMappingV2 through the AWS Cloud Control API.
kubectl get apigatewaybasepathmappingv2s · example on GitHub
Example
# ApiGatewayBasePathMappingV2 — API Gateway
# 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/apigateway.html#apigatewaybasepathmappingv2
apiVersion: aws.konfig.io/v1alpha1
kind: ApiGatewayBasePathMappingV2
metadata:
name: example-apigatewaybasepathmappingv2
namespace: default
spec:
basePath: example
domainNameArn: arn:aws:iam::123456789012:role/example-role
providerRef:
name: example-apigatewaybasepathmappingv2
region: us-east-1
restApiId: example-id
stage: example
Spec
| Field | Type | Required | Description |
|---|---|---|---|
basePath | string | — | The base path name that callers of the API must provide in the URL after the domain name. |
domainNameArn | string | yes | The Arn of an AWS::ApiGateway::DomainNameV2 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. |
restApiId | string | yes | The ID of the API. |
stage | string | — | The name of the API's stage. |
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). |
basePathMappingArn | string | — | Amazon Resource Name (ARN) of the resource. |
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. |
ApiGatewayClientCertificate # CLOUD CONTROL · AWS::ApiGateway::ClientCertificate
ApiGatewayClientCertificate manages AWS::ApiGateway::ClientCertificate through the AWS Cloud Control API.
kubectl get apigatewayclientcertificates · example on GitHub
Example
# ApiGatewayClientCertificate — API Gateway
# 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/apigateway.html#apigatewayclientcertificate
apiVersion: aws.konfig.io/v1alpha1
kind: ApiGatewayClientCertificate
metadata:
name: example-apigatewayclientcertificate
namespace: default
spec:
description: Managed by konfig-konector
providerRef:
name: example-apigatewayclientcertificate
region: us-east-1
tags:
- key: example
value: example
Spec
| Field | Type | Required | Description |
|---|---|---|---|
description | 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 | array<object> | — | |
tags[].key | string | yes | |
tags[].value | string | yes |
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). |
clientCertificateId | string | — | Read-only: reported by AWS after creation. |
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. |
ApiGatewayDocumentationPart # CLOUD CONTROL · AWS::ApiGateway::DocumentationPart
ApiGatewayDocumentationPart manages AWS::ApiGateway::DocumentationPart through the AWS Cloud Control API.
kubectl get apigatewaydocumentationparts · example on GitHub
Example
# ApiGatewayDocumentationPart — API Gateway
# 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/apigateway.html#apigatewaydocumentationpart
apiVersion: aws.konfig.io/v1alpha1
kind: ApiGatewayDocumentationPart
metadata:
name: example-apigatewaydocumentationpart
namespace: default
spec:
location:
method: example
name: example-apigatewaydocumentationpart
path: example
statusCode: example
type: API
properties: example
providerRef:
name: example-apigatewaydocumentationpart
region: us-east-1
restApiId: example-id
Spec
| Field | Type | Required | Description |
|---|---|---|---|
location | object | yes | Create-only in AWS: changing it requires replacing the resource. |
location.method | string | — | |
location.name | string | — | |
location.path | string | — | |
location.statusCode | string | — | |
location.type | enum | — | Allowed: API, AUTHORIZER, MODEL, RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER… |
properties | 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. |
restApiId | string | yes | Create-only in AWS: changing it requires replacing the resource. |
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. |
documentationPartId | string | — | 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. |
ApiGatewayDocumentationVersion # CLOUD CONTROL · AWS::ApiGateway::DocumentationVersion
ApiGatewayDocumentationVersion manages AWS::ApiGateway::DocumentationVersion through the AWS Cloud Control API.
kubectl get apigatewaydocumentationversions · example on GitHub
Example
# ApiGatewayDocumentationVersion — API Gateway
# 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/apigateway.html#apigatewaydocumentationversion
apiVersion: aws.konfig.io/v1alpha1
kind: ApiGatewayDocumentationVersion
metadata:
name: example-apigatewaydocumentationversion
namespace: default
spec:
description: Managed by konfig-konector
documentationVersion: '1.0'
providerRef:
name: example-apigatewaydocumentationversion
region: us-east-1
restApiId: example-id
Spec
| Field | Type | Required | Description |
|---|---|---|---|
description | string | — | |
documentationVersion | string | yes | 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. |
restApiId | string | yes | Create-only in AWS: changing it requires replacing the resource. |
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. |
ApiGatewayDomainName # CLOUD CONTROL · AWS::ApiGateway::DomainName
ApiGatewayDomainName manages AWS::ApiGateway::DomainName through the AWS Cloud Control API.
kubectl get apigatewaydomainnames · example on GitHub
Example
# ApiGatewayDomainName — API Gateway
# 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/apigateway.html#apigatewaydomainname
apiVersion: aws.konfig.io/v1alpha1
kind: ApiGatewayDomainName
metadata:
name: example-apigatewaydomainname
namespace: default
spec:
certificateArn: arn:aws:iam::123456789012:role/example-role
domainName: example-apigatewaydomainname
endpointAccessMode: example
endpointConfiguration:
ipAddressType: example
types:
- example
mutualTlsAuthentication:
truststoreUri: example
truststoreVersion: '1.0'
ownershipVerificationCertificateArn: arn:aws:iam::123456789012:role/example-role
providerRef:
name: example-apigatewaydomainname
region: us-east-1
regionalCertificateArn: arn:aws:iam::123456789012:role/example-role
routingMode: BASE_PATH_MAPPING_ONLY
securityPolicy: example
tags:
- key: example
value: example
Spec
| Field | Type | Required | Description |
|---|---|---|---|
certificateArn | string | — | |
domainName | string | — | Create-only in AWS: changing it requires replacing the resource. |
endpointAccessMode | string | — | |
endpointConfiguration | object | — | The endpoint configuration of this DomainName showing the endpoint types and IP address types of the domain name. |
endpointConfiguration.ipAddressType | string | — | |
endpointConfiguration.types | array<string> | — | |
mutualTlsAuthentication | object | — | ApiGatewayDomainNameMutualTlsAuthentication is a nested property type of AWS::ApiGateway::DomainName. |
mutualTlsAuthentication.truststoreUri | string | — | |
mutualTlsAuthentication.truststoreVersion | string | — | |
ownershipVerificationCertificateArn | string | — | The ARN of the public certificate issued by ACM to validate ownership of your custom domain. |
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. |
regionalCertificateArn | string | — | |
routingMode | enum | — | Allowed: BASE_PATH_MAPPING_ONLY, ROUTING_RULE_THEN_BASE_PATH_MAPPING, ROUTING_RULE_ONLY |
securityPolicy | string | — | |
tags | array<object> | — | |
tags[].key | string | yes | |
tags[].value | string | yes |
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. |
distributionDomainName | string | — | Read-only: reported by AWS after creation. |
distributionHostedZoneId | string | — | Read-only: reported by AWS after creation. |
domainNameArn | string | — | 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. |
regionalDomainName | string | — | Read-only: reported by AWS after creation. |
regionalHostedZoneId | string | — | Read-only: reported by AWS after creation. |
requestToken | string | — | RequestToken tracks an in-flight asynchronous operation. |
ApiGatewayDomainNameAccessAssociation # CLOUD CONTROL · AWS::ApiGateway::DomainNameAccessAssociation
ApiGatewayDomainNameAccessAssociation manages AWS::ApiGateway::DomainNameAccessAssociation through the AWS Cloud Control API.
kubectl get apigatewaydomainnameaccessassociations · example on GitHub
Example
# ApiGatewayDomainNameAccessAssociation — API Gateway
# 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/apigateway.html#apigatewaydomainnameaccessassociation
apiVersion: aws.konfig.io/v1alpha1
kind: ApiGatewayDomainNameAccessAssociation
metadata:
name: example-apigatewaydomainnameaccessassociation
namespace: default
spec:
accessAssociationSource: example
accessAssociationSourceType: VPCE
domainNameArn: arn:aws:iam::123456789012:role/example-role
providerRef:
name: example-apigatewaydomainnameaccessassociation
region: us-east-1
tags:
- key: example
value: example
Spec
| Field | Type | Required | Description |
|---|---|---|---|
accessAssociationSource | string | yes | The source of the domain name access association resource. |
accessAssociationSourceType | enum | yes | The source type of the domain name access association resource. Allowed: VPCE |
domainNameArn | string | yes | The amazon resource name (ARN) of the domain name 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. |
tags | array<object> | — | An array of arbitrary tags (key-value pairs) to associate with the domainname access association. |
tags[].key | string | yes | |
tags[].value | string | yes |
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. |
domainNameAccessAssociationArn | string | — | The amazon resource name (ARN) of the domain name access association resource. |
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. |
ApiGatewayDomainNameV2 # CLOUD CONTROL · AWS::ApiGateway::DomainNameV2
ApiGatewayDomainNameV2 manages AWS::ApiGateway::DomainNameV2 through the AWS Cloud Control API.
kubectl get apigatewaydomainnamev2s · example on GitHub
Example
# ApiGatewayDomainNameV2 — API Gateway
# 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/apigateway.html#apigatewaydomainnamev2
apiVersion: aws.konfig.io/v1alpha1
kind: ApiGatewayDomainNameV2
metadata:
name: example-apigatewaydomainnamev2
namespace: default
spec:
certificateArn: arn:aws:iam::123456789012:role/example-role
domainName: example-apigatewaydomainnamev2
endpointAccessMode: example
endpointConfiguration:
ipAddressType: example
types:
- example
providerRef:
name: example-apigatewaydomainnamev2
region: us-east-1
routingMode: BASE_PATH_MAPPING_ONLY
securityPolicy: example
tags:
- key: example
value: example
Spec
| Field | Type | Required | Description |
|---|---|---|---|
certificateArn | string | — | |
domainName | string | — | Create-only in AWS: changing it requires replacing the resource. |
endpointAccessMode | string | — | |
endpointConfiguration | object | — | Create-only in AWS: changing it requires replacing the resource. |
endpointConfiguration.ipAddressType | string | — | |
endpointConfiguration.types | array<string> | — | |
policy | 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. |
routingMode | enum | — | The valid routing modes are [BASE_PATH_MAPPING_ONLY], [ROUTING_RULE_THEN_BASE_PATH_MAPPING] and [ROUTING_RULE_ONLY]. Allowed: BASE_PATH_MAPPING_ONLY, ROUTING_RULE_THEN_BASE_PATH_MAPPING, ROUTING_RULE_ONLY |
securityPolicy | string | — | Create-only in AWS: changing it requires replacing the resource. |
tags | array<object> | — | |
tags[].key | string | yes | |
tags[].value | string | yes |
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. |
domainNameArn | string | — | The amazon resource name (ARN) of the domain name resource. |
domainNameId | string | — | 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. |
ApiGatewayGatewayResponse # CLOUD CONTROL · AWS::ApiGateway::GatewayResponse
ApiGatewayGatewayResponse manages AWS::ApiGateway::GatewayResponse through the AWS Cloud Control API.
kubectl get apigatewaygatewayresponses · example on GitHub
Example
# ApiGatewayGatewayResponse — API Gateway
# 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/apigateway.html#apigatewaygatewayresponse
apiVersion: aws.konfig.io/v1alpha1
kind: ApiGatewayGatewayResponse
metadata:
name: example-apigatewaygatewayresponse
namespace: default
spec:
providerRef:
name: example-apigatewaygatewayresponse
region: us-east-1
responseParameters:
key: value
responseTemplates:
key: value
responseType: example
restApiId: example-id
statusCode: example
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. |
responseParameters | map<string> | — | |
responseTemplates | map<string> | — | |
responseType | string | yes | Create-only in AWS: changing it requires replacing the resource. |
restApiId | string | yes | Create-only in AWS: changing it requires replacing the resource. |
statusCode | 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. |
id | string | — | 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. |
ApiGatewayMethod # CLOUD CONTROL · AWS::ApiGateway::Method
ApiGatewayMethod manages AWS::ApiGateway::Method through the AWS Cloud Control API.
kubectl get apigatewaymethods · example on GitHub
Example
# ApiGatewayMethod — API Gateway
# 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/apigateway.html#apigatewaymethod
apiVersion: aws.konfig.io/v1alpha1
kind: ApiGatewayMethod
metadata:
name: example-apigatewaymethod
namespace: default
spec:
apiKeyRequired: false
authorizationScopes:
- example
authorizationType: example
httpMethod: example
integration:
cacheKeyParameters:
- example
cacheNamespace: example
connectionType: INTERNET
contentHandling: CONVERT_TO_BINARY
credentials: example
integrationHttpMethod: example
integrationResponses:
- contentHandling: CONVERT_TO_BINARY
selectionPattern: example
statusCode: example
integrationTarget: example
passthroughBehavior: WHEN_NO_MATCH
requestParameters:
key: value
requestTemplates:
key: value
responseTransferMode: BUFFERED
timeoutInMillis: 50
type: AWS
uri: example
methodResponses:
- responseModels:
key: value
responseParameters: {}
statusCode: example
operationName: example-apigatewaymethod
providerRef:
name: example-apigatewaymethod
region: us-east-1
requestModels:
key: value
requestParameters: {}
resourceId: example-id
restApiId: example-id
Spec
| Field | Type | Required | Description |
|---|---|---|---|
apiKeyRequired | boolean | — | |
authorizationScopes | array<string> | — | |
authorizationType | string | — | The method's authorization type. |
authorizerId | string | — | |
httpMethod | string | yes | Create-only in AWS: changing it requires replacing the resource. |
integration | object | — | ApiGatewayMethodIntegration is a nested property type of AWS::ApiGateway::Method. |
integration.cacheKeyParameters | array<string> | — | |
integration.cacheNamespace | string | — | |
integration.connectionId | string | — | |
integration.connectionType | enum | — | Allowed: INTERNET, VPC_LINK |
integration.contentHandling | enum | — | Allowed: CONVERT_TO_BINARY, CONVERT_TO_TEXT |
integration.credentials | string | — | |
integration.integrationHttpMethod | string | — | |
integration.integrationResponses | array<object> | — | |
integration.integrationResponses[].contentHandling | enum | — | Allowed: CONVERT_TO_BINARY, CONVERT_TO_TEXT |
integration.integrationResponses[].responseParameters | map<string> | — | |
integration.integrationResponses[].responseTemplates | map<string> | — | |
integration.integrationResponses[].selectionPattern | string | — | |
integration.integrationResponses[].statusCode | string | yes | |
integration.integrationTarget | string | — | |
integration.passthroughBehavior | enum | — | Allowed: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, NEVER |
integration.requestParameters | map<string> | — | |
integration.requestTemplates | map<string> | — | |
integration.responseTransferMode | enum | — | Allowed: BUFFERED, STREAM |
integration.timeoutInMillis | integer | — | |
integration.type | enum | yes | Allowed: AWS, AWS_PROXY, HTTP, HTTP_PROXY, MOCK |
integration.uri | string | — | |
methodResponses | array<object> | — | |
methodResponses[].responseModels | map<string> | — | |
methodResponses[].responseParameters | map<string> | — | |
methodResponses[].statusCode | string | yes | |
operationName | 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. |
requestModels | map<string> | — | |
requestParameters | map<string> | — | |
requestValidatorId | string | — | |
resourceId | string | yes | Create-only in AWS: changing it requires replacing the resource. |
restApiId | string | yes | Create-only in AWS: changing it requires replacing the resource. |
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. |
ApiGatewayModel # CLOUD CONTROL · AWS::ApiGateway::Model
ApiGatewayModel manages AWS::ApiGateway::Model through the AWS Cloud Control API.
kubectl get apigatewaymodels · example on GitHub
Example
# ApiGatewayModel — API Gateway
# 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/apigateway.html#apigatewaymodel
apiVersion: aws.konfig.io/v1alpha1
kind: ApiGatewayModel
metadata:
name: example-apigatewaymodel
namespace: default
spec:
contentType: example
description: Managed by konfig-konector
name: example-apigatewaymodel
providerRef:
name: example-apigatewaymodel
region: us-east-1
restApiId: example-id
Spec
| Field | Type | Required | Description |
|---|---|---|---|
contentType | string | — | Create-only in AWS: changing it requires replacing the resource. |
description | string | — | |
name | string | — | A name for the model. |
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. |
restApiId | string | yes | Create-only in AWS: changing it requires replacing the resource. |
schema | object | — |
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. |
ApiGatewayRequestValidator # CLOUD CONTROL · AWS::ApiGateway::RequestValidator
ApiGatewayRequestValidator manages AWS::ApiGateway::RequestValidator through the AWS Cloud Control API.
kubectl get apigatewayrequestvalidators · example on GitHub
Example
# ApiGatewayRequestValidator — API Gateway
# 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/apigateway.html#apigatewayrequestvalidator
apiVersion: aws.konfig.io/v1alpha1
kind: ApiGatewayRequestValidator
metadata:
name: example-apigatewayrequestvalidator
namespace: default
spec:
name: example-apigatewayrequestvalidator
providerRef:
name: example-apigatewayrequestvalidator
region: us-east-1
restApiId: example-id
validateRequestBody: false
validateRequestParameters: false
Spec
| Field | Type | Required | Description |
|---|---|---|---|
name | 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. |
restApiId | string | yes | Create-only in AWS: changing it requires replacing the resource. |
validateRequestBody | boolean | — | |
validateRequestParameters | boolean | — |
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. |
requestValidatorId | string | — | Read-only: reported by AWS after creation. |
ApiGatewayResource # CLOUD CONTROL · AWS::ApiGateway::Resource
ApiGatewayResource manages AWS::ApiGateway::Resource through the AWS Cloud Control API.
kubectl get apigatewayresources · example on GitHub
Example
# ApiGatewayResource — API Gateway
# 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/apigateway.html#apigatewayresource
apiVersion: aws.konfig.io/v1alpha1
kind: ApiGatewayResource
metadata:
name: example-apigatewayresource
namespace: default
spec:
parentId: example-id
pathPart: example
providerRef:
name: example-apigatewayresource
region: us-east-1
restApiId: example-id
Spec
| Field | Type | Required | Description |
|---|---|---|---|
parentId | string | yes | Create-only in AWS: changing it requires replacing the resource. |
pathPart | string | yes | 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. |
restApiId | string | yes | Create-only in AWS: changing it requires replacing the resource. |
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. |
resourceId | string | — | Read-only: reported by AWS after creation. |
ApiGatewayUsagePlan # CLOUD CONTROL · AWS::ApiGateway::UsagePlan
ApiGatewayUsagePlan manages AWS::ApiGateway::UsagePlan through the AWS Cloud Control API.
kubectl get apigatewayusageplans · example on GitHub
Example
# ApiGatewayUsagePlan — API Gateway
# 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/apigateway.html#apigatewayusageplan
apiVersion: aws.konfig.io/v1alpha1
kind: ApiGatewayUsagePlan
metadata:
name: example-apigatewayusageplan
namespace: default
spec:
apiStages:
- stage: example
throttle: {}
description: Managed by konfig-konector
providerRef:
name: example-apigatewayusageplan
region: us-east-1
quota:
limit: 1
offset: 1
period: example
tags:
- key: example
value: example
throttle:
burstLimit: 1
rateLimit: 1
usagePlanName: example-apigatewayusageplan
Spec
| Field | Type | Required | Description |
|---|---|---|---|
apiStages | array<object> | — | |
apiStages[].apiId | string | — | |
apiStages[].stage | string | — | |
apiStages[].throttle | map<string> | — | |
description | 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. |
quota | object | — | ApiGatewayUsagePlanQuotaSettings is a nested property type of AWS::ApiGateway::UsagePlan. |
quota.limit | integer | — | |
quota.offset | integer | — | |
quota.period | string | — | |
tags | array<object> | — | |
tags[].key | string | yes | |
tags[].value | string | yes | |
throttle | object | — | ApiGatewayUsagePlanThrottleSettings is a nested property type of AWS::ApiGateway::UsagePlan. |
throttle.burstLimit | integer | — | |
throttle.rateLimit | number | — | |
usagePlanName | 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. |
id | string | — | 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. |
ApiGatewayUsagePlanKey # CLOUD CONTROL · AWS::ApiGateway::UsagePlanKey
ApiGatewayUsagePlanKey manages AWS::ApiGateway::UsagePlanKey through the AWS Cloud Control API.
kubectl get apigatewayusageplankeys · example on GitHub
Example
# ApiGatewayUsagePlanKey — API Gateway
# 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/apigateway.html#apigatewayusageplankey
apiVersion: aws.konfig.io/v1alpha1
kind: ApiGatewayUsagePlanKey
metadata:
name: example-apigatewayusageplankey
namespace: default
spec:
keyId: example-id
keyType: API_KEY
providerRef:
name: example-apigatewayusageplankey
region: us-east-1
usagePlanId: example-id
Spec
| Field | Type | Required | Description |
|---|---|---|---|
keyId | string | yes | The Id of the UsagePlanKey resource. |
keyType | enum | yes | Create-only in AWS: changing it requires replacing the resource. Allowed: API_KEY |
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. |
usagePlanId | string | yes | The Id of the UsagePlan resource representing the usage plan containing the UsagePlanKey resource representing a plan customer. |
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. |
id | string | — | 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. |
ApiGatewayVpcLink # CLOUD CONTROL · AWS::ApiGateway::VpcLink
ApiGatewayVpcLink manages AWS::ApiGateway::VpcLink through the AWS Cloud Control API.
kubectl get apigatewayvpclinks · example on GitHub
Example
# ApiGatewayVpcLink — API Gateway
# 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/apigateway.html#apigatewayvpclink
apiVersion: aws.konfig.io/v1alpha1
kind: ApiGatewayVpcLink
metadata:
name: example-apigatewayvpclink
namespace: default
spec:
description: Managed by konfig-konector
name: example-apigatewayvpclink
providerRef:
name: example-apigatewayvpclink
region: us-east-1
tags:
- key: example
value: example
targetArns:
- example
Spec
| Field | Type | Required | Description |
|---|---|---|---|
description | string | — | |
name | 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. |
tags | array<object> | — | An array of arbitrary tags (key-value pairs) to associate with the VPC link. |
tags[].key | string | yes | |
tags[].value | string | yes | |
targetArns | array<string> | yes | Create-only in AWS: changing it requires replacing the resource. |
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. |
vpcLinkId | string | — | Read-only: reported by AWS after creation. |
RestAPI # GA
RestAPI is the Schema for managing API Gateway REST APIs.
kubectl get restapis · example on GitHub
Example
# RestAPI — API Gateway
# 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/apigateway.html#restapi
apiVersion: aws.konfig.io/v1alpha1
kind: RestAPI
metadata:
name: example-restapi
namespace: default
spec:
body: example
description: Managed by konfig-konector
disableExecuteApiEndpoint: false
endpointTypes:
- example
minimumCompressionSize: 2
name: example-restapi
policy: '{"Version": "2012-10-17", "Statement": [{"Effect": "Allow", "Action": ["s3:GetObject"], "Resource":
"*"}]}'
providerRef:
name: example-restapi
region: us-east-1
tags:
environment: dev
team: platform
Spec
| Field | Type | Required | Description |
|---|---|---|---|
body | string | — | Body is an OpenAPI (Swagger) definition in JSON or YAML. |
description | string | — | Description of the REST API. |
disableExecuteApiEndpoint | boolean | — | DisableExecuteAPIEndpoint disables the default execute-api endpoint. |
endpointTypes | array<string> | — | EndpointTypes is the endpoint configuration (REGIONAL, EDGE, PRIVATE). |
minimumCompressionSize | integer | — | MinimumCompressionSize enables payload compression above this size in bytes (0-10485760). |
name | string | yes | Name of the REST API. |
policy | string | — | Policy is a JSON resource policy for the API. |
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 AWS resource tags to apply on creation. |
Status
| Field | Type | Required | Description |
|---|---|---|---|
apiId | string | — | APIID is the REST API identifier. |
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. |
rootResourceId | string | — | RootResourceID is the ID of the API's root ("/") resource. |
RestAPIDeployment # GA
RestAPIDeployment is the Schema for managing API Gateway REST API deployments.
kubectl get restapideployments · example on GitHub
Example
# RestAPIDeployment — API Gateway
# 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/apigateway.html#restapideployment
apiVersion: aws.konfig.io/v1alpha1
kind: RestAPIDeployment
metadata:
name: example-restapideployment
namespace: default
spec:
description: Managed by konfig-konector
providerRef:
name: example-restapideployment
region: us-east-1
restApiRef:
name: example-restapideployment
stageName: example-restapideployment
Spec
| Field | Type | Required | Description |
|---|---|---|---|
description | string | — | Description of the deployment. |
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. |
restApiRef | object | yes | RestAPIRef references the RestAPI to deploy. |
restApiRef.apiId | string | — | APIID is a direct AWS API Gateway API ID, bypassing CR lookup. |
restApiRef.name | string | — | Name of the API CR in the same namespace. |
stageName | string | — | StageName optionally creates/points a stage at the deployment. |
Status
| Field | Type | Required | Description |
|---|---|---|---|
apiId | string | — | APIID is the resolved REST API identifier the deployment was created in. |
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. |
deploymentId | string | — | DeploymentID is the deployment identifier. |
lastSyncTime | string | — | LastSyncTime is when the resource was last successfully reconciled. |
observedGeneration | integer | — | ObservedGeneration is the most recent .metadata.generation reconciled. |
RestAPIStage # GA
RestAPIStage is the Schema for managing API Gateway REST API stages.
kubectl get restapistages · example on GitHub
Example
# RestAPIStage — API Gateway
# 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/apigateway.html#restapistage
apiVersion: aws.konfig.io/v1alpha1
kind: RestAPIStage
metadata:
name: example-restapistage
namespace: default
spec:
deploymentRef:
name: example-restapistage
description: Managed by konfig-konector
providerRef:
name: example-restapistage
region: us-east-1
restApiRef:
name: example-restapistage
stageName: example-restapistage
tags:
environment: dev
team: platform
tracingEnabled: true
variables:
key: value
Spec
| Field | Type | Required | Description |
|---|---|---|---|
deploymentRef | object | yes | DeploymentRef references the RestAPIDeployment the stage points at. |
deploymentRef.deploymentId | string | — | DeploymentID is a direct AWS deployment ID, bypassing CR lookup. |
deploymentRef.name | string | — | Name of a RestAPIDeployment CR in the same namespace. |
description | string | — | Description of the stage. |
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. |
restApiRef | object | yes | RestAPIRef references the RestAPI this stage belongs to. |
restApiRef.apiId | string | — | APIID is a direct AWS API Gateway API ID, bypassing CR lookup. |
restApiRef.name | string | — | Name of the API CR in the same namespace. |
stageName | string | yes | StageName is the name of the stage. |
tags | map<string> | — | Tags are AWS resource tags to apply on creation. |
tracingEnabled | boolean | — | TracingEnabled enables X-Ray tracing for the stage. |
variables | map<string> | — | Variables are stage variables (name/value pairs). |
Status
| Field | Type | Required | Description |
|---|---|---|---|
apiId | string | — | APIID is the resolved REST API identifier the stage was created in. |
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. |
stageName | string | — | StageName is the stage name in AWS (also the primary identifier together with the API ID). |