Common Neptune Datatypes - Amazon Neptune

Common Neptune Datatypes

Structures:

AvailabilityZone (structure)

Specifies an Availability Zone.

Fields

  • Name – UTF-8 string.

    The name of the availability zone.

DBSecurityGroupMembership (structure)

Specifies membership in a designated DB security group.

Fields

  • DBSecurityGroupName – UTF-8 string.

    The name of the DB security group.

  • Status – UTF-8 string.

    The status of the DB security group.

DomainMembership (structure)

An Active Directory Domain membership record associated with a DB instance.

Fields

  • Domain – UTF-8 string.

    The identifier of the Active Directory Domain.

  • FQDN – UTF-8 string.

    The fully qualified domain name of the Active Directory Domain.

  • IAMRoleName – UTF-8 string.

    The name of the IAM role to be used when making API calls to the Directory Service.

  • Status – UTF-8 string.

    The status of the DB instance's Active Directory Domain membership, such as joined, pending-join, failed etc).

DoubleRange (structure)

A range of double values.

Fields

  • From – Number (double).

    The minimum value in the range.

  • To – Number (double).

    The maximum value in the range.

Endpoint (structure)

Specifies a connection endpoint.

For the data structure that represents Amazon Neptune DB cluster endpoints, see DBClusterEndpoint.

Fields

  • Address – UTF-8 string.

    Specifies the DNS address of the DB instance.

  • HostedZoneId – UTF-8 string.

    Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

  • Port – Number (integer).

    Specifies the port that the database engine is listening on.

Filter (structure)

This type is not currently supported.

Fields

  • NameRequired: UTF-8 string.

    This parameter is not currently supported.

  • ValuesRequired: An array of Value— UTF-8 strings.

    This parameter is not currently supported.

Range (structure)

A range of integer values.

Fields

  • From – Number (integer).

    The minimum value in the range.

  • Step – Number (integer).

    The step value for the range. For example, if you have a range of 5,000 to 10,000, with a step value of 1,000, the valid values start at 5,000 and step up by 1,000. Even though 7,500 is within the range, it isn't a valid value for the range. The valid values are 5,000, 6,000, 7,000, 8,000...

  • To – Number (integer).

    The maximum value in the range.

Timezone (structure)

A time zone associated with a DBInstance (structure).

Fields

  • TimezoneName – UTF-8 string.

    The name of the time zone.

VpcSecurityGroupMembership (structure)

This data type is used as a response element for queries on VPC security group membership.

Fields

  • Status – UTF-8 string.

    The status of the VPC security group.

  • VpcSecurityGroupId – UTF-8 string.

    The name of the VPC security group.