table_v1alpha1.json

{
  "description": "Table is the Schema for the Tables API",
  "properties": {
    "apiVersion": {
      "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
      "type": "string"
    },
    "kind": {
      "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
      "type": "string"
    },
    "metadata": {
      "type": "object"
    },
    "spec": {
      "description": "TableSpec defines the desired state of Table.",
      "properties": {
        "attributeDefinitions": {
          "description": "An array of attributes that describe the key schema for the table and indexes.",
          "items": {
            "description": "Represents an attribute for describing the key schema for the table and indexes.",
            "properties": {
              "attributeName": {
                "type": "string"
              },
              "attributeType": {
                "type": "string"
              }
            },
            "type": "object",
            "additionalProperties": false
          },
          "type": "array"
        },
        "billingMode": {
          "description": "Controls how you are charged for read and write throughput and how you manage\ncapacity. This setting can be changed later.\n\n   * PROVISIONED - We recommend using PROVISIONED for predictable workloads.\n   PROVISIONED sets the billing mode to Provisioned Mode (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.ProvisionedThroughput.Manual).\n\n   * PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable\n   workloads. PAY_PER_REQUEST sets the billing mode to On-Demand Mode (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.OnDemand).",
          "type": "string"
        },
        "continuousBackups": {
          "description": "Represents the settings used to enable point in time recovery.",
          "properties": {
            "pointInTimeRecoveryEnabled": {
              "type": "boolean"
            }
          },
          "type": "object",
          "additionalProperties": false
        },
        "deletionProtectionEnabled": {
          "description": "Indicates whether deletion protection is to be enabled (true) or disabled\n(false) on the table.",
          "type": "boolean"
        },
        "globalSecondaryIndexes": {
          "description": "One or more global secondary indexes (the maximum is 20) to be created on\nthe table. Each global secondary index in the array includes the following:\n\n   * IndexName - The name of the global secondary index. Must be unique only\n   for this table.\n\n   * KeySchema - Specifies the key schema for the global secondary index.\n\n   * Projection - Specifies attributes that are copied (projected) from the\n   table into the index. These are in addition to the primary key attributes\n   and index key attributes, which are automatically projected. Each attribute\n   specification is composed of: ProjectionType - One of the following: KEYS_ONLY\n   - Only the index and primary keys are projected into the index. INCLUDE\n   - Only the specified table attributes are projected into the index. The\n   list of projected attributes is in NonKeyAttributes. ALL - All of the\n   table attributes are projected into the index. NonKeyAttributes - A list\n   of one or more non-key attribute names that are projected into the secondary\n   index. The total count of attributes provided in NonKeyAttributes, summed\n   across all of the secondary indexes, must not exceed 100. If you project\n   the same attribute into two different indexes, this counts as two distinct\n   attributes when determining the total.\n\n   * ProvisionedThroughput - The provisioned throughput settings for the\n   global secondary index, consisting of read and write capacity units.",
          "items": {
            "description": "Represents the properties of a global secondary index.",
            "properties": {
              "indexName": {
                "type": "string"
              },
              "keySchema": {
                "items": {
                  "description": "Represents a single element of a key schema. A key schema specifies the attributes\nthat make up the primary key of a table, or the key attributes of an index.\n\nA KeySchemaElement represents exactly one attribute of the primary key. For\nexample, a simple primary key would be represented by one KeySchemaElement\n(for the partition key). A composite primary key would require one KeySchemaElement\nfor the partition key, and another KeySchemaElement for the sort key.\n\nA KeySchemaElement must be a scalar, top-level attribute (not a nested attribute).\nThe data type must be one of String, Number, or Binary. The attribute cannot\nbe nested within a List or a Map.",
                  "properties": {
                    "attributeName": {
                      "type": "string"
                    },
                    "keyType": {
                      "type": "string"
                    }
                  },
                  "type": "object",
                  "additionalProperties": false
                },
                "type": "array"
              },
              "projection": {
                "description": "Represents attributes that are copied (projected) from the table into an\nindex. These are in addition to the primary key attributes and index key\nattributes, which are automatically projected.",
                "properties": {
                  "nonKeyAttributes": {
                    "items": {
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "projectionType": {
                    "type": "string"
                  }
                },
                "type": "object",
                "additionalProperties": false
              },
              "provisionedThroughput": {
                "description": "Represents the provisioned throughput settings for a specified table or index.\nThe settings can be modified using the UpdateTable operation.\n\nFor current minimum and maximum provisioned throughput values, see Service,\nAccount, and Table Quotas (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html)\nin the Amazon DynamoDB Developer Guide.",
                "properties": {
                  "readCapacityUnits": {
                    "format": "int64",
                    "type": "integer"
                  },
                  "writeCapacityUnits": {
                    "format": "int64",
                    "type": "integer"
                  }
                },
                "type": "object",
                "additionalProperties": false
              }
            },
            "type": "object",
            "additionalProperties": false
          },
          "type": "array"
        },
        "keySchema": {
          "description": "Specifies the attributes that make up the primary key for a table or an index.\nThe attributes in KeySchema must also be defined in the AttributeDefinitions\narray. For more information, see Data Model (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataModel.html)\nin the Amazon DynamoDB Developer Guide.\n\nEach KeySchemaElement in the array is composed of:\n\n   * AttributeName - The name of this key attribute.\n\n   * KeyType - The role that the key attribute will assume: HASH - partition\n   key RANGE - sort key\n\nThe partition key of an item is also known as its hash attribute. The term\n\"hash attribute\" derives from the DynamoDB usage of an internal hash function\nto evenly distribute data items across partitions, based on their partition\nkey values.\n\nThe sort key of an item is also known as its range attribute. The term \"range\nattribute\" derives from the way DynamoDB stores items with the same partition\nkey physically close together, in sorted order by the sort key value.\n\nFor a simple primary key (partition key), you must provide exactly one element\nwith a KeyType of HASH.\n\nFor a composite primary key (partition key and sort key), you must provide\nexactly two elements, in this order: The first element must have a KeyType\nof HASH, and the second element must have a KeyType of RANGE.\n\nFor more information, see Working with Tables (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#WorkingWithTables.primary.key)\nin the Amazon DynamoDB Developer Guide.",
          "items": {
            "description": "Represents a single element of a key schema. A key schema specifies the attributes\nthat make up the primary key of a table, or the key attributes of an index.\n\nA KeySchemaElement represents exactly one attribute of the primary key. For\nexample, a simple primary key would be represented by one KeySchemaElement\n(for the partition key). A composite primary key would require one KeySchemaElement\nfor the partition key, and another KeySchemaElement for the sort key.\n\nA KeySchemaElement must be a scalar, top-level attribute (not a nested attribute).\nThe data type must be one of String, Number, or Binary. The attribute cannot\nbe nested within a List or a Map.",
            "properties": {
              "attributeName": {
                "type": "string"
              },
              "keyType": {
                "type": "string"
              }
            },
            "type": "object",
            "additionalProperties": false
          },
          "type": "array"
        },
        "localSecondaryIndexes": {
          "description": "One or more local secondary indexes (the maximum is 5) to be created on the\ntable. Each index is scoped to a given partition key value. There is a 10\nGB size limit per partition key value; otherwise, the size of a local secondary\nindex is unconstrained.\n\nEach local secondary index in the array includes the following:\n\n   * IndexName - The name of the local secondary index. Must be unique only\n   for this table.\n\n   * KeySchema - Specifies the key schema for the local secondary index.\n   The key schema must begin with the same partition key as the table.\n\n   * Projection - Specifies attributes that are copied (projected) from the\n   table into the index. These are in addition to the primary key attributes\n   and index key attributes, which are automatically projected. Each attribute\n   specification is composed of: ProjectionType - One of the following: KEYS_ONLY\n   - Only the index and primary keys are projected into the index. INCLUDE\n   - Only the specified table attributes are projected into the index. The\n   list of projected attributes is in NonKeyAttributes. ALL - All of the\n   table attributes are projected into the index. NonKeyAttributes - A list\n   of one or more non-key attribute names that are projected into the secondary\n   index. The total count of attributes provided in NonKeyAttributes, summed\n   across all of the secondary indexes, must not exceed 100. If you project\n   the same attribute into two different indexes, this counts as two distinct\n   attributes when determining the total.",
          "items": {
            "description": "Represents the properties of a local secondary index.",
            "properties": {
              "indexName": {
                "type": "string"
              },
              "keySchema": {
                "items": {
                  "description": "Represents a single element of a key schema. A key schema specifies the attributes\nthat make up the primary key of a table, or the key attributes of an index.\n\nA KeySchemaElement represents exactly one attribute of the primary key. For\nexample, a simple primary key would be represented by one KeySchemaElement\n(for the partition key). A composite primary key would require one KeySchemaElement\nfor the partition key, and another KeySchemaElement for the sort key.\n\nA KeySchemaElement must be a scalar, top-level attribute (not a nested attribute).\nThe data type must be one of String, Number, or Binary. The attribute cannot\nbe nested within a List or a Map.",
                  "properties": {
                    "attributeName": {
                      "type": "string"
                    },
                    "keyType": {
                      "type": "string"
                    }
                  },
                  "type": "object",
                  "additionalProperties": false
                },
                "type": "array"
              },
              "projection": {
                "description": "Represents attributes that are copied (projected) from the table into an\nindex. These are in addition to the primary key attributes and index key\nattributes, which are automatically projected.",
                "properties": {
                  "nonKeyAttributes": {
                    "items": {
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "projectionType": {
                    "type": "string"
                  }
                },
                "type": "object",
                "additionalProperties": false
              }
            },
            "type": "object",
            "additionalProperties": false
          },
          "type": "array"
        },
        "provisionedThroughput": {
          "description": "Represents the provisioned throughput settings for a specified table or index.\nThe settings can be modified using the UpdateTable operation.\n\nIf you set BillingMode as PROVISIONED, you must specify this property. If\nyou set BillingMode as PAY_PER_REQUEST, you cannot specify this property.\n\nFor current minimum and maximum provisioned throughput values, see Service,\nAccount, and Table Quotas (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html)\nin the Amazon DynamoDB Developer Guide.",
          "properties": {
            "readCapacityUnits": {
              "format": "int64",
              "type": "integer"
            },
            "writeCapacityUnits": {
              "format": "int64",
              "type": "integer"
            }
          },
          "type": "object",
          "additionalProperties": false
        },
        "sseSpecification": {
          "description": "Represents the settings used to enable server-side encryption.",
          "properties": {
            "enabled": {
              "type": "boolean"
            },
            "kmsMasterKeyID": {
              "type": "string"
            },
            "sseType": {
              "type": "string"
            }
          },
          "type": "object",
          "additionalProperties": false
        },
        "streamSpecification": {
          "description": "The settings for DynamoDB Streams on the table. These settings consist of:\n\n   * StreamEnabled - Indicates whether DynamoDB Streams is to be enabled\n   (true) or disabled (false).\n\n   * StreamViewType - When an item in the table is modified, StreamViewType\n   determines what information is written to the table's stream. Valid values\n   for StreamViewType are: KEYS_ONLY - Only the key attributes of the modified\n   item are written to the stream. NEW_IMAGE - The entire item, as it appears\n   after it was modified, is written to the stream. OLD_IMAGE - The entire\n   item, as it appeared before it was modified, is written to the stream.\n   NEW_AND_OLD_IMAGES - Both the new and the old item images of the item\n   are written to the stream.",
          "properties": {
            "streamEnabled": {
              "type": "boolean"
            },
            "streamViewType": {
              "type": "string"
            }
          },
          "type": "object",
          "additionalProperties": false
        },
        "tableClass": {
          "description": "The table class of the new table. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.",
          "type": "string"
        },
        "tableName": {
          "description": "The name of the table to create.",
          "type": "string"
        },
        "tags": {
          "description": "A list of key-value pairs to label the table. For more information, see Tagging\nfor DynamoDB (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html).",
          "items": {
            "description": "Describes a tag. A tag is a key-value pair. You can add up to 50 tags to\na single DynamoDB table.\n\nAmazon Web Services-assigned tag names and values are automatically assigned\nthe aws: prefix, which the user cannot assign. Amazon Web Services-assigned\ntag names do not count towards the tag limit of 50. User-assigned tag names\nhave the prefix user: in the Cost Allocation Report. You cannot backdate\nthe application of a tag.\n\nFor an overview on tagging DynamoDB resources, see Tagging for DynamoDB (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html)\nin the Amazon DynamoDB Developer Guide.",
            "properties": {
              "key": {
                "type": "string"
              },
              "value": {
                "type": "string"
              }
            },
            "type": "object",
            "additionalProperties": false
          },
          "type": "array"
        },
        "timeToLive": {
          "description": "Represents the settings used to enable or disable Time to Live for the specified\ntable.",
          "properties": {
            "attributeName": {
              "type": "string"
            },
            "enabled": {
              "type": "boolean"
            }
          },
          "type": "object",
          "additionalProperties": false
        }
      },
      "required": [
        "attributeDefinitions",
        "keySchema",
        "tableName"
      ],
      "type": "object",
      "additionalProperties": false
    },
    "status": {
      "description": "TableStatus defines the observed state of Table",
      "properties": {
        "ackResourceMetadata": {
          "description": "All CRs managed by ACK have a common `Status.ACKResourceMetadata` member\nthat is used to contain resource sync state, account ownership,\nconstructed ARN for the resource",
          "properties": {
            "arn": {
              "description": "ARN is the Amazon Resource Name for the resource. This is a\nglobally-unique identifier and is set only by the ACK service controller\nonce the controller has orchestrated the creation of the resource OR\nwhen it has verified that an \"adopted\" resource (a resource where the\nARN annotation was set by the Kubernetes user on the CR) exists and\nmatches the supplied CR's Spec field values.\nhttps://github.com/aws/aws-controllers-k8s/issues/270",
              "type": "string"
            },
            "ownerAccountID": {
              "description": "OwnerAccountID is the AWS Account ID of the account that owns the\nbackend AWS service API resource.",
              "type": "string"
            },
            "region": {
              "description": "Region is the AWS region in which the resource exists or will exist.",
              "type": "string"
            }
          },
          "required": [
            "ownerAccountID",
            "region"
          ],
          "type": "object",
          "additionalProperties": false
        },
        "archivalSummary": {
          "description": "Contains information about the table archive.",
          "properties": {
            "archivalBackupARN": {
              "type": "string"
            },
            "archivalDateTime": {
              "format": "date-time",
              "type": "string"
            },
            "archivalReason": {
              "type": "string"
            }
          },
          "type": "object",
          "additionalProperties": false
        },
        "conditions": {
          "description": "All CRS managed by ACK have a common `Status.Conditions` member that\ncontains a collection of `ackv1alpha1.Condition` objects that describe\nthe various terminal states of the CR and its backend AWS service API\nresource",
          "items": {
            "description": "Condition is the common struct used by all CRDs managed by ACK service\ncontrollers to indicate terminal states  of the CR and its backend AWS\nservice API resource",
            "properties": {
              "lastTransitionTime": {
                "description": "Last time the condition transitioned from one status to another.",
                "format": "date-time",
                "type": "string"
              },
              "message": {
                "description": "A human readable message indicating details about the transition.",
                "type": "string"
              },
              "reason": {
                "description": "The reason for the condition's last transition.",
                "type": "string"
              },
              "status": {
                "description": "Status of the condition, one of True, False, Unknown.",
                "type": "string"
              },
              "type": {
                "description": "Type is the type of the Condition",
                "type": "string"
              }
            },
            "required": [
              "status",
              "type"
            ],
            "type": "object",
            "additionalProperties": false
          },
          "type": "array"
        },
        "creationDateTime": {
          "description": "The date and time when the table was created, in UNIX epoch time (http://www.epochconverter.com/)\nformat.",
          "format": "date-time",
          "type": "string"
        },
        "globalSecondaryIndexesDescriptions": {
          "items": {
            "description": "Represents the properties of a global secondary index.",
            "properties": {
              "backfilling": {
                "type": "boolean"
              },
              "indexARN": {
                "type": "string"
              },
              "indexName": {
                "type": "string"
              },
              "indexSizeBytes": {
                "format": "int64",
                "type": "integer"
              },
              "indexStatus": {
                "type": "string"
              },
              "itemCount": {
                "format": "int64",
                "type": "integer"
              },
              "keySchema": {
                "items": {
                  "description": "Represents a single element of a key schema. A key schema specifies the attributes\nthat make up the primary key of a table, or the key attributes of an index.\n\nA KeySchemaElement represents exactly one attribute of the primary key. For\nexample, a simple primary key would be represented by one KeySchemaElement\n(for the partition key). A composite primary key would require one KeySchemaElement\nfor the partition key, and another KeySchemaElement for the sort key.\n\nA KeySchemaElement must be a scalar, top-level attribute (not a nested attribute).\nThe data type must be one of String, Number, or Binary. The attribute cannot\nbe nested within a List or a Map.",
                  "properties": {
                    "attributeName": {
                      "type": "string"
                    },
                    "keyType": {
                      "type": "string"
                    }
                  },
                  "type": "object",
                  "additionalProperties": false
                },
                "type": "array"
              },
              "projection": {
                "description": "Represents attributes that are copied (projected) from the table into an\nindex. These are in addition to the primary key attributes and index key\nattributes, which are automatically projected.",
                "properties": {
                  "nonKeyAttributes": {
                    "items": {
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "projectionType": {
                    "type": "string"
                  }
                },
                "type": "object",
                "additionalProperties": false
              },
              "provisionedThroughput": {
                "description": "Represents the provisioned throughput settings for the table, consisting\nof read and write capacity units, along with data about increases and decreases.",
                "properties": {
                  "lastDecreaseDateTime": {
                    "format": "date-time",
                    "type": "string"
                  },
                  "lastIncreaseDateTime": {
                    "format": "date-time",
                    "type": "string"
                  },
                  "numberOfDecreasesToday": {
                    "format": "int64",
                    "type": "integer"
                  },
                  "readCapacityUnits": {
                    "format": "int64",
                    "type": "integer"
                  },
                  "writeCapacityUnits": {
                    "format": "int64",
                    "type": "integer"
                  }
                },
                "type": "object",
                "additionalProperties": false
              }
            },
            "type": "object",
            "additionalProperties": false
          },
          "type": "array"
        },
        "globalTableVersion": {
          "description": "Represents the version of global tables (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GlobalTables.html)\nin use, if the table is replicated across Amazon Web Services Regions.",
          "type": "string"
        },
        "itemCount": {
          "description": "The number of items in the specified table. DynamoDB updates this value approximately\nevery six hours. Recent changes might not be reflected in this value.",
          "format": "int64",
          "type": "integer"
        },
        "latestStreamARN": {
          "description": "The Amazon Resource Name (ARN) that uniquely identifies the latest stream\nfor this table.",
          "type": "string"
        },
        "latestStreamLabel": {
          "description": "A timestamp, in ISO 8601 format, for this stream.\n\nNote that LatestStreamLabel is not a unique identifier for the stream, because\nit is possible that a stream from another table might have the same timestamp.\nHowever, the combination of the following three elements is guaranteed to\nbe unique:\n\n   * Amazon Web Services customer ID\n\n   * Table name\n\n   * StreamLabel",
          "type": "string"
        },
        "replicas": {
          "description": "Represents replicas of the table.",
          "items": {
            "description": "Contains the details of the replica.",
            "properties": {
              "globalSecondaryIndexes": {
                "items": {
                  "description": "Represents the properties of a replica global secondary index.",
                  "properties": {
                    "indexName": {
                      "type": "string"
                    },
                    "provisionedThroughputOverride": {
                      "description": "Replica-specific provisioned throughput settings. If not specified, uses\nthe source table's provisioned throughput settings.",
                      "properties": {
                        "readCapacityUnits": {
                          "format": "int64",
                          "type": "integer"
                        }
                      },
                      "type": "object",
                      "additionalProperties": false
                    }
                  },
                  "type": "object",
                  "additionalProperties": false
                },
                "type": "array"
              },
              "kmsMasterKeyID": {
                "type": "string"
              },
              "provisionedThroughputOverride": {
                "description": "Replica-specific provisioned throughput settings. If not specified, uses\nthe source table's provisioned throughput settings.",
                "properties": {
                  "readCapacityUnits": {
                    "format": "int64",
                    "type": "integer"
                  }
                },
                "type": "object",
                "additionalProperties": false
              },
              "regionName": {
                "type": "string"
              },
              "replicaInaccessibleDateTime": {
                "format": "date-time",
                "type": "string"
              },
              "replicaStatus": {
                "type": "string"
              },
              "replicaStatusDescription": {
                "type": "string"
              },
              "replicaStatusPercentProgress": {
                "type": "string"
              },
              "replicaTableClassSummary": {
                "description": "Contains details of the table class.",
                "properties": {
                  "lastUpdateDateTime": {
                    "format": "date-time",
                    "type": "string"
                  },
                  "tableClass": {
                    "type": "string"
                  }
                },
                "type": "object",
                "additionalProperties": false
              }
            },
            "type": "object",
            "additionalProperties": false
          },
          "type": "array"
        },
        "restoreSummary": {
          "description": "Contains details for the restore.",
          "properties": {
            "restoreDateTime": {
              "format": "date-time",
              "type": "string"
            },
            "restoreInProgress": {
              "type": "boolean"
            },
            "sourceBackupARN": {
              "type": "string"
            },
            "sourceTableARN": {
              "type": "string"
            }
          },
          "type": "object",
          "additionalProperties": false
        },
        "tableID": {
          "description": "Unique identifier for the table for which the backup was created.",
          "type": "string"
        },
        "tableSizeBytes": {
          "description": "The total size of the specified table, in bytes. DynamoDB updates this value\napproximately every six hours. Recent changes might not be reflected in this\nvalue.",
          "format": "int64",
          "type": "integer"
        },
        "tableStatus": {
          "description": "The current state of the table:\n\n   * CREATING - The table is being created.\n\n   * UPDATING - The table/index configuration is being updated. The table/index\n   remains available for data operations when UPDATING.\n\n   * DELETING - The table is being deleted.\n\n   * ACTIVE - The table is ready for use.\n\n   * INACCESSIBLE_ENCRYPTION_CREDENTIALS - The KMS key used to encrypt the\n   table in inaccessible. Table operations may fail due to failure to use\n   the KMS key. DynamoDB will initiate the table archival process when a\n   table's KMS key remains inaccessible for more than seven days.\n\n   * ARCHIVING - The table is being archived. Operations are not allowed\n   until archival is complete.\n\n   * ARCHIVED - The table has been archived. See the ArchivalReason for more\n   information.",
          "type": "string"
        }
      },
      "type": "object",
      "additionalProperties": false
    }
  },
  "type": "object"
}