Amplify

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

API Group: aws.konfig.io/v1alpha1

AmplifyApp # CLOUD CONTROL · AWS::Amplify::App

AmplifyApp manages AWS::Amplify::App through the AWS Cloud Control API.

kubectl get amplifyapps · example on GitHub

Example

# AmplifyApp — Amplify
# 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/amplify.html#amplifyapp
apiVersion: aws.konfig.io/v1alpha1
kind: AmplifyApp
metadata:
  name: example-amplifyapp
  namespace: default
spec:
  accessToken: example
  autoBranchCreationConfig:
    autoBranchCreationPatterns:
    - example
    basicAuthConfig:
      enableBasicAuth: true
      password: example
      username: example-amplifyapp
    buildSpec: example
    enableAutoBranchCreation: true
    enableAutoBuild: true
    enablePerformanceMode: true
    enablePullRequestPreview: true
    environmentVariables:
    - name: example-amplifyapp
      value: example
    framework: example
    pullRequestEnvironmentName: example-amplifyapp
    stage: EXPERIMENTAL
  basicAuthConfig:
    enableBasicAuth: true
    password: example
    username: example-amplifyapp
  buildSpec: example
  cacheConfig:
    type: AMPLIFY_MANAGED
  computeRoleArn: arn:aws:iam::123456789012:role/example-role
  customHeaders: example
  customRules:
  - condition: example
    source: example
    status: example
    target: example
  description: Managed by konfig-konector
  enableBranchAutoDeletion: true
  environmentVariables:
  - name: example-amplifyapp
    value: example
  iamServiceRole: example
  jobConfig:
    buildComputeType: STANDARD_8GB
  name: example-amplifyapp
  oauthToken: example
  platform: WEB
  providerRef:
    name: example-amplifyapp
    region: us-east-1
  repository: example
  tags:
  - key: example
    value: example

Spec

FieldTypeRequiredDescription
accessTokenstring—
autoBranchCreationConfigobject—AmplifyAppAutoBranchCreationConfig is a nested property type of AWS::Amplify::App.
autoBranchCreationConfig.autoBranchCreationPatternsarray<string>—
autoBranchCreationConfig.basicAuthConfigobject—AmplifyAppBasicAuthConfig is a nested property type of AWS::Amplify::App.
autoBranchCreationConfig.basicAuthConfig.enableBasicAuthboolean—
autoBranchCreationConfig.basicAuthConfig.passwordstring—
autoBranchCreationConfig.basicAuthConfig.usernamestring—
autoBranchCreationConfig.buildSpecstring—
autoBranchCreationConfig.enableAutoBranchCreationboolean—
autoBranchCreationConfig.enableAutoBuildboolean—
autoBranchCreationConfig.enablePerformanceModeboolean—
autoBranchCreationConfig.enablePullRequestPreviewboolean—
autoBranchCreationConfig.environmentVariablesarray<object>—
autoBranchCreationConfig.environmentVariables[].namestringyes
autoBranchCreationConfig.environmentVariables[].valuestringyes
autoBranchCreationConfig.frameworkstring—
autoBranchCreationConfig.pullRequestEnvironmentNamestring—
autoBranchCreationConfig.stageenum—Allowed: EXPERIMENTAL, BETA, PULL_REQUEST, PRODUCTION, DEVELOPMENT
basicAuthConfigobject—AmplifyAppBasicAuthConfig is a nested property type of AWS::Amplify::App.
basicAuthConfig.enableBasicAuthboolean—
basicAuthConfig.passwordstring—
basicAuthConfig.usernamestring—
buildSpecstring—
cacheConfigobject—AmplifyAppCacheConfig is a nested property type of AWS::Amplify::App.
cacheConfig.typeenum—Allowed: AMPLIFY_MANAGED, AMPLIFY_MANAGED_NO_COOKIES
computeRoleArnstring—
customHeadersstring—
customRulesarray<object>—
customRules[].conditionstring—
customRules[].sourcestringyes
customRules[].statusstring—
customRules[].targetstringyes
descriptionstring—
enableBranchAutoDeletionboolean—
environmentVariablesarray<object>—
environmentVariables[].namestringyes
environmentVariables[].valuestringyes
iamServiceRolestring—
jobConfigobject—AmplifyAppJobConfig is a nested property type of AWS::Amplify::App.
jobConfig.buildComputeTypeenumyesAllowed: STANDARD_8GB, LARGE_16GB, XLARGE_72GB
namestringyes
oauthTokenstring—
platformenum—Allowed: WEB, WEB_DYNAMIC, WEB_COMPUTE
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.
repositorystring—
tagsarray<object>—
tags[].keystringyes
tags[].valuestringyes

Status

FieldTypeRequiredDescription
appIdstring—Read-only: reported by AWS after creation.
appNamestring—Read-only: reported by AWS after creation.
arnstring—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.
defaultDomainstring—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.

AmplifyBranch # CLOUD CONTROL · AWS::Amplify::Branch

AmplifyBranch manages AWS::Amplify::Branch through the AWS Cloud Control API.

kubectl get amplifybranches · example on GitHub

Example

# AmplifyBranch — Amplify
# 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/amplify.html#amplifybranch
apiVersion: aws.konfig.io/v1alpha1
kind: AmplifyBranch
metadata:
  name: example-amplifybranch
  namespace: default
