Amazon DynamoDB Dynamodb Cluster API

openapi: 3.1.0
info:
  title: Amazon DynamoDB Cluster API
  version: '2012-08-10'
  description: Generated from AWS's published Smithy model for Amazon DynamoDB. 4 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://dax.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /#CreateCluster:
    post:
      operationId: CreateCluster
      summary: Create Cluster
      description: Creates a DAX cluster. All nodes in the cluster run the same DAX caching software.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateClusterResponse'
        '400':
          description: ClusterAlreadyExistsFault; ClusterQuotaForCustomerExceededFault; InsufficientClusterCapacityFault;
            InvalidClusterStateFault; InvalidParameterCombinationException; InvalidParameterGroupStateFault; InvalidParameterValueException;
            InvalidVPCNetworkStateFault; NodeQuotaForClusterExceededFault; NodeQuotaForCustomerExceededFault; ServiceLinkedRoleNotFoundFault;
            TagQuotaPerResourceExceeded
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ClusterAlreadyExistsFault'
        '404':
          description: ParameterGroupNotFoundFault; SubnetGroupNotFoundFault
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ParameterGroupNotFoundFault'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonDAXV3.CreateCluster
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateClusterRequest'
      tags:
      - Cluster
  /#DeleteCluster:
    post:
      operationId: DeleteCluster
      summary: Delete Cluster
      description: Deletes a previously provisioned DAX cluster. DeleteCluster deletes all associated nodes, node endpoints
        and the DAX cluster itself. When you receive a successful response from this action, DAX immediately begins deleting
        the cluster; you cannot cancel or revert this action.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteClusterResponse'
        '404':
          description: ClusterNotFoundFault
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ClusterNotFoundFault'
        '400':
          description: InvalidClusterStateFault; InvalidParameterCombinationException; InvalidParameterValueException; ServiceLinkedRoleNotFoundFault
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidClusterStateFault'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonDAXV3.DeleteCluster
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteClusterRequest'
      tags:
      - Cluster
  /#DescribeClusters:
    post:
      operationId: DescribeClusters
      summary: Describe Clusters
      description: Returns information about all provisioned DAX clusters if no cluster identifier is specified, or about
        a specific DAX cluster if a cluster identifier is supplied. If the cluster is in the CREATING state, only cluster
        level information will be displayed until all of the nodes are successfully provisioned. If the cluster is in the
        DELETING state, only cluster level information will be displayed. If nodes are currently being added to the DAX cluster,
        node endpoint information and creation time for the additional nodes will not be displayed until they are completely
        provisioned. When the DAX cluster state is available, the cluster is ready for use. If nodes are currently being removed
        from the DAX cluster, no endpoint information for the removed nodes is displayed.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeClustersResponse'
        '404':
          description: ClusterNotFoundFault
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ClusterNotFoundFault'
        '400':
          description: InvalidParameterCombinationException; InvalidParameterValueException; ServiceLinkedRoleNotFoundFault
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidParameterCombinationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonDAXV3.DescribeClusters
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeClustersRequest'
      tags:
      - Cluster
  /#UpdateCluster:
    post:
      operationId: UpdateCluster
      summary: Update Cluster
      description: Modifies the settings for a DAX cluster. You can use this action to change one or more cluster configuration
        parameters by specifying the parameters and the new values.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateClusterResponse'
        '404':
          description: ClusterNotFoundFault; ParameterGroupNotFoundFault
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ClusterNotFoundFault'
        '400':
          description: InvalidClusterStateFault; InvalidParameterCombinationException; InvalidParameterGroupStateFault; InvalidParameterValueException;
            ServiceLinkedRoleNotFoundFault
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidClusterStateFault'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonDAXV3.UpdateCluster
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateClusterRequest'
      tags:
      - Cluster
