AppSync

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

API Group: 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

FieldTypeRequiredDescription
eventConfigobject—AppSyncApiEventConfig is a nested property type of AWS::AppSync::Api.
eventConfig.authProvidersarray<object>yes
eventConfig.authProviders[].authTypeenumyesAllowed: AMAZON_COGNITO_USER_POOLS, AWS_IAM, API_KEY, OPENID_CONNECT, AWS_LAMBDA
eventConfig.authProviders[].cognitoConfigobject—AppSyncApiCognitoConfig is a nested property type of AWS::AppSync::Api.
eventConfig.authProviders[].cognitoConfig.appIdClientRegexstring—
eventConfig.authProviders[].cognitoConfig.awsRegionstringyes
eventConfig.authProviders[].cognitoConfig.userPoolIdstringyes
eventConfig.authProviders[].lambdaAuthorizerConfigobject—AppSyncApiLambdaAuthorizerConfig is a nested property type of AWS::AppSync::Api.
eventConfig.authProviders[].lambdaAuthorizerConfig.authorizerResultTtlInSecondsinteger—
eventConfig.authProviders[].lambdaAuthorizerConfig.authorizerUristringyes
eventConfig.authProviders[].lambdaAuthorizerConfig.identityValidationExpressionstring—
eventConfig.authProviders[].openIDConnectConfigobject—AppSyncApiOpenIDConnectConfig is a nested property type of AWS::AppSync::Api.
eventConfig.authProviders[].openIDConnectConfig.authTTLnumber—
eventConfig.authProviders[].openIDConnectConfig.clientIdstring—
eventConfig.authProviders[].openIDConnectConfig.iatTTLnumber—
eventConfig.authProviders[].openIDConnectConfig.issuerstringyes
eventConfig.connectionAuthModesarray<object>yes
eventConfig.connectionAuthModes[].authTypeenum—Allowed: AMAZON_COGNITO_USER_POOLS, AWS_IAM, API_KEY, OPENID_CONNECT, AWS_LAMBDA
eventConfig.defaultPublishAuthModesarray<object>yes
eventConfig.defaultPublishAuthModes[].authTypeenum—Allowed: AMAZON_COGNITO_USER_POOLS, AWS_IAM, API_KEY, OPENID_CONNECT, AWS_LAMBDA
eventConfig.defaultSubscribeAuthModesarray<object>yes
eventConfig.defaultSubscribeAuthModes[].authTypeenum—Allowed: AMAZON_COGNITO_USER_POOLS, AWS_IAM, API_KEY, OPENID_CONNECT, AWS_LAMBDA
eventConfig.logConfigobject—AppSyncApiEventLogConfig is a nested property type of AWS::AppSync::Api.
eventConfig.logConfig.cloudWatchLogsRoleArnstringyes
eventConfig.logConfig.logLevelenumyesAllowed: NONE, ERROR, ALL, INFO, DEBUG
namestringyes
ownerContactstring—
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
tagsarray<object>—
tags[].keystringyes
tags[].valuestringyes

Status

FieldTypeRequiredDescription
apiArnstring—The Amazon Resource Name (ARN) of the AppSync Api Read-only: reported by AWS after creation.
apiIdstring—The unique identifier for the AppSync Api generated by the service Read-only: reported by AWS after creation.
attemptinteger—Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
dnsobject—Read-only: reported by AWS after creation.
dns.httpstring—
dns.realtimestring—
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
lastSyncTimestring—
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
requestTokenstring—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