spec:
  appId: example-id
  backend:
    stackArn: arn:aws:iam::123456789012:role/example-role
  basicAuthConfig:
    enableBasicAuth: true
    password: example
    username: example-amplifybranch
  branchName: example-amplifybranch
  buildSpec: example
  computeRoleArn: arn:aws:iam::123456789012:role/example-role
  description: Managed by konfig-konector
  enableAutoBuild: true
  enablePerformanceMode: true
  enablePullRequestPreview: true
  enableSkewProtection: true
  environmentVariables:
  - name: example-amplifybranch
    value: example
  framework: example
  providerRef:
    name: example-amplifybranch
    region: us-east-1
  pullRequestEnvironmentName: example-amplifybranc
  stage: EXPERIMENTAL
  tags:
  - key: example
    value: example

Spec

FieldTypeRequiredDescription
appIdstringyesCreate-only in AWS: changing it requires replacing the resource.
backendobject—AmplifyBranchBackend is a nested property type of AWS::Amplify::Branch.
backend.stackArnstring—
basicAuthConfigobject—AmplifyBranchBasicAuthConfig is a nested property type of AWS::Amplify::Branch.
basicAuthConfig.enableBasicAuthboolean—
basicAuthConfig.passwordstringyes
basicAuthConfig.usernamestringyes
branchNamestringyesCreate-only in AWS: changing it requires replacing the resource.
buildSpecstring—
computeRoleArnstring—
descriptionstring—
enableAutoBuildboolean—
enablePerformanceModeboolean—
enablePullRequestPreviewboolean—
enableSkewProtectionboolean—
environmentVariablesarray<object>—
environmentVariables[].namestringyes
environmentVariables[].valuestringyes
frameworkstring—
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.
pullRequestEnvironmentNamestring—
stageenum—Allowed: EXPERIMENTAL, BETA, PULL_REQUEST, PRODUCTION, DEVELOPMENT
tagsarray<object>—
tags[].keystringyes
tags[].valuestringyes

Status

FieldTypeRequiredDescription
arnstring—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.

AmplifyDomain # CLOUD CONTROL · AWS::Amplify::Domain

AmplifyDomain manages AWS::Amplify::Domain through the AWS Cloud Control API.

kubectl get amplifydomains · example on GitHub

Example

# AmplifyDomain — Amplify
# 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/amplify.html#amplifydomain
apiVersion: aws.konfig.io/v1alpha1
kind: AmplifyDomain
metadata:
  name: example-amplifydomain
  namespace: default
spec:
  appId: example-id
  autoSubDomainCreationPatterns:
  - example
  autoSubDomainIAMRole: example
  certificateSettings:
    certificateType: AMPLIFY_MANAGED
    customCertificateArn: arn:aws:iam::123456789012:role/example-role
  domainName: example-amplifydomain
  enableAutoSubDomain: true
  providerRef:
    name: example-amplifydomain
    region: us-east-1
  subDomainSettings:
  - branchName: example-amplifydomain
    prefix: example

Spec

FieldTypeRequiredDescription
appIdstringyesCreate-only in AWS: changing it requires replacing the resource.
autoSubDomainCreationPatternsarray<string>—
autoSubDomainIAMRolestring—
certificateSettingsobject—AmplifyDomainCertificateSettings is a nested property type of AWS::Amplify::Domain.
certificateSettings.certificateTypeenum—Allowed: AMPLIFY_MANAGED, CUSTOM
certificateSettings.customCertificateArnstring—
domainNamestringyesCreate-only in AWS: changing it requires replacing the resource.
enableAutoSubDomainboolean—
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.
subDomainSettingsarray<object>yes
subDomainSettings[].branchNamestringyes
subDomainSettings[].prefixstringyes

Status

FieldTypeRequiredDescription
arnstring—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).
certificateobject—Read-only: reported by AWS after creation.
certificate.certificateArnstring—
certificate.certificateTypeenum—Allowed: AMPLIFY_MANAGED, CUSTOM
certificate.certificateVerificationDNSRecordstring—
certificateRecordstring—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.
domainStatusstring—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.
statusReasonstring—Read-only: reported by AWS after creation.
updateStatusstring—Read-only: reported by AWS after creation.

AmplifyWebhook # CLOUD CONTROL · AWS::Amplify::Webhook

AmplifyWebhook manages AWS::Amplify::Webhook through the AWS Cloud Control API.

kubectl get amplifywebhooks · example on GitHub

Example

# AmplifyWebhook — Amplify
# 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/amplify.html#amplifywebhook
apiVersion: aws.konfig.io/v1alpha1
kind: AmplifyWebhook
metadata:
  name: example-amplifywebhook
  namespace: default
spec:
  branchName: example-amplifywebhook
  description: Managed by konfig-konector
  providerRef:
    name: example-amplifywebhook
    region: us-east-1
  tags:
  - key: example
    value: example

Spec

FieldTypeRequiredDescription
appIdstring—The unique ID for an Amplify app.
branchNamestringyesThe name for a branch that is part of an Amplify app.
descriptionstring—The description for a webhook.
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 for the webhook.
tags[].keystringyes
tags[].valuestringyes

Status

FieldTypeRequiredDescription
arnstring—The Amazon Resource Name (ARN) for the webhook.
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.
webhookIdstring—The unique ID for a webhook.
webhookUrlstring—The URL of the webhook.