components:
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
        request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: dax
  schemas:
    Cluster:
      type: object
      properties:
        ClusterName:
          type: string
          description: The name of the DAX cluster.
        Description:
          type: string
          description: The description of the cluster.
        ClusterArn:
          type: string
          description: The Amazon Resource Name (ARN) that uniquely identifies the cluster.
        TotalNodes:
          type: integer
          description: The total number of nodes in the cluster.
        ActiveNodes:
          type: integer
          description: The number of nodes in the cluster that are active (i.e., capable of serving requests).
        NodeType:
          type: string
          description: The node type for the nodes in the cluster. (All nodes in a DAX cluster are of the same type.)
        Status:
          type: string
          description: The current status of the cluster.
        ClusterDiscoveryEndpoint:
          $ref: '#/components/schemas/DaxEndpoint'
        NodeIdsToRemove:
          type: array
          items:
            type: string
          description: A list of nodes to be removed from the cluster.
        Nodes:
          type: array
          items:
            $ref: '#/components/schemas/Node'
          description: A list of nodes that are currently in the cluster.
        PreferredMaintenanceWindow:
          type: string
          description: 'A range of time when maintenance of DAX cluster software will be performed. For example: sun:01:00-sun:09:00.
            Cluster maintenance normally takes less than 30 minutes, and is performed automatically within the maintenance
            window.'
        NotificationConfiguration:
          $ref: '#/components/schemas/NotificationConfiguration'
        SubnetGroup:
          type: string
          description: The subnet group where the DAX cluster is running.
        SecurityGroups:
          type: array
          items:
            $ref: '#/components/schemas/SecurityGroupMembership'
          description: A list of security groups, and the status of each, for the nodes in the cluster.
        IamRoleArn:
          type: string
          description: A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role
            and use the role's permissions to access DynamoDB on your behalf.
        ParameterGroup:
          $ref: '#/components/schemas/ParameterGroupStatus'
        SSEDescription:
          $ref: '#/components/schemas/DaxSSEDescription'
        ClusterEndpointEncryptionType:
          type: string
          enum:
          - NONE
          - TLS
          description: 'The type of encryption supported by the cluster''s endpoint. Values are: NONE for no encryption TLS
            for Transport Layer Security'
        NetworkType:
          type: string
          enum:
          - ipv4
          - ipv6
          - dual_stack
          description: 'The IP address type of the cluster. Values are: ipv4 - IPv4 addresses only ipv6 - IPv6 addresses only
            dual_stack - Both IPv4 and IPv6 addresses'
    ClusterAlreadyExistsFault:
      type: object
      properties:
        message:
          type: string
    ClusterNotFoundFault:
      type: object
      properties:
        message:
          type: string
    CreateClusterRequest:
      type: object
      properties:
        ClusterName:
          type: string
          description: 'The cluster identifier. This parameter is stored as a lowercase string. Constraints: A name must contain
            from 1 to 20 alphanumeric characters or hyphens. The first character must be a letter. A name cannot end with
            a hyphen or contain two consecutive hyphens.'
        NodeType:
          type: string
          description: The compute and memory capacity of the nodes in the cluster.
        Description:
          type: string
          description: A description of the cluster.
        ReplicationFactor:
          type: integer
          description: The number of nodes in the DAX cluster. A replication factor of 1 will create a single-node cluster,
            without any read replicas. For additional fault tolerance, you can create a multiple node cluster with one or
            more read replicas. To do this, set ReplicationFactor to a number between 3 (one primary and two read replicas)
            and 10 (one primary and nine read replicas). If the AvailabilityZones parameter is provided, its length must equal
            the ReplicationFactor. Amazon Web Services recommends that you have at least two read replicas per cluster.
        AvailabilityZones:
          type: array
          items:
            type: string
          description: The Availability Zones (AZs) in which the cluster nodes will reside after the cluster has been created
            or updated. If provided, the length of this list must equal the ReplicationFactor parameter. If you omit this
            parameter, DAX will spread the nodes across Availability Zones for the highest availability.
        SubnetGroupName:
          type: string
          description: The name of the subnet group to be used for the replication group. DAX clusters can only run in an
            Amazon VPC environment. All of the subnets that you specify in a subnet group must exist in the same VPC.
        SecurityGroupIds:
          type: array
          items:
            type: string
          description: A list of security group IDs to be assigned to each node in the DAX cluster. (Each of the security
            group ID is system-generated.) If this parameter is not specified, DAX assigns the default VPC security group
            to each node.
        PreferredMaintenanceWindow:
          type: string
          description: 'Specifies the weekly time range during which maintenance on the DAX cluster is performed. It is specified
            as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute
            period. Valid values for ddd are: sun mon tue wed thu fri sat Example: sun:05:00-sun:09:00 If you don''t specify
            a preferred maintenance window when you create or modify a cache cluster, DAX assigns a 60-minute maintenance
            window on a randomly selected day of the week.'
        NotificationTopicArn:
          type: string
          description: The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent. The Amazon
            SNS topic owner must be same as the DAX cluster owner.
        IamRoleArn:
          type: string
          description: A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role
            and use the role's permissions to access DynamoDB on your behalf.
        ParameterGroupName:
          type: string
          description: The parameter group to be associated with the DAX cluster.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/DaxTag'
          description: A set of tags to associate with the DAX cluster.
        SSESpecification:
          $ref: '#/components/schemas/DaxSSESpecification'
        ClusterEndpointEncryptionType:
          type: string
          enum:
          - NONE
          - TLS
          description: 'The type of encryption the cluster''s endpoint should support. Values are: NONE for no encryption
            TLS for Transport Layer Security'
        NetworkType:
          type: string
          enum:
          - ipv4
          - ipv6
          - dual_stack
          description: 'Specifies the IP protocol(s) the cluster uses for network communications. Values are: ipv4 - The cluster
            is accessible only through IPv4 addresses ipv6 - The cluster is accessible only through IPv6 addresses dual_stack
            - The cluster is accessible through both IPv4 and IPv6 addresses. If no explicit NetworkType is provided, the
            network type is derived based on the subnet group''s configuration.'
      required:
      - ClusterName
      - NodeType
      - ReplicationFactor
      - IamRoleArn
    CreateClusterResponse:
      type: object
      properties:
        Cluster:
          $ref: '#/components/schemas/Cluster'
    DaxEndpoint:
      type: object
      properties:
        Address:
          type: string
          description: The DNS hostname of the endpoint.
        Port:
          type: integer
          description: The port number that applications should use to connect to the endpoint.
        URL:
          type: string
          description: The URL that applications should use to connect to the endpoint. The default ports are 8111 for the
            "dax" protocol and 9111 for the "daxs" protocol.
    DaxSSEDescription:
      type: object
      properties:
        Status:
          type: string
          enum:
          - ENABLING
          - ENABLED
          - DISABLING
          - DISABLED
          description: 'The current state of server-side encryption: ENABLING - Server-side encryption is being enabled. ENABLED
            - Server-side encryption is enabled. DISABLING - Server-side encryption is being disabled. DISABLED - Server-side
            encryption is disabled.'
    DaxSSESpecification:
      type: object
      properties:
        Enabled:
          type: boolean
          description: Indicates whether server-side encryption is enabled (true) or disabled (false) on the cluster.
      required:
      - Enabled
    DaxTag:
      type: object
      properties:
        Key:
          type: string
          description: The key for the tag. Tag keys are case sensitive. Every DAX cluster can only have one tag with the
            same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value.
        Value:
          type: string
          description: The value of the tag. Tag values are case-sensitive and can be null.
    DeleteClusterRequest:
      type: object
      properties:
        ClusterName:
          type: string
          description: The name of the cluster to be deleted.
      required:
      - ClusterName
    DeleteClusterResponse:
      type: object
      properties:
        Cluster:
          $ref: '#/components/schemas/Cluster'
    DescribeClustersRequest:
      type: object
      properties:
        ClusterNames:
          type: array
          items:
            type: string
          description: The names of the DAX clusters being described.
        MaxResults:
          type: integer
          description: The maximum number of results to include in the response. If more results exist than the specified
            MaxResults value, a token is included in the response so that the remaining results can be retrieved. The value
            for MaxResults must be between 20 and 100.
        NextToken:
          type: string
          description: An optional token returned from a prior request. Use this token for pagination of results from this
            action. If this parameter is specified, the response includes only results beyond the token, up to the value specified
            by MaxResults.
    DescribeClustersResponse:
      type: object
      properties:
        NextToken:
          type: string
          description: Provides an identifier to allow retrieval of paginated results.
        Clusters:
          type: array
          items:
            $ref: '#/components/schemas/Cluster'
          description: The descriptions of your DAX clusters, in response to a DescribeClusters request.
    InvalidClusterStateFault:
      type: object
      properties:
        message:
          type: string
    InvalidParameterCombinationException:
      type: object
      properties:
        message:
          type: string
    Node:
      type: object
      properties:
        NodeId:
          type: string
          description: A system-generated identifier for the node.
        Endpoint:
          $ref: '#/components/schemas/DaxEndpoint'
        NodeCreateTime:
          type: string
          format: date-time
          description: The date and time (in UNIX epoch format) when the node was launched.
        AvailabilityZone:
          type: string
          description: The Availability Zone (AZ) in which the node has been deployed.
        NodeStatus:
          type: string
          description: 'The current status of the node. For example: available.'
        ParameterGroupStatus:
          type: string
          description: The status of the parameter group associated with this node. For example, in-sync.
    NotificationConfiguration:
      type: object
      properties:
        TopicArn:
          type: string
          description: The Amazon Resource Name (ARN) that identifies the topic.
        TopicStatus:
          type: string
          description: The current state of the topic. A value of “active” means that notifications will be sent to the topic.
            A value of “inactive” means that notifications will not be sent to the topic.
    ParameterGroupNotFoundFault:
      type: object
      properties:
        message:
          type: string
    ParameterGroupStatus:
      type: object
      properties:
        ParameterGroupName:
          type: string
          description: The name of the parameter group.
        ParameterApplyStatus:
          type: string
          description: The status of parameter updates.
        NodeIdsToReboot:
          type: array
          items:
            type: string
          description: The node IDs of one or more nodes to be rebooted.
    SecurityGroupMembership:
      type: object
      properties:
        SecurityGroupIdentifier:
          type: string
          description: The unique ID for this security group.
        Status:
          type: string
          description: The status of this security group.
    ServiceQuotaExceededException:
      type: object
      properties: {}
    UpdateClusterRequest:
      type: object
      properties:
        ClusterName:
          type: string
          description: The name of the DAX cluster to be modified.
        Description:
          type: string
          description: A description of the changes being made to the cluster.
        PreferredMaintenanceWindow:
          type: string
          description: 'A range of time when maintenance of DAX cluster software will be performed. For example: sun:01:00-sun:09:00.
            Cluster maintenance normally takes less than 30 minutes, and is performed automatically within the maintenance
            window.'
        NotificationTopicArn:
          type: string
          description: The Amazon Resource Name (ARN) that identifies the topic.
        NotificationTopicStatus:
          type: string
          description: The current state of the topic. A value of “active” means that notifications will be sent to the topic.
            A value of “inactive” means that notifications will not be sent to the topic.
        ParameterGroupName:
          type: string
          description: The name of a parameter group for this cluster.
        SecurityGroupIds:
          type: array
          items:
            type: string
          description: A list of user-specified security group IDs to be assigned to each node in the DAX cluster. If this
            parameter is not specified, DAX assigns the default VPC security group to each node.
      required:
      - ClusterName
    UpdateClusterResponse:
      type: object
      properties:
        Cluster:
          $ref: '#/components/schemas/Cluster'
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/dax/service/2017-04-19/dax-2017-04-19.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)