FieldTypeRequiredDescription
apiIdstringyesAppSync Api Id that this Channel Namespace belongs to.
codeHandlersstring—
codeS3Locationstring—The Amazon S3 endpoint where the code is located.
handlerConfigsobject—AppSyncChannelNamespaceHandlerConfigs is a nested property type of AWS::AppSync::ChannelNamespace.
handlerConfigs.onPublishobject—AppSyncChannelNamespaceHandlerConfig is a nested property type of AWS::AppSync::ChannelNamespace.
handlerConfigs.onPublish.behaviorenumyesAllowed: CODE, DIRECT
handlerConfigs.onPublish.integrationobjectyesAppSyncChannelNamespaceIntegration is a nested property type of AWS::AppSync::ChannelNamespace.
handlerConfigs.onPublish.integration.dataSourceNamestringyesData source to invoke for this integration.
handlerConfigs.onPublish.integration.lambdaConfigobject—AppSyncChannelNamespaceLambdaConfig is a nested property type of AWS::AppSync::ChannelNamespace.
handlerConfigs.onPublish.integration.lambdaConfig.invokeTypeenumyesAllowed: REQUEST_RESPONSE, EVENT
handlerConfigs.onSubscribeobject—AppSyncChannelNamespaceHandlerConfig is a nested property type of AWS::AppSync::ChannelNamespace.
handlerConfigs.onSubscribe.behaviorenumyesAllowed: CODE, DIRECT
handlerConfigs.onSubscribe.integrationobjectyesAppSyncChannelNamespaceIntegration is a nested property type of AWS::AppSync::ChannelNamespace.
handlerConfigs.onSubscribe.integration.dataSourceNamestringyesData source to invoke for this integration.
handlerConfigs.onSubscribe.integration.lambdaConfigobject—AppSyncChannelNamespaceLambdaConfig is a nested property type of AWS::AppSync::ChannelNamespace.
handlerConfigs.onSubscribe.integration.lambdaConfig.invokeTypeenumyesAllowed: REQUEST_RESPONSE, EVENT
namestringyesCreate-only in AWS: changing it requires replacing the resource.
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
publishAuthModesarray<object>—List of AuthModes supported for Publish operations.
publishAuthModes[].authTypeenum—Allowed: AMAZON_COGNITO_USER_POOLS, AWS_IAM, API_KEY, OPENID_CONNECT, AWS_LAMBDA
subscribeAuthModesarray<object>—List of AuthModes supported for Subscribe operations.
subscribeAuthModes[].authTypeenum—Allowed: AMAZON_COGNITO_USER_POOLS, AWS_IAM, API_KEY, OPENID_CONNECT, AWS_LAMBDA
tagsarray<object>—
tags[].keystringyes
tags[].valuestringyes

Status

FieldTypeRequiredDescription
attemptinteger—Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
channelNamespaceArnstring—Read-only: reported by AWS after creation.
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
lastSyncTimestring—
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
requestTokenstring—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

