Neptune
7 resource kinds. Generated from the operator's CRD schemas.
aws.konfig.io/v1alpha1
NeptuneDBCluster # CLOUD CONTROL · AWS::Neptune::DBCluster
NeptuneDBCluster manages AWS::Neptune::DBCluster through the AWS Cloud Control API.
kubectl get neptunedbclusters · example on GitHub
Example
# NeptuneDBCluster — Neptune
# 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/neptune.html#neptunedbcluster
apiVersion: aws.konfig.io/v1alpha1
kind: NeptuneDBCluster
metadata:
name: example-neptunedbcluster
namespace: default
spec:
associatedRoles:
- featureName: example-neptunedbcluster
roleArn: arn:aws:iam::123456789012:role/example-role
availabilityZones:
- us-east-1a
backupRetentionPeriod: 1
copyTagsToSnapshot: false
dbClusterIdentifier: example
dbClusterParameterGroupName: example-neptunedbcluster
dbInstanceParameterGroupName: example-neptunedbcluster
dbPort: 443
dbSubnetGroupName: example-neptunedbcluster
deletionProtection: true
enableCloudwatchLogsExports:
- example
engineVersion: example
globalClusterIdentifier: example
iamAuthEnabled: true
kmsKeyId: arn:aws:kms:us-east-1:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab
networkType: IPV4
preferredBackupWindow: example
preferredMaintenanceWindow: example
providerRef:
name: example-neptunedbcluster
region: us-east-1
restoreToTime: '2026-01-01T00:00:00Z'
restoreType: example
serverlessScalingConfiguration:
maxCapacity: 2
minCapacity: 2
snapshotIdentifier: example
sourceDBClusterIdentifier: example
storageEncrypted: true
tags:
- key: example
value: example
useLatestRestorableTime: false
vpcSecurityGroupIds:
- example
Spec
| Field | Type | Required | Description |
|---|---|---|---|
associatedRoles | array<object> | — | Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. |
associatedRoles[].featureName | string | — | The name of the feature associated with the AWS Identity and Access Management (IAM) role. |
associatedRoles[].roleArn | string | yes | The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster. |
availabilityZones | array<string> | — | Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in. |
backupRetentionPeriod | integer | — | Specifies the number of days for which automatic DB snapshots are retained. |
copyTagsToSnapshot | boolean | — | A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. |
dbClusterIdentifier | string | — | The DB cluster identifier. |
dbClusterParameterGroupName | string | — | Provides the name of the DB cluster parameter group. |
dbInstanceParameterGroupName | string | — | The name of the DB parameter group to apply to all instances of the DB cluster. |
dbPort | integer | — | The port number on which the DB instances in the DB cluster accept connections. |
dbSubnetGroupName | string | — | Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group. |
deletionProtection | boolean | — | Indicates whether or not the DB cluster has deletion protection enabled. |
enableCloudwatchLogsExports | array<string> | — | Specifies a list of log types that are enabled for export to CloudWatch Logs. |
engineVersion | string | — | Indicates the database engine version. |
globalClusterIdentifier | string | — | The ID of the Neptune global database to which this new DB cluster should be added. |
iamAuthEnabled | boolean | — | True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false. |
kmsKeyId | string | — | The Amazon Resource Name (ARN) of the AWS KMS key that is used to encrypt the database instances in the DB cluster, such as arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. |
networkType | enum | — | The network type of the DB cluster. Allowed: IPV4, DUAL |
preferredBackupWindow | string | — | Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod. |
preferredMaintenanceWindow | string | — | Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). |
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. |
restoreToTime | string | — | Creates a new DB cluster from a DB snapshot or DB cluster snapshot. |
restoreType | string | — | Creates a new DB cluster from a DB snapshot or DB cluster snapshot. |
serverlessScalingConfiguration | object | — | Contains the scaling configuration used by the Neptune Serverless Instances within this DB cluster. |
serverlessScalingConfiguration.maxCapacity | number | yes | The maximum number of Neptune capacity units (NCUs) for a DB instance in an Neptune Serverless cluster. |
serverlessScalingConfiguration.minCapacity | number | yes | The minimum number of Neptune capacity units (NCUs) for a DB instance in an Neptune Serverless cluster. |
snapshotIdentifier | string | — | Specifies the identifier for a DB cluster snapshot. |
sourceDBClusterIdentifier | string | — | Creates a new DB cluster from a DB snapshot or DB cluster snapshot. |
storageEncrypted | boolean | — | Indicates whether the DB cluster is encrypted. |
tags | array<object> | — | The tags assigned to this cluster. |
tags[].key | string | yes | |
tags[].value | string | yes | |
useLatestRestorableTime | boolean | — | Creates a new DB cluster from a DB snapshot or DB cluster snapshot. |
vpcSecurityGroupIds | array<string> | — | Provides a list of VPC security groups that the DB cluster belongs to. |
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). |
clusterResourceId | string | — | The resource id for the DB cluster. |
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. |
endpoint | string | — | The connection endpoint for the DB cluster. |
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. |
port | string | — | The port number on which the DB cluster accepts connections. |
readEndpoint | string | — | The reader endpoint for the DB cluster. |
requestToken | string | — | RequestToken tracks an in-flight asynchronous operation. |
NeptuneDBClusterParameterGroup # CLOUD CONTROL · AWS::Neptune::DBClusterParameterGroup
NeptuneDBClusterParameterGroup manages AWS::Neptune::DBClusterParameterGroup through the AWS Cloud Control API.
kubectl get neptunedbclusterparametergroups · example on GitHub
Example
# NeptuneDBClusterParameterGroup — Neptune
# 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/neptune.html#neptunedbclusterparametergroup
apiVersion: aws.konfig.io/v1alpha1
kind: NeptuneDBClusterParameterGroup
metadata:
name: example-neptunedbclusterparametergroup
namespace: default
spec:
description: Managed by konfig-konector
family: example
name: example-neptunedbclusterparametergroup
providerRef:
name: example-neptunedbclusterparametergroup
region: us-east-1
tags:
- key: example
value: example
Spec
| Field | Type | Required | Description |
|---|---|---|---|
description | string | yes | Provides the customer-specified description for this DB cluster parameter group. |
family | string | yes | Must be neptune1 for engine versions prior to 1.2.0.0, or neptune1.2 for engine version 1.2.0.0 and higher. |
name | string | — | Provides the name of the DB cluster parameter group. |
parameters | object | yes | An array of parameters to be modified. |
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> | — | The list of tags for the cluster parameter group. |
tags[].key | string | yes | |
tags[].value | string | yes |
Status
| Field | Type | Required | Description |
|---|---|---|---|
attempt | integer | — | Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure. |
awsProvider | object | — | AWSProvider confirms the account and region this resource was reconciled against. |
awsProvider.accountId | string | — | AccountID the resource lives in. |
awsProvider.name | string | — | Name of the AWSProvider used; empty when the operator's own credentials were used. |
awsProvider.region | string | — | Region the resource lives in (empty for global services). |
conditions | array<object> | — | Conditions describe the current state of the resource. |
conditions[].lastTransitionTime | string | yes | lastTransitionTime is the last time the condition transitioned from one status to another. |
conditions[].message | string | yes | message is a human readable message indicating details about the transition. |
conditions[].observedGeneration | integer | — | observedGeneration represents the .metadata.generation that the condition was set based upon. |
conditions[].reason | string | yes | reason contains a programmatic identifier indicating the reason for the condition's last transition. |
conditions[].status | enum | yes | status of the condition, one of True, False, Unknown. Allowed: True, False, Unknown |
conditions[].type | string | yes | type of condition in CamelCase or in foo.example.com/CamelCase. |
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. |
NeptuneDBInstance # CLOUD CONTROL · AWS::Neptune::DBInstance
NeptuneDBInstance manages AWS::Neptune::DBInstance through the AWS Cloud Control API.
kubectl get neptunedbinstances · example on GitHub
Example
# NeptuneDBInstance — Neptune
# 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/neptune.html#neptunedbinstance
apiVersion: aws.konfig.io/v1alpha1
kind: NeptuneDBInstance
metadata:
name: example-neptunedbinstance
namespace: default
spec:
allowMajorVersionUpgrade: false
autoMinorVersionUpgrade: false
availabilityZone: us-east-1a
dbClusterIdentifier: example
dbInstanceClass: example
dbInstanceIdentifier: example
dbParameterGroupName: example-neptunedbinstance
dbSnapshotIdentifier: example
dbSubnetGroupName: example-neptunedbinstance
preferredMaintenanceWindow: example
providerRef:
name: example-neptunedbinstance
region: us-east-1
publiclyAccessible: false
tags:
- key: example
value: example
Spec
| Field | Type | Required | Description |
|---|---|---|---|
allowMajorVersionUpgrade | boolean | — | Indicates that major version upgrades are allowed. |
autoMinorVersionUpgrade | boolean | — | Indicates that minor version patches are applied automatically. |
availabilityZone | string | — | Specifies the name of the Availability Zone the DB instance is located in. |
dbClusterIdentifier | string | — | If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of. |
dbInstanceClass | string | yes | Contains the name of the compute and memory capacity class of the DB instance. |
dbInstanceIdentifier | string | — | Contains a user-supplied database identifier. |
dbParameterGroupName | string | — | The name of an existing DB parameter group or a reference to an AWS::Neptune::DBParameterGroup resource created in the template. |
dbSnapshotIdentifier | string | — | This parameter is not supported. |
dbSubnetGroupName | string | — | A DB subnet group to associate with the DB instance. |
preferredMaintenanceWindow | string | — | Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). |
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. |
publiclyAccessible | boolean | — | Indicates that public accessibility is enabled. |
tags | array<object> | — | An arbitrary set of tags (key-value pairs) for this DB instance. |
tags[].key | string | yes | |
tags[].value | string | yes |
Status
| Field | Type | Required | Description |
|---|---|---|---|
attempt | integer | — | Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure. |
awsProvider | object | — | AWSProvider confirms the account and region this resource was reconciled against. |
awsProvider.accountId | string | — | AccountID the resource lives in. |
awsProvider.name | string | — | Name of the AWSProvider used; empty when the operator's own credentials were used. |
awsProvider.region | string | — | Region the resource lives in (empty for global services). |
conditions | array<object> | — | Conditions describe the current state of the resource. |
conditions[].lastTransitionTime | string | yes | lastTransitionTime is the last time the condition transitioned from one status to another. |
conditions[].message | string | yes | message is a human readable message indicating details about the transition. |
conditions[].observedGeneration | integer | — | observedGeneration represents the .metadata.generation that the condition was set based upon. |
conditions[].reason | string | yes | reason contains a programmatic identifier indicating the reason for the condition's last transition. |
conditions[].status | enum | yes | status of the condition, one of True, False, Unknown. Allowed: True, False, Unknown |
conditions[].type | string | yes | type of condition in CamelCase or in foo.example.com/CamelCase. |
endpoint | string | — | The connection endpoint for the database. |
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. |
port | string | — | The port number on which the database accepts connections. |
requestToken | string | — | RequestToken tracks an in-flight asynchronous operation. |
NeptuneDBParameterGroup # CLOUD CONTROL · AWS::Neptune::DBParameterGroup
NeptuneDBParameterGroup manages AWS::Neptune::DBParameterGroup through the AWS Cloud Control API.
kubectl get neptunedbparametergroups · example on GitHub
Example
# NeptuneDBParameterGroup — Neptune
# 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/neptune.html#neptunedbparametergroup
apiVersion: aws.konfig.io/v1alpha1
kind: NeptuneDBParameterGroup
metadata:
name: example-neptunedbparametergroup
namespace: default
spec:
description: Managed by konfig-konector
family: example
name: example-neptunedbparametergroup
providerRef:
name: example-neptunedbparametergroup
region: us-east-1
tags:
- key: example
value: example
Spec
| Field | Type | Required | Description |
|---|---|---|---|
description | string | yes | Provides the customer-specified description for this DB parameter group. |
family | string | yes | Must be `neptune1` for engine versions prior to 1.2.0.0, or `neptune1.2` for engine version `1.2.0.0` and higher. |
name | string | — | Provides the name of the DB parameter group. |
parameters | object | yes | The parameters to set for this DB parameter group. |
providerRef | object | — | ProviderRef selects the AWSProvider (account/region) this resource is reconciled against. |
providerRef.name | string | yes | Name of a cluster-scoped AWSProvider. |
providerRef.region | string | — | Region overrides the provider's region for this resource only. |
tags | array<object> | — | An optional array of key-value pairs to apply to this DB parameter group. |
tags[].key | string | yes | |
tags[].value | string | yes |
Status
| Field | Type | Required | Description |
|---|---|---|---|
attempt | integer | — | Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure. |
awsProvider | object | — | AWSProvider confirms the account and region this resource was reconciled against. |
awsProvider.accountId | string | — | AccountID the resource lives in. |
awsProvider.name | string | — | Name of the AWSProvider used; empty when the operator's own credentials were used. |
awsProvider.region | string | — | Region the resource lives in (empty for global services). |
conditions | array<object> | — | Conditions describe the current state of the resource. |
conditions[].lastTransitionTime | string | yes | lastTransitionTime is the last time the condition transitioned from one status to another. |
conditions[].message | string | yes | message is a human readable message indicating details about the transition. |
conditions[].observedGeneration | integer | — | observedGeneration represents the .metadata.generation that the condition was set based upon. |
conditions[].reason | string | yes | reason contains a programmatic identifier indicating the reason for the condition's last transition. |
conditions[].status | enum | yes | status of the condition, one of True, False, Unknown. Allowed: True, False, Unknown |
conditions[].type | string | yes | type of condition in CamelCase or in foo.example.com/CamelCase. |
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. |
NeptuneDBSubnetGroup # CLOUD CONTROL · AWS::Neptune::DBSubnetGroup
NeptuneDBSubnetGroup manages AWS::Neptune::DBSubnetGroup through the AWS Cloud Control API.
kubectl get neptunedbsubnetgroups · example on GitHub
Example
# NeptuneDBSubnetGroup — Neptune
# 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/neptune.html#neptunedbsubnetgroup
apiVersion: aws.konfig.io/v1alpha1
kind: NeptuneDBSubnetGroup
metadata:
name: example-neptunedbsubnetgroup
namespace: default
spec:
dbSubnetGroupDescription: Managed by konfig-konector
dbSubnetGroupName: example-neptunedbsubnetgroup
providerRef:
name: example-neptunedbsubnetgroup
region: us-east-1
subnetIds:
- example
tags:
- key: example
value: example
Spec
| Field | Type | Required | Description |
|---|---|---|---|
dbSubnetGroupDescription | string | yes | The description for the DB subnet group. |
dbSubnetGroupName | string | — | The name for the DB subnet group. |
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. |
subnetIds | array<string> | yes | The Amazon EC2 subnet IDs for the DB subnet group. |
tags | array<object> | — | An optional array of key-value pairs to apply to this DB subnet group. |
tags[].key | string | yes | |
tags[].value | string | yes |
Status
| Field | Type | Required | Description |
|---|---|---|---|
attempt | integer | — | Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure. |
awsProvider | object | — | AWSProvider confirms the account and region this resource was reconciled against. |
awsProvider.accountId | string | — | AccountID the resource lives in. |
awsProvider.name | string | — | Name of the AWSProvider used; empty when the operator's own credentials were used. |
awsProvider.region | string | — | Region the resource lives in (empty for global services). |
conditions | array<object> | — | Conditions describe the current state of the resource. |
conditions[].lastTransitionTime | string | yes | lastTransitionTime is the last time the condition transitioned from one status to another. |
conditions[].message | string | yes | message is a human readable message indicating details about the transition. |
conditions[].observedGeneration | integer | — | observedGeneration represents the .metadata.generation that the condition was set based upon. |
conditions[].reason | string | yes | reason contains a programmatic identifier indicating the reason for the condition's last transition. |
conditions[].status | enum | yes | status of the condition, one of True, False, Unknown. Allowed: True, False, Unknown |
conditions[].type | string | yes | type of condition in CamelCase or in foo.example.com/CamelCase. |
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. |
NeptuneEventSubscription # CLOUD CONTROL · AWS::Neptune::EventSubscription
NeptuneEventSubscription manages AWS::Neptune::EventSubscription through the AWS Cloud Control API.
kubectl get neptuneeventsubscriptions · example on GitHub
Example
# NeptuneEventSubscription — Neptune
# 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/neptune.html#neptuneeventsubscription
apiVersion: aws.konfig.io/v1alpha1
kind: NeptuneEventSubscription
metadata:
name: example-neptuneeventsubscription
namespace: default
spec:
enabled: true
eventCategories:
- example
providerRef:
name: example-neptuneeventsubscription
region: us-east-1
snsTopicArn: arn:aws:iam::123456789012:role/example-role
sourceIds:
- example
sourceType: example
subscriptionName: example-neptuneeventsubscription
tags:
- key: example
value: example
Spec
| Field | Type | Required | Description |
|---|---|---|---|
enabled | boolean | — | A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it. |
eventCategories | array<string> | — | A list of event categories for a SourceType that you want to subscribe to. |
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. |
snsTopicArn | string | yes | The Amazon Resource Name (ARN) of the SNS topic created for event notification. |
sourceIds | array<string> | — | The list of identifiers of the event sources for which events will be returned. |
sourceType | string | — | The type of source that will be generating the events. |
subscriptionName | string | — | The name of the subscription. |
tags | array<object> | — | An array of key-value pairs to apply to this resource. |
tags[].key | string | yes | |
tags[].value | string | yes |
Status
| Field | Type | Required | Description |
|---|---|---|---|
attempt | integer | — | Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure. |
awsProvider | object | — | AWSProvider confirms the account and region this resource was reconciled against. |
awsProvider.accountId | string | — | AccountID the resource lives in. |
awsProvider.name | string | — | Name of the AWSProvider used; empty when the operator's own credentials were used. |
awsProvider.region | string | — | Region the resource lives in (empty for global services). |
conditions | array<object> | — | Conditions describe the current state of the resource. |
conditions[].lastTransitionTime | string | yes | lastTransitionTime is the last time the condition transitioned from one status to another. |
conditions[].message | string | yes | message is a human readable message indicating details about the transition. |
conditions[].observedGeneration | integer | — | observedGeneration represents the .metadata.generation that the condition was set based upon. |
conditions[].reason | string | yes | reason contains a programmatic identifier indicating the reason for the condition's last transition. |
conditions[].status | enum | yes | status of the condition, one of True, False, Unknown. Allowed: True, False, Unknown |
conditions[].type | string | yes | type of condition in CamelCase or in foo.example.com/CamelCase. |
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. |
NeptuneGlobalCluster # CLOUD CONTROL · AWS::Neptune::GlobalCluster
NeptuneGlobalCluster manages AWS::Neptune::GlobalCluster through the AWS Cloud Control API.
kubectl get neptuneglobalclusters · example on GitHub
Example
# NeptuneGlobalCluster — Neptune
# 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/neptune.html#neptuneglobalcluster
apiVersion: aws.konfig.io/v1alpha1
kind: NeptuneGlobalCluster
metadata:
name: example-neptuneglobalcluster
namespace: default
spec:
deletionProtection: true
engine: neptune
engineVersion: example
globalClusterIdentifier: example
providerRef:
name: example-neptuneglobalcluster
region: us-east-1
sourceDBClusterIdentifier: example
storageEncrypted: true
tags:
- key: example
value: example
Spec
| Field | Type | Required | Description |
|---|---|---|---|
deletionProtection | boolean | — | Whether deletion protection is enabled. |
engine | enum | — | The name of the database engine. Allowed: neptune |
engineVersion | string | — | The version number of the database engine. |
globalClusterIdentifier | string | — | The cluster identifier of the global database cluster. |
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. |
sourceDBClusterIdentifier | string | — | The Amazon Resource Name (ARN) of an existing Neptune DB cluster to use as the primary cluster of the new global database. |
storageEncrypted | boolean | — | Whether the global database cluster is storage encrypted. |
tags | array<object> | — | An array of key-value pairs to apply to this resource. |
tags[].key | string | yes | |
tags[].value | string | yes |
Status
| Field | Type | Required | Description |
|---|---|---|---|
attempt | integer | — | Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure. |
awsProvider | object | — | AWSProvider confirms the account and region this resource was reconciled against. |
awsProvider.accountId | string | — | AccountID the resource lives in. |
awsProvider.name | string | — | Name of the AWSProvider used; empty when the operator's own credentials were used. |
awsProvider.region | string | — | Region the resource lives in (empty for global services). |
conditions | array<object> | — | Conditions describe the current state of the resource. |
conditions[].lastTransitionTime | string | yes | lastTransitionTime is the last time the condition transitioned from one status to another. |
conditions[].message | string | yes | message is a human readable message indicating details about the transition. |
conditions[].observedGeneration | integer | — | observedGeneration represents the .metadata.generation that the condition was set based upon. |
conditions[].reason | string | yes | reason contains a programmatic identifier indicating the reason for the condition's last transition. |
conditions[].status | enum | yes | status of the condition, one of True, False, Unknown. Allowed: True, False, Unknown |
conditions[].type | string | yes | type of condition in CamelCase or in foo.example.com/CamelCase. |
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. |