AppSync
10 resource kinds. Generated from the operator's CRD schemas.
aws.konfig.io/v1alpha1
AppSyncApi # CLOUD CONTROL · AWS::AppSync::Api
AppSyncApi manages AWS::AppSync::Api through the AWS Cloud Control API.
kubectl get appsyncapis · example on GitHub
Example
# AppSyncApi — AppSync
# 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/appsync.html#appsyncapi
apiVersion: aws.konfig.io/v1alpha1
kind: AppSyncApi
metadata:
name: example-appsyncapi
namespace: default
spec:
eventConfig:
authProviders:
- authType: AMAZON_COGNITO_USER_POOLS
connectionAuthModes:
- authType: AMAZON_COGNITO_USER_POOLS
defaultPublishAuthModes:
- authType: AMAZON_COGNITO_USER_POOLS
defaultSubscribeAuthModes:
- authType: AMAZON_COGNITO_USER_POOLS
logConfig:
cloudWatchLogsRoleArn: arn:aws:iam::123456789012:role/example-role
logLevel: NONE
name: example-appsyncapi
ownerContact: example
providerRef:
name: example-appsyncapi
region: us-east-1
tags:
- key: example
value: example
Spec
| Field | Type | Required | Description |
|---|---|---|---|
eventConfig | object | — | AppSyncApiEventConfig is a nested property type of AWS::AppSync::Api. |
eventConfig.authProviders | array<object> | yes | |
eventConfig.authProviders[].authType | enum | yes | Allowed: AMAZON_COGNITO_USER_POOLS, AWS_IAM, API_KEY, OPENID_CONNECT, AWS_LAMBDA |
eventConfig.authProviders[].cognitoConfig | object | — | AppSyncApiCognitoConfig is a nested property type of AWS::AppSync::Api. |
eventConfig.authProviders[].cognitoConfig.appIdClientRegex | string | — | |
eventConfig.authProviders[].cognitoConfig.awsRegion | string | yes | |
eventConfig.authProviders[].cognitoConfig.userPoolId | string | yes | |
eventConfig.authProviders[].lambdaAuthorizerConfig | object | — | AppSyncApiLambdaAuthorizerConfig is a nested property type of AWS::AppSync::Api. |
eventConfig.authProviders[].lambdaAuthorizerConfig.authorizerResultTtlInSeconds | integer | — | |
eventConfig.authProviders[].lambdaAuthorizerConfig.authorizerUri | string | yes | |
eventConfig.authProviders[].lambdaAuthorizerConfig.identityValidationExpression | string | — | |
eventConfig.authProviders[].openIDConnectConfig | object | — | AppSyncApiOpenIDConnectConfig is a nested property type of AWS::AppSync::Api. |
eventConfig.authProviders[].openIDConnectConfig.authTTL | number | — | |
eventConfig.authProviders[].openIDConnectConfig.clientId | string | — | |
eventConfig.authProviders[].openIDConnectConfig.iatTTL | number | — | |
eventConfig.authProviders[].openIDConnectConfig.issuer | string | yes | |
eventConfig.connectionAuthModes | array<object> | yes | |
eventConfig.connectionAuthModes[].authType | enum | — | Allowed: AMAZON_COGNITO_USER_POOLS, AWS_IAM, API_KEY, OPENID_CONNECT, AWS_LAMBDA |
eventConfig.defaultPublishAuthModes | array<object> | yes | |
eventConfig.defaultPublishAuthModes[].authType | enum | — | Allowed: AMAZON_COGNITO_USER_POOLS, AWS_IAM, API_KEY, OPENID_CONNECT, AWS_LAMBDA |
eventConfig.defaultSubscribeAuthModes | array<object> | yes | |
eventConfig.defaultSubscribeAuthModes[].authType | enum | — | Allowed: AMAZON_COGNITO_USER_POOLS, AWS_IAM, API_KEY, OPENID_CONNECT, AWS_LAMBDA |
eventConfig.logConfig | object | — | AppSyncApiEventLogConfig is a nested property type of AWS::AppSync::Api. |
eventConfig.logConfig.cloudWatchLogsRoleArn | string | yes | |
eventConfig.logConfig.logLevel | enum | yes | Allowed: NONE, ERROR, ALL, INFO, DEBUG |
name | string | yes | |
ownerContact | 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 |
|---|---|---|---|
apiArn | string | — | The Amazon Resource Name (ARN) of the AppSync Api Read-only: reported by AWS after creation. |
apiId | string | — | The unique identifier for the AppSync Api generated by the service 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. |
dns | object | — | Read-only: reported by AWS after creation. |
dns.http | string | — | |
dns.realtime | string | — | |
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. |
AppSyncChannelNamespace # CLOUD CONTROL · AWS::AppSync::ChannelNamespace
AppSyncChannelNamespace manages AWS::AppSync::ChannelNamespace through the AWS Cloud Control API.
kubectl get appsyncchannelnamespaces · example on GitHub
Example
# AppSyncChannelNamespace — AppSync
# 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/appsync.html#appsyncchannelnamespace
apiVersion: aws.konfig.io/v1alpha1
kind: AppSyncChannelNamespace
metadata:
name: example-appsyncchannelnamespace
namespace: default
spec:
apiId: example-id
codeHandlers: example
codeS3Location: example
handlerConfigs:
onPublish:
behavior: CODE
integration:
dataSourceName: example-appsyncchannelnamespace
onSubscribe:
behavior: CODE
integration:
dataSourceName: example-appsyncchannelnamespace
name: example-appsyncchannelnamespace
providerRef:
name: example-appsyncchannelnamespace
region: us-east-1
publishAuthModes:
- authType: AMAZON_COGNITO_USER_POOLS
subscribeAuthModes:
- authType: AMAZON_COGNITO_USER_POOLS
tags:
- key: example
value: example
Spec
| Field | Type | Required | Description |
|---|---|---|---|
apiId | string | yes | AppSync Api Id that this Channel Namespace belongs to. |
codeHandlers | string | — | |
codeS3Location | string | — | The Amazon S3 endpoint where the code is located. |
handlerConfigs | object | — | AppSyncChannelNamespaceHandlerConfigs is a nested property type of AWS::AppSync::ChannelNamespace. |
handlerConfigs.onPublish | object | — | AppSyncChannelNamespaceHandlerConfig is a nested property type of AWS::AppSync::ChannelNamespace. |
handlerConfigs.onPublish.behavior | enum | yes | Allowed: CODE, DIRECT |
handlerConfigs.onPublish.integration | object | yes | AppSyncChannelNamespaceIntegration is a nested property type of AWS::AppSync::ChannelNamespace. |
handlerConfigs.onPublish.integration.dataSourceName | string | yes | Data source to invoke for this integration. |
handlerConfigs.onPublish.integration.lambdaConfig | object | — | AppSyncChannelNamespaceLambdaConfig is a nested property type of AWS::AppSync::ChannelNamespace. |
handlerConfigs.onPublish.integration.lambdaConfig.invokeType | enum | yes | Allowed: REQUEST_RESPONSE, EVENT |
handlerConfigs.onSubscribe | object | — | AppSyncChannelNamespaceHandlerConfig is a nested property type of AWS::AppSync::ChannelNamespace. |
handlerConfigs.onSubscribe.behavior | enum | yes | Allowed: CODE, DIRECT |
handlerConfigs.onSubscribe.integration | object | yes | AppSyncChannelNamespaceIntegration is a nested property type of AWS::AppSync::ChannelNamespace. |
handlerConfigs.onSubscribe.integration.dataSourceName | string | yes | Data source to invoke for this integration. |
handlerConfigs.onSubscribe.integration.lambdaConfig | object | — | AppSyncChannelNamespaceLambdaConfig is a nested property type of AWS::AppSync::ChannelNamespace. |
handlerConfigs.onSubscribe.integration.lambdaConfig.invokeType | enum | yes | Allowed: REQUEST_RESPONSE, EVENT |
name | 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. |
publishAuthModes | array<object> | — | List of AuthModes supported for Publish operations. |
publishAuthModes[].authType | enum | — | Allowed: AMAZON_COGNITO_USER_POOLS, AWS_IAM, API_KEY, OPENID_CONNECT, AWS_LAMBDA |
subscribeAuthModes | array<object> | — | List of AuthModes supported for Subscribe operations. |
subscribeAuthModes[].authType | enum | — | Allowed: AMAZON_COGNITO_USER_POOLS, AWS_IAM, API_KEY, OPENID_CONNECT, AWS_LAMBDA |
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). |
channelNamespaceArn | 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. |
AppSyncDataSource # CLOUD CONTROL · AWS::AppSync::DataSource
AppSyncDataSource manages AWS::AppSync::DataSource through the AWS Cloud Control API.
kubectl get appsyncdatasources · example on GitHub
Example
# AppSyncDataSource — AppSync
# 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/appsync.html#appsyncdatasource
apiVersion: aws.konfig.io/v1alpha1
kind: AppSyncDataSource
metadata:
name: example-appsyncdatasource
namespace: default
spec:
apiId: example-id
description: Managed by konfig-konector
dynamoDBConfig:
awsRegion: example
deltaSyncConfig:
baseTableTTL: example
deltaSyncTableName: example-appsyncdatasource
deltaSyncTableTTL: example
tableName: example-appsyncdatasource
useCallerCredentials: false
versioned: false
elasticsearchConfig:
awsRegion: example
endpoint: example
eventBridgeConfig:
eventBusArn: arn:aws:iam::123456789012:role/example-role
httpConfig:
authorizationConfig:
authorizationType: example
awsIamConfig:
signingRegion: example
signingServiceName: example-appsyncdatasource
endpoint: example
lambdaConfig:
lambdaFunctionArn: arn:aws:iam::123456789012:role/example-role
metricsConfig: DISABLED
name: example-appsyncdatasource
openSearchServiceConfig:
awsRegion: example
endpoint: example
providerRef:
name: example-appsyncdatasource
region: us-east-1
relationalDatabaseConfig:
rdsHttpEndpointConfig:
awsRegion: example
awsSecretStoreArn: arn:aws:iam::123456789012:role/example-role
databaseName: example-appsyncdatasource
dbClusterIdentifier: example
schema: example
relationalDatabaseSourceType: example
serviceRoleArn: arn:aws:iam::123456789012:role/example-role
type: example
Spec
| Field | Type | Required | Description |
|---|---|---|---|
apiId | string | yes | Unique AWS AppSync GraphQL API identifier where this data source will be created. |
description | string | — | The description of the data source. |
dynamoDBConfig | object | — | AWS Region and TableName for an Amazon DynamoDB table in your account. |
dynamoDBConfig.awsRegion | string | yes | The AWS Region. |
dynamoDBConfig.deltaSyncConfig | object | — | The DeltaSyncConfig for a versioned datasource. |
dynamoDBConfig.deltaSyncConfig.baseTableTTL | string | yes | The number of minutes that an Item is stored in the data source. |
dynamoDBConfig.deltaSyncConfig.deltaSyncTableName | string | yes | The Delta Sync table name. |
dynamoDBConfig.deltaSyncConfig.deltaSyncTableTTL | string | yes | The number of minutes that a Delta Sync log entry is stored in the Delta Sync table. |
dynamoDBConfig.tableName | string | yes | The table name. |
dynamoDBConfig.useCallerCredentials | boolean | — | Set to TRUE to use AWS Identity and Access Management with this data source. |
dynamoDBConfig.versioned | boolean | — | Set to TRUE to use Conflict Detection and Resolution with this data source. |
elasticsearchConfig | object | — | AWS Region and Endpoints for an Amazon OpenSearch Service domain in your account. |
elasticsearchConfig.awsRegion | string | yes | The AWS Region. |
elasticsearchConfig.endpoint | string | yes | The endpoint. |
eventBridgeConfig | object | — | ARN for the EventBridge bus. |
eventBridgeConfig.eventBusArn | string | yes | ARN for the EventBridge bus. |
httpConfig | object | — | Endpoints for an HTTP data source. |
httpConfig.authorizationConfig | object | — | The authorization configuration. |
httpConfig.authorizationConfig.authorizationType | string | yes | The authorization type that the HTTP endpoint requires. |
httpConfig.authorizationConfig.awsIamConfig | object | — | The AWS Identity and Access Management settings. |
httpConfig.authorizationConfig.awsIamConfig.signingRegion | string | — | The signing Region for AWS Identity and Access Management authorization. |
httpConfig.authorizationConfig.awsIamConfig.signingServiceName | string | — | The signing service name for AWS Identity and Access Management authorization. |
httpConfig.endpoint | string | yes | The endpoint. |
lambdaConfig | object | — | An ARN of a Lambda function in valid ARN format. |
lambdaConfig.lambdaFunctionArn | string | yes | The ARN for the Lambda function. |
metricsConfig | enum | — | Allowed: DISABLED, ENABLED |
name | string | yes | Friendly name for you to identify your AppSync data source after creation. |
openSearchServiceConfig | object | — | AWS Region and Endpoints for an Amazon OpenSearch Service domain in your account. |
openSearchServiceConfig.awsRegion | string | yes | The AWS Region. |
openSearchServiceConfig.endpoint | string | yes | The endpoint. |
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. |
relationalDatabaseConfig | object | — | Relational Database configuration of the relational database data source. |
relationalDatabaseConfig.rdsHttpEndpointConfig | object | — | Information about the Amazon RDS resource. |
relationalDatabaseConfig.rdsHttpEndpointConfig.awsRegion | string | yes | AWS Region for RDS HTTP endpoint. |
relationalDatabaseConfig.rdsHttpEndpointConfig.awsSecretStoreArn | string | yes | The ARN for database credentials stored in AWS Secrets Manager. |
relationalDatabaseConfig.rdsHttpEndpointConfig.databaseName | string | — | Logical database name. |
relationalDatabaseConfig.rdsHttpEndpointConfig.dbClusterIdentifier | string | yes | Amazon RDS cluster Amazon Resource Name (ARN). |
relationalDatabaseConfig.rdsHttpEndpointConfig.schema | string | — | Logical schema name. |
relationalDatabaseConfig.relationalDatabaseSourceType | string | yes | The type of relational data source. |
serviceRoleArn | string | — | The AWS Identity and Access Management service role ARN for the data source. |
type | string | yes | The type of the data source. |
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. |
dataSourceArn | string | — | The Amazon Resource Name (ARN) of the API key, such as arn:aws:appsync:us-east-1:123456789012:apis/graphqlapiid/datasources/datasourcename. |
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. |
AppSyncDomainName # CLOUD CONTROL · AWS::AppSync::DomainName
AppSyncDomainName manages AWS::AppSync::DomainName through the AWS Cloud Control API.
kubectl get appsyncdomainnames · example on GitHub
Example
# AppSyncDomainName — AppSync
# 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/appsync.html#appsyncdomainname
apiVersion: aws.konfig.io/v1alpha1
kind: AppSyncDomainName
metadata:
name: example-appsyncdomainname
namespace: default
spec:
certificateArn: arn:aws:iam::123456789012:role/example-role
description: Managed by konfig-konector
domainName: example-appsyncdomainname
providerRef:
name: example-appsyncdomainname
region: us-east-1
tags:
- key: example
value: example
Spec
| Field | Type | Required | Description |
|---|---|---|---|
certificateArn | string | yes | Create-only in AWS: changing it requires replacing the resource. |
description | string | — | |
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. |
tags | array<object> | — | |
tags[].key | string | yes | |
tags[].value | string | yes |
Status
| Field | Type | Required | Description |
|---|---|---|---|
appSyncDomainName | 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. |
domainNameArn | string | — | The Amazon Resource Name (ARN) for the Domain Name. |
hostedZoneId | 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. |
AppSyncDomainNameApiAssociation # CLOUD CONTROL · AWS::AppSync::DomainNameApiAssociation
AppSyncDomainNameApiAssociation manages AWS::AppSync::DomainNameApiAssociation through the AWS Cloud Control API.
kubectl get appsyncdomainnameapiassociations · example on GitHub
Example
# AppSyncDomainNameApiAssociation — AppSync
# 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/appsync.html#appsyncdomainnameapiassociation
apiVersion: aws.konfig.io/v1alpha1
kind: AppSyncDomainNameApiAssociation
metadata:
name: example-appsyncdomainnameapiassociation
namespace: default
spec:
apiId: example-id
domainName: example-appsyncdomainnameapiassociation
providerRef:
name: example-appsyncdomainnameapiassociation
region: us-east-1
Spec
| Field | Type | Required | Description |
|---|---|---|---|
apiId | string | yes | |
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. |
Status
| Field | Type | Required | Description |
|---|---|---|---|
apiAssociationIdentifier | 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. |
AppSyncFunctionConfiguration # CLOUD CONTROL · AWS::AppSync::FunctionConfiguration
AppSyncFunctionConfiguration manages AWS::AppSync::FunctionConfiguration through the AWS Cloud Control API.
kubectl get appsyncfunctionconfigurations · example on GitHub
Example
# AppSyncFunctionConfiguration — AppSync
# 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/appsync.html#appsyncfunctionconfiguration
apiVersion: aws.konfig.io/v1alpha1
kind: AppSyncFunctionConfiguration
metadata:
name: example-appsyncfunctionconfiguration
namespace: default
spec:
apiId: example-id
code: example
codeS3Location: example
dataSourceName: example-appsyncfunctionconfiguration
description: Managed by konfig-konector
functionVersion: '1.0'
maxBatchSize: 2
name: example-appsyncfunctionconfiguration
providerRef:
name: example-appsyncfunctionconfiguration
region: us-east-1
requestMappingTemplate: example
requestMappingTemplateS3Location: example
responseMappingTemplate: example
responseMappingTemplateS3Location: example
runtime:
name: example-appsyncfunctionconfiguration
runtimeVersion: '1.0'
syncConfig:
conflictDetection: example
conflictHandler: example
lambdaConflictHandlerConfig:
lambdaConflictHandlerArn: arn:aws:iam::123456789012:role/example-role
Spec
| Field | Type | Required | Description |
|---|---|---|---|
apiId | string | yes | The AWS AppSync GraphQL API that you want to attach using this function. |
code | string | — | The resolver code that contains the request and response functions. |
codeS3Location | string | — | The Amazon S3 endpoint (where the code is located??). |
dataSourceName | string | yes | The name of data source this function will attach. |
description | string | — | The function description. |
functionVersion | string | — | The version of the request mapping template. |
maxBatchSize | integer | — | The maximum number of resolver request inputs that will be sent to a single AWS Lambda function in a BatchInvoke operation. |
name | string | yes | The name of the function. |
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. |
requestMappingTemplate | string | — | The Function request mapping template. |
requestMappingTemplateS3Location | string | — | Describes a Sync configuration for a resolver. |
responseMappingTemplate | string | — | The Function response mapping template. |
responseMappingTemplateS3Location | string | — | The location of a response mapping template in an Amazon S3 bucket. |
runtime | object | — | Describes a runtime used by an AWS AppSync pipeline resolver or AWS AppSync function. |
runtime.name | string | yes | The name of the runtime to use. |
runtime.runtimeVersion | string | yes | The version of the runtime to use. |
syncConfig | object | — | Describes a Sync configuration for a resolver. |
syncConfig.conflictDetection | string | yes | The Conflict Detection strategy to use. |
syncConfig.conflictHandler | string | — | The Conflict Resolution strategy to perform in the event of a conflict. |
syncConfig.lambdaConflictHandlerConfig | object | — | AppSyncFunctionConfigurationLambdaConflictHandlerConfig is a nested property type of AWS::AppSync::FunctionConfiguration. |
syncConfig.lambdaConflictHandlerConfig.lambdaConflictHandlerArn | string | — | The Amazon Resource Name (ARN) for the Lambda function to use as the Conflict Handler. |
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. |
functionArn | string | — | The ARN for the function generated by the service Read-only: reported by AWS after creation. |
functionId | string | — | The unique identifier for the function generated by the service 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. |
AppSyncGraphQLApi # CLOUD CONTROL · AWS::AppSync::GraphQLApi
AppSyncGraphQLApi manages AWS::AppSync::GraphQLApi through the AWS Cloud Control API.
kubectl get appsyncgraphqlapis · example on GitHub
Example
# AppSyncGraphQLApi — AppSync
# 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/appsync.html#appsyncgraphqlapi
apiVersion: aws.konfig.io/v1alpha1
kind: AppSyncGraphQLApi
metadata:
name: example-appsyncgraphqlapi
namespace: default
spec:
additionalAuthenticationProviders:
- authenticationType: example
lambdaAuthorizerConfig:
authorizerResultTtlInSeconds: 300
authorizerUri: example
identityValidationExpression: example
openIDConnectConfig:
authTTL: 1
iatTTL: 1
issuer: example
userPoolConfig:
appIdClientRegex: example
awsRegion: example
apiType: example
authenticationType: example
enhancedMetricsConfig:
dataSourceLevelMetricsBehavior: example
operationLevelMetricsConfig: example
resolverLevelMetricsBehavior: example
environmentVariables:
key: value
introspectionConfig: example
lambdaAuthorizerConfig:
authorizerResultTtlInSeconds: 300
authorizerUri: example
identityValidationExpression: example
logConfig:
cloudWatchLogsRoleArn: arn:aws:iam::123456789012:role/example-role
excludeVerboseContent: false
fieldLogLevel: example
mergedApiExecutionRoleArn: arn:aws:iam::123456789012:role/example-role
name: example-appsyncgraphqlapi
openIDConnectConfig:
authTTL: 1
iatTTL: 1
issuer: example
ownerContact: example
providerRef:
name: example-appsyncgraphqlapi
region: us-east-1
queryDepthLimit: 1
resolverCountLimit: 2
tags:
- key: example
value: example
userPoolConfig:
appIdClientRegex: example
awsRegion: example
defaultAction: example
visibility: example
xrayEnabled: true
Spec
| Field | Type | Required | Description |
|---|---|---|---|
additionalAuthenticationProviders | array<object> | — | A list of additional authentication providers for the GraphqlApi API. |
additionalAuthenticationProviders[].authenticationType | string | yes | The authentication type for API key, AWS Identity and Access Management, OIDC, Amazon Cognito user pools, or AWS Lambda. |
additionalAuthenticationProviders[].lambdaAuthorizerConfig | object | — | AppSyncGraphQLApiLambdaAuthorizerConfig is a nested property type of AWS::AppSync::GraphQLApi. |
additionalAuthenticationProviders[].lambdaAuthorizerConfig.authorizerResultTtlInSeconds | integer | — | The number of seconds a response should be cached for. |
additionalAuthenticationProviders[].lambdaAuthorizerConfig.authorizerUri | string | — | The ARN of the Lambda function to be called for authorization. |
additionalAuthenticationProviders[].lambdaAuthorizerConfig.identityValidationExpression | string | — | A regular expression for validation of tokens before the Lambda function is called. |
additionalAuthenticationProviders[].openIDConnectConfig | object | — | AppSyncGraphQLApiOpenIDConnectConfig is a nested property type of AWS::AppSync::GraphQLApi. |
additionalAuthenticationProviders[].openIDConnectConfig.authTTL | number | — | The number of milliseconds that a token is valid after being authenticated. |
additionalAuthenticationProviders[].openIDConnectConfig.clientId | string | — | The client identifier of the Relying party at the OpenID identity provider. |
additionalAuthenticationProviders[].openIDConnectConfig.iatTTL | number | — | The number of milliseconds that a token is valid after it's issued to a user. |
additionalAuthenticationProviders[].openIDConnectConfig.issuer | string | — | The issuer for the OIDC configuration. |
additionalAuthenticationProviders[].userPoolConfig | object | — | AppSyncGraphQLApiCognitoUserPoolConfig is a nested property type of AWS::AppSync::GraphQLApi. |
additionalAuthenticationProviders[].userPoolConfig.appIdClientRegex | string | — | A regular expression for validating the incoming Amazon Cognito user pool app client ID. |
additionalAuthenticationProviders[].userPoolConfig.awsRegion | string | — | The AWS Region in which the user pool was created. |
additionalAuthenticationProviders[].userPoolConfig.userPoolId | string | — | The user pool ID |
apiType | string | — | The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API (MERGED). |
authenticationType | string | yes | Security configuration for your GraphQL API |
enhancedMetricsConfig | object | — | Enables and controls the enhanced metrics feature. |
enhancedMetricsConfig.dataSourceLevelMetricsBehavior | string | yes | Controls how data source metrics will be emitted to CloudWatch. |
enhancedMetricsConfig.operationLevelMetricsConfig | string | yes | Controls how operation metrics will be emitted to CloudWatch. |
enhancedMetricsConfig.resolverLevelMetricsBehavior | string | yes | Controls how resolver metrics will be emitted to CloudWatch. |
environmentVariables | map<string> | — | A map containing the list of resources with their properties and environment variables. |
introspectionConfig | string | — | Sets the value of the GraphQL API to enable (ENABLED) or disable (DISABLED) introspection. |
lambdaAuthorizerConfig | object | — | A LambdaAuthorizerConfig holds configuration on how to authorize AWS AppSync API access when using the AWS_LAMBDA authorizer mode. |
lambdaAuthorizerConfig.authorizerResultTtlInSeconds | integer | — | The number of seconds a response should be cached for. |
lambdaAuthorizerConfig.authorizerUri | string | — | The ARN of the Lambda function to be called for authorization. |
lambdaAuthorizerConfig.identityValidationExpression | string | — | A regular expression for validation of tokens before the Lambda function is called. |
logConfig | object | — | The Amazon CloudWatch Logs configuration. |
logConfig.cloudWatchLogsRoleArn | string | yes | The service role that AWS AppSync will assume to publish to Amazon CloudWatch Logs in your account. |
logConfig.excludeVerboseContent | boolean | — | Set to TRUE to exclude sections that contain information such as headers, context, and evaluated mapping templates, regardless of logging level. |
logConfig.fieldLogLevel | string | yes | The field logging level. |
mergedApiExecutionRoleArn | string | — | The AWS Identity and Access Management service role ARN for a merged API. |
name | string | yes | The API name |
openIDConnectConfig | object | — | The OpenID Connect configuration. |
openIDConnectConfig.authTTL | number | — | The number of milliseconds that a token is valid after being authenticated. |
openIDConnectConfig.clientId | string | — | The client identifier of the Relying party at the OpenID identity provider. |
openIDConnectConfig.iatTTL | number | — | The number of milliseconds that a token is valid after it's issued to a user. |
openIDConnectConfig.issuer | string | — | The issuer for the OIDC configuration. |
ownerContact | string | — | The owner contact information for an API 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. |
queryDepthLimit | integer | — | The maximum depth a query can have in a single request. |
resolverCountLimit | integer | — | The maximum number of resolvers that can be invoked in a single request. |
tags | array<object> | — | An arbitrary set of tags (key-value pairs) for this GraphQL API. |
tags[].key | string | yes | |
tags[].value | string | yes | |
userPoolConfig | object | — | Optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint. |
userPoolConfig.appIdClientRegex | string | — | A regular expression for validating the incoming Amazon Cognito user pool app client ID. |
userPoolConfig.awsRegion | string | — | The AWS Region in which the user pool was created. |
userPoolConfig.defaultAction | string | — | The action that you want your GraphQL API to take when a request that uses Amazon Cognito user pool authentication doesn't match the Amazon Cognito user pool configuration. |
userPoolConfig.userPoolId | string | — | The user pool ID. |
visibility | string | — | Sets the scope of the GraphQL API to public (GLOBAL) or private (PRIVATE). |
xrayEnabled | boolean | — | A flag indicating whether to use AWS X-Ray tracing for this GraphqlApi. |
Status
| Field | Type | Required | Description |
|---|---|---|---|
apiId | string | — | Unique AWS AppSync GraphQL API identifier. |
arn | string | — | The Amazon Resource Name (ARN) of the API key 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. |
graphQLDns | string | — | The fully qualified domain name (FQDN) of the endpoint URL of your GraphQL API. |
graphQLEndpointArn | string | — | The GraphQL endpoint ARN. |
graphQLUrl | string | — | The Endpoint URL of your GraphQL API. |
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. |
realtimeDns | string | — | The fully qualified domain name (FQDN) of the real-time endpoint URL of your GraphQL API. |
realtimeUrl | string | — | The GraphQL API real-time endpoint URL. |
requestToken | string | — | RequestToken tracks an in-flight asynchronous operation. |
AppSyncResolver # CLOUD CONTROL · AWS::AppSync::Resolver
AppSyncResolver manages AWS::AppSync::Resolver through the AWS Cloud Control API.
kubectl get appsyncresolvers · example on GitHub
Example
# AppSyncResolver — AppSync
# 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/appsync.html#appsyncresolver
apiVersion: aws.konfig.io/v1alpha1
kind: AppSyncResolver
metadata:
name: example-appsyncresolver
namespace: default
spec:
apiId: example-id
cachingConfig:
cachingKeys:
- example
ttl: 1
code: example
codeS3Location: example
dataSourceName: example-appsyncresolver
fieldName: example-appsyncresolver
kind: example
maxBatchSize: 2
metricsConfig: ENABLED
pipelineConfig:
functions:
- example
providerRef:
name: example-appsyncresolver
region: us-east-1
requestMappingTemplate: example
requestMappingTemplateS3Location: example
responseMappingTemplate: example
responseMappingTemplateS3Location: example
runtime:
name: example-appsyncresolver
runtimeVersion: '1.0'
syncConfig:
conflictDetection: example
conflictHandler: example
lambdaConflictHandlerConfig:
lambdaConflictHandlerArn: arn:aws:iam::123456789012:role/example-role
typeName: example-appsyncresolver
Spec
| Field | Type | Required | Description |
|---|---|---|---|
apiId | string | yes | The APSYlong GraphQL API to which you want to attach this resolver. |
cachingConfig | object | — | The caching configuration for the resolver. |
cachingConfig.cachingKeys | array<string> | — | The caching keys for a resolver that has caching activated. |
cachingConfig.ttl | number | yes | The TTL in seconds for a resolver that has caching activated. |
code | string | — | The ``resolver`` code that contains the request and response functions. |
codeS3Location | string | — | The Amazon S3 endpoint. |
dataSourceName | string | — | The resolver data source name. |
fieldName | string | yes | The GraphQL field on a type that invokes the resolver. |
kind | string | — | The resolver type. |
maxBatchSize | integer | — | The maximum number of resolver request inputs that will be sent to a single LAMlong function in a ``BatchInvoke`` operation. |
metricsConfig | enum | — | Enables or disables enhanced resolver metrics for specified resolvers. Allowed: ENABLED, DISABLED |
pipelineConfig | object | — | Functions linked with the pipeline resolver. |
pipelineConfig.functions | array<string> | — | A list of ``Function`` objects. |
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. |
requestMappingTemplate | string | — | The request mapping template. |
requestMappingTemplateS3Location | string | — | The location of a request mapping template in an S3 bucket. |
responseMappingTemplate | string | — | The response mapping template. |
responseMappingTemplateS3Location | string | — | The location of a response mapping template in an S3 bucket. |
runtime | object | — | Describes a runtime used by an APSYlong resolver or APSYlong function. |
runtime.name | string | yes | The ``name`` of the runtime to use. |
runtime.runtimeVersion | string | yes | The ``version`` of the runtime to use. |
syncConfig | object | — | The ``SyncConfig`` for a resolver attached to a versioned data source. |
syncConfig.conflictDetection | string | yes | The Conflict Detection strategy to use. |
syncConfig.conflictHandler | string | — | The Conflict Resolution strategy to perform in the event of a conflict. |
syncConfig.lambdaConflictHandlerConfig | object | — | The ``LambdaConflictHandlerConfig`` when configuring ``LAMBDA`` as the Conflict Handler. |
syncConfig.lambdaConflictHandlerConfig.lambdaConflictHandlerArn | string | — | The Amazon Resource Name (ARN) for the Lambda function to use as the Conflict Handler. |
typeName | string | yes | The GraphQL type that invokes this resolver. |
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. |
resolverArn | string | — | Read-only: reported by AWS after creation. |
AppSyncSourceApiAssociation # CLOUD CONTROL · AWS::AppSync::SourceApiAssociation
AppSyncSourceApiAssociation manages AWS::AppSync::SourceApiAssociation through the AWS Cloud Control API.
kubectl get appsyncsourceapiassociations · example on GitHub
Example
# AppSyncSourceApiAssociation — AppSync
# 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/appsync.html#appsyncsourceapiassociation
apiVersion: aws.konfig.io/v1alpha1
kind: AppSyncSourceApiAssociation
metadata:
name: example-appsyncsourceapiassociation
namespace: default
spec:
description: Managed by konfig-konector
mergedApiIdentifier: example
providerRef:
name: example-appsyncsourceapiassociation
region: us-east-1
sourceApiIdentifier: example
Spec
| Field | Type | Required | Description |
|---|---|---|---|
description | string | — | Description of the SourceApiAssociation. |
mergedApiIdentifier | string | — | Identifier of the Merged GraphQLApi to associate. |
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. |
sourceApiAssociationConfig | object | — | Customized configuration for SourceApiAssociation. |
sourceApiIdentifier | string | — | Identifier of the Source GraphQLApi to associate. |
Status
| Field | Type | Required | Description |
|---|---|---|---|
associationArn | string | — | ARN of the SourceApiAssociation. |
associationId | string | — | Id of the SourceApiAssociation. |
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. |
lastSuccessfulMergeDate | string | — | Date of last schema successful merge. |
lastSyncTime | string | — | |
mergedApiArn | string | — | ARN of the Merged API in the association. |
mergedApiId | string | — | GraphQLApiId of the Merged API in the association. |
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. |
sourceApiArn | string | — | ARN of the source API in the association. |
sourceApiAssociationStatus | enum | — | Current status of SourceApiAssociation. Allowed: MERGE_SCHEDULED, MERGE_FAILED, MERGE_SUCCESS, MERGE_IN_PROGRESS, AUTO_MERGE_SCHEDULE_FAILED, DELETION_SCHEDULED, DELETION_IN_PROGRESS, DELETION_FAILED |
sourceApiAssociationStatusDetail | string | — | Current SourceApiAssociation status details. |
sourceApiId | string | — | GraphQLApiId of the source API in the association. |
AppSyncType # CLOUD CONTROL · AWS::AppSync::Type
AppSyncType manages AWS::AppSync::Type through the AWS Cloud Control API.
kubectl get appsynctypes · example on GitHub
Example
# AppSyncType — AppSync
# 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/appsync.html#appsynctype
apiVersion: aws.konfig.io/v1alpha1
kind: AppSyncType
metadata:
name: example-appsynctype
namespace: default
spec:
apiId: example-id
definition: example
format: SDL
providerRef:
name: example-appsynctype
region: us-east-1
Spec
| Field | Type | Required | Description |
|---|---|---|---|
apiId | string | yes | The API ID. |
definition | string | yes | The type definition, in GraphQL Schema Definition Language (SDL) format. |
format | enum | yes | The type format: SDL or JSON. Allowed: SDL, JSON |
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 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 | — | |
name | string | — | The type name. |
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. |