FieldTypeRequiredDescription
apiIdstringyesUnique AWS AppSync GraphQL API identifier where this data source will be created.
descriptionstring—The description of the data source.
dynamoDBConfigobject—AWS Region and TableName for an Amazon DynamoDB table in your account.
dynamoDBConfig.awsRegionstringyesThe AWS Region.
dynamoDBConfig.deltaSyncConfigobject—The DeltaSyncConfig for a versioned datasource.
dynamoDBConfig.deltaSyncConfig.baseTableTTLstringyesThe number of minutes that an Item is stored in the data source.
dynamoDBConfig.deltaSyncConfig.deltaSyncTableNamestringyesThe Delta Sync table name.
dynamoDBConfig.deltaSyncConfig.deltaSyncTableTTLstringyesThe number of minutes that a Delta Sync log entry is stored in the Delta Sync table.
dynamoDBConfig.tableNamestringyesThe table name.
dynamoDBConfig.useCallerCredentialsboolean—Set to TRUE to use AWS Identity and Access Management with this data source.
dynamoDBConfig.versionedboolean—Set to TRUE to use Conflict Detection and Resolution with this data source.
elasticsearchConfigobject—AWS Region and Endpoints for an Amazon OpenSearch Service domain in your account.
elasticsearchConfig.awsRegionstringyesThe AWS Region.
elasticsearchConfig.endpointstringyesThe endpoint.
eventBridgeConfigobject—ARN for the EventBridge bus.
eventBridgeConfig.eventBusArnstringyesARN for the EventBridge bus.
httpConfigobject—Endpoints for an HTTP data source.
httpConfig.authorizationConfigobject—The authorization configuration.
httpConfig.authorizationConfig.authorizationTypestringyesThe authorization type that the HTTP endpoint requires.
httpConfig.authorizationConfig.awsIamConfigobject—The AWS Identity and Access Management settings.
httpConfig.authorizationConfig.awsIamConfig.signingRegionstring—The signing Region for AWS Identity and Access Management authorization.
httpConfig.authorizationConfig.awsIamConfig.signingServiceNamestring—The signing service name for AWS Identity and Access Management authorization.
httpConfig.endpointstringyesThe endpoint.
lambdaConfigobject—An ARN of a Lambda function in valid ARN format.
lambdaConfig.lambdaFunctionArnstringyesThe ARN for the Lambda function.
metricsConfigenum—Allowed: DISABLED, ENABLED
namestringyesFriendly name for you to identify your AppSync data source after creation.
openSearchServiceConfigobject—AWS Region and Endpoints for an Amazon OpenSearch Service domain in your account.
openSearchServiceConfig.awsRegionstringyesThe AWS Region.
openSearchServiceConfig.endpointstringyesThe endpoint.
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
relationalDatabaseConfigobject—Relational Database configuration of the relational database data source.
relationalDatabaseConfig.rdsHttpEndpointConfigobject—Information about the Amazon RDS resource.
relationalDatabaseConfig.rdsHttpEndpointConfig.awsRegionstringyesAWS Region for RDS HTTP endpoint.
relationalDatabaseConfig.rdsHttpEndpointConfig.awsSecretStoreArnstringyesThe ARN for database credentials stored in AWS Secrets Manager.
relationalDatabaseConfig.rdsHttpEndpointConfig.databaseNamestring—Logical database name.
relationalDatabaseConfig.rdsHttpEndpointConfig.dbClusterIdentifierstringyesAmazon RDS cluster Amazon Resource Name (ARN).
relationalDatabaseConfig.rdsHttpEndpointConfig.schemastring—Logical schema name.
relationalDatabaseConfig.relationalDatabaseSourceTypestringyesThe type of relational data source.
serviceRoleArnstring—The AWS Identity and Access Management service role ARN for the data source.
typestringyesThe type of the data source.

Status

FieldTypeRequiredDescription
attemptinteger—Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
dataSourceArnstring—The Amazon Resource Name (ARN) of the API key, such as arn:aws:appsync:us-east-1:123456789012:apis/graphqlapiid/datasources/datasourcename.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
lastSyncTimestring—
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
requestTokenstring—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

FieldTypeRequiredDescription
certificateArnstringyesCreate-only in AWS: changing it requires replacing the resource.
descriptionstring—
domainNamestringyesCreate-only in AWS: changing it requires replacing the resource.
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
tagsarray<object>—
tags[].keystringyes
tags[].valuestringyes

Status

FieldTypeRequiredDescription
appSyncDomainNamestring—Read-only: reported by AWS after creation.
attemptinteger—Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
domainNameArnstring—The Amazon Resource Name (ARN) for the Domain Name.
hostedZoneIdstring—Read-only: reported by AWS after creation.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
lastSyncTimestring—
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
requestTokenstring—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

FieldTypeRequiredDescription
apiIdstringyes
domainNamestringyesCreate-only in AWS: changing it requires replacing the resource.
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.

Status

FieldTypeRequiredDescription
apiAssociationIdentifierstring—Read-only: reported by AWS after creation.
attemptinteger—Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
lastSyncTimestring—
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
requestTokenstring—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

FieldTypeRequiredDescription
apiIdstringyesThe AWS AppSync GraphQL API that you want to attach using this function.
codestring—The resolver code that contains the request and response functions.
codeS3Locationstring—The Amazon S3 endpoint (where the code is located??).
dataSourceNamestringyesThe name of data source this function will attach.
descriptionstring—The function description.
functionVersionstring—The version of the request mapping template.
maxBatchSizeinteger—The maximum number of resolver request inputs that will be sent to a single AWS Lambda function in a BatchInvoke operation.
namestringyesThe name of the function.
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
requestMappingTemplatestring—The Function request mapping template.
requestMappingTemplateS3Locationstring—Describes a Sync configuration for a resolver.
responseMappingTemplatestring—The Function response mapping template.
responseMappingTemplateS3Locationstring—The location of a response mapping template in an Amazon S3 bucket.
runtimeobject—Describes a runtime used by an AWS AppSync pipeline resolver or AWS AppSync function.
runtime.namestringyesThe name of the runtime to use.
runtime.runtimeVersionstringyesThe version of the runtime to use.
syncConfigobject—Describes a Sync configuration for a resolver.
syncConfig.conflictDetectionstringyesThe Conflict Detection strategy to use.
syncConfig.conflictHandlerstring—The Conflict Resolution strategy to perform in the event of a conflict.
syncConfig.lambdaConflictHandlerConfigobject—AppSyncFunctionConfigurationLambdaConflictHandlerConfig is a nested property type of AWS::AppSync::FunctionConfiguration.
syncConfig.lambdaConflictHandlerConfig.lambdaConflictHandlerArnstring—The Amazon Resource Name (ARN) for the Lambda function to use as the Conflict Handler.

Status

FieldTypeRequiredDescription
attemptinteger—Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
functionArnstring—The ARN for the function generated by the service Read-only: reported by AWS after creation.
functionIdstring—The unique identifier for the function generated by the service Read-only: reported by AWS after creation.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
lastSyncTimestring—
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
requestTokenstring—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

FieldTypeRequiredDescription
additionalAuthenticationProvidersarray<object>—A list of additional authentication providers for the GraphqlApi API.
additionalAuthenticationProviders[].authenticationTypestringyesThe authentication type for API key, AWS Identity and Access Management, OIDC, Amazon Cognito user pools, or AWS Lambda.
additionalAuthenticationProviders[].lambdaAuthorizerConfigobject—AppSyncGraphQLApiLambdaAuthorizerConfig is a nested property type of AWS::AppSync::GraphQLApi.
additionalAuthenticationProviders[].lambdaAuthorizerConfig.authorizerResultTtlInSecondsinteger—The number of seconds a response should be cached for.
additionalAuthenticationProviders[].lambdaAuthorizerConfig.authorizerUristring—The ARN of the Lambda function to be called for authorization.
additionalAuthenticationProviders[].lambdaAuthorizerConfig.identityValidationExpressionstring—A regular expression for validation of tokens before the Lambda function is called.
additionalAuthenticationProviders[].openIDConnectConfigobject—AppSyncGraphQLApiOpenIDConnectConfig is a nested property type of AWS::AppSync::GraphQLApi.
additionalAuthenticationProviders[].openIDConnectConfig.authTTLnumber—The number of milliseconds that a token is valid after being authenticated.
additionalAuthenticationProviders[].openIDConnectConfig.clientIdstring—The client identifier of the Relying party at the OpenID identity provider.
additionalAuthenticationProviders[].openIDConnectConfig.iatTTLnumber—The number of milliseconds that a token is valid after it's issued to a user.
additionalAuthenticationProviders[].openIDConnectConfig.issuerstring—The issuer for the OIDC configuration.
additionalAuthenticationProviders[].userPoolConfigobject—AppSyncGraphQLApiCognitoUserPoolConfig is a nested property type of AWS::AppSync::GraphQLApi.
additionalAuthenticationProviders[].userPoolConfig.appIdClientRegexstring—A regular expression for validating the incoming Amazon Cognito user pool app client ID.
additionalAuthenticationProviders[].userPoolConfig.awsRegionstring—The AWS Region in which the user pool was created.
additionalAuthenticationProviders[].userPoolConfig.userPoolIdstring—The user pool ID
apiTypestring—The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API (MERGED).
authenticationTypestringyesSecurity configuration for your GraphQL API
enhancedMetricsConfigobject—Enables and controls the enhanced metrics feature.
enhancedMetricsConfig.dataSourceLevelMetricsBehaviorstringyesControls how data source metrics will be emitted to CloudWatch.
enhancedMetricsConfig.operationLevelMetricsConfigstringyesControls how operation metrics will be emitted to CloudWatch.
enhancedMetricsConfig.resolverLevelMetricsBehaviorstringyesControls how resolver metrics will be emitted to CloudWatch.
environmentVariablesmap<string>—A map containing the list of resources with their properties and environment variables.
introspectionConfigstring—Sets the value of the GraphQL API to enable (ENABLED) or disable (DISABLED) introspection.
lambdaAuthorizerConfigobject—A LambdaAuthorizerConfig holds configuration on how to authorize AWS AppSync API access when using the AWS_LAMBDA authorizer mode.
lambdaAuthorizerConfig.authorizerResultTtlInSecondsinteger—The number of seconds a response should be cached for.
lambdaAuthorizerConfig.authorizerUristring—The ARN of the Lambda function to be called for authorization.
lambdaAuthorizerConfig.identityValidationExpressionstring—A regular expression for validation of tokens before the Lambda function is called.
logConfigobject—The Amazon CloudWatch Logs configuration.
logConfig.cloudWatchLogsRoleArnstringyesThe service role that AWS AppSync will assume to publish to Amazon CloudWatch Logs in your account.
logConfig.excludeVerboseContentboolean—Set to TRUE to exclude sections that contain information such as headers, context, and evaluated mapping templates, regardless of logging level.
logConfig.fieldLogLevelstringyesThe field logging level.
mergedApiExecutionRoleArnstring—The AWS Identity and Access Management service role ARN for a merged API.
namestringyesThe API name
openIDConnectConfigobject—The OpenID Connect configuration.
openIDConnectConfig.authTTLnumber—The number of milliseconds that a token is valid after being authenticated.
openIDConnectConfig.clientIdstring—The client identifier of the Relying party at the OpenID identity provider.
openIDConnectConfig.iatTTLnumber—The number of milliseconds that a token is valid after it's issued to a user.
openIDConnectConfig.issuerstring—The issuer for the OIDC configuration.
ownerContactstring—The owner contact information for an API resource.
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
queryDepthLimitinteger—The maximum depth a query can have in a single request.
resolverCountLimitinteger—The maximum number of resolvers that can be invoked in a single request.
tagsarray<object>—An arbitrary set of tags (key-value pairs) for this GraphQL API.
tags[].keystringyes
tags[].valuestringyes
userPoolConfigobject—Optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint.
userPoolConfig.appIdClientRegexstring—A regular expression for validating the incoming Amazon Cognito user pool app client ID.
userPoolConfig.awsRegionstring—The AWS Region in which the user pool was created.
userPoolConfig.defaultActionstring—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.userPoolIdstring—The user pool ID.
visibilitystring—Sets the scope of the GraphQL API to public (GLOBAL) or private (PRIVATE).
xrayEnabledboolean—A flag indicating whether to use AWS X-Ray tracing for this GraphqlApi.

Status

FieldTypeRequiredDescription
apiIdstring—Unique AWS AppSync GraphQL API identifier.
arnstring—The Amazon Resource Name (ARN) of the API key Read-only: reported by AWS after creation.
attemptinteger—Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
graphQLDnsstring—The fully qualified domain name (FQDN) of the endpoint URL of your GraphQL API.
graphQLEndpointArnstring—The GraphQL endpoint ARN.
graphQLUrlstring—The Endpoint URL of your GraphQL API.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
lastSyncTimestring—
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
realtimeDnsstring—The fully qualified domain name (FQDN) of the real-time endpoint URL of your GraphQL API.
realtimeUrlstring—The GraphQL API real-time endpoint URL.
requestTokenstring—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

FieldTypeRequiredDescription
apiIdstringyesThe APSYlong GraphQL API to which you want to attach this resolver.
cachingConfigobject—The caching configuration for the resolver.
cachingConfig.cachingKeysarray<string>—The caching keys for a resolver that has caching activated.
cachingConfig.ttlnumberyesThe TTL in seconds for a resolver that has caching activated.
codestring—The ``resolver`` code that contains the request and response functions.
codeS3Locationstring—The Amazon S3 endpoint.
dataSourceNamestring—The resolver data source name.
fieldNamestringyesThe GraphQL field on a type that invokes the resolver.
kindstring—The resolver type.
maxBatchSizeinteger—The maximum number of resolver request inputs that will be sent to a single LAMlong function in a ``BatchInvoke`` operation.
metricsConfigenum—Enables or disables enhanced resolver metrics for specified resolvers. Allowed: ENABLED, DISABLED
pipelineConfigobject—Functions linked with the pipeline resolver.
pipelineConfig.functionsarray<string>—A list of ``Function`` objects.
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
requestMappingTemplatestring—The request mapping template.
requestMappingTemplateS3Locationstring—The location of a request mapping template in an S3 bucket.
responseMappingTemplatestring—The response mapping template.
responseMappingTemplateS3Locationstring—The location of a response mapping template in an S3 bucket.
runtimeobject—Describes a runtime used by an APSYlong resolver or APSYlong function.
runtime.namestringyesThe ``name`` of the runtime to use.
runtime.runtimeVersionstringyesThe ``version`` of the runtime to use.
syncConfigobject—The ``SyncConfig`` for a resolver attached to a versioned data source.
syncConfig.conflictDetectionstringyesThe Conflict Detection strategy to use.
syncConfig.conflictHandlerstring—The Conflict Resolution strategy to perform in the event of a conflict.
syncConfig.lambdaConflictHandlerConfigobject—The ``LambdaConflictHandlerConfig`` when configuring ``LAMBDA`` as the Conflict Handler.
syncConfig.lambdaConflictHandlerConfig.lambdaConflictHandlerArnstring—The Amazon Resource Name (ARN) for the Lambda function to use as the Conflict Handler.
typeNamestringyesThe GraphQL type that invokes this resolver.

Status

FieldTypeRequiredDescription
attemptinteger—Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
lastSyncTimestring—
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
requestTokenstring—RequestToken tracks an in-flight asynchronous operation.
resolverArnstring—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

FieldTypeRequiredDescription
descriptionstring—Description of the SourceApiAssociation.
mergedApiIdentifierstring—Identifier of the Merged GraphQLApi to associate.
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
sourceApiAssociationConfigobject—Customized configuration for SourceApiAssociation.
sourceApiIdentifierstring—Identifier of the Source GraphQLApi to associate.

Status

FieldTypeRequiredDescription
associationArnstring—ARN of the SourceApiAssociation.
associationIdstring—Id of the SourceApiAssociation.
attemptinteger—Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
lastSuccessfulMergeDatestring—Date of last schema successful merge.
lastSyncTimestring—
mergedApiArnstring—ARN of the Merged API in the association.
mergedApiIdstring—GraphQLApiId of the Merged API in the association.
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
requestTokenstring—RequestToken tracks an in-flight asynchronous operation.
sourceApiArnstring—ARN of the source API in the association.
sourceApiAssociationStatusenum—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
sourceApiAssociationStatusDetailstring—Current SourceApiAssociation status details.
sourceApiIdstring—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

FieldTypeRequiredDescription
apiIdstringyesThe API ID.
definitionstringyesThe type definition, in GraphQL Schema Definition Language (SDL) format.
formatenumyesThe type format: SDL or JSON. Allowed: SDL, JSON
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.

Status

FieldTypeRequiredDescription
arnstring—The Amazon Resource Name (ARN) of the type.
attemptinteger—Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
lastSyncTimestring—
namestring—The type name.
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
requestTokenstring—RequestToken tracks an in-flight asynchronous operation.