aws_neptune_cluster

account_id

Type: STRING

allocated_storage

Type: INT32
Provider name: AllocatedStorage
Description: AllocatedStorage always returns 1, because Neptune DB cluster storage size is not fixed, but instead automatically adjusts as needed.

associated_roles

Type: UNORDERED_LIST_STRUCT
Provider name: AssociatedRoles
Description: Provides a list of the Amazon Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon services on your behalf.

  • feature_name
    Type: STRING
    Provider name: FeatureName
    Description: The name of the feature associated with the Amazon Identity and Access Management (IAM) role. For the list of supported feature names, see DescribeDBEngineVersions.
  • role_arn
    Type: STRING
    Provider name: RoleArn
    Description: The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
  • status
    Type: STRING
    Provider name: Status
    Description: Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following values:
    • ACTIVE - the IAM role ARN is associated with the DB cluster and can be used to access other Amazon services on your behalf.
    • PENDING - the IAM role ARN is being associated with the DB cluster.
    • INVALID - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume the IAM role in order to access other Amazon services on your behalf.

automatic_restart_time

Type: TIMESTAMP
Provider name: AutomaticRestartTime
Description: Time at which the DB cluster will be automatically restarted.

availability_zones

Type: UNORDERED_LIST_STRING
Provider name: AvailabilityZones
Description: Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.

backup_retention_period

Type: INT32
Provider name: BackupRetentionPeriod
Description: Specifies the number of days for which automatic DB snapshots are retained.

character_set_name

Type: STRING
Provider name: CharacterSetName
Description: Not supported by Neptune.

clone_group_id

Type: STRING
Provider name: CloneGroupId
Description: Identifies the clone group to which the DB cluster is associated.

cluster_create_time

Type: TIMESTAMP
Provider name: ClusterCreateTime
Description: Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).

copy_tags_to_snapshot

Type: BOOLEAN
Provider name: CopyTagsToSnapshot
Description: If set to true, tags are copied to any snapshot of the DB cluster that is created.

cross_account_clone

Type: BOOLEAN
Provider name: CrossAccountClone
Description: If set to true, the DB cluster can be cloned across accounts.

database_name

Type: STRING
Provider name: DatabaseName
Description: Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.

db_cluster_arn

Type: STRING
Provider name: DBClusterArn
Description: The Amazon Resource Name (ARN) for the DB cluster.

db_cluster_identifier

Type: STRING
Provider name: DBClusterIdentifier
Description: Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

db_cluster_members

Type: UNORDERED_LIST_STRUCT
Provider name: DBClusterMembers
Description: Provides the list of instances that make up the DB cluster.

  • db_cluster_parameter_group_status
    Type: STRING
    Provider name: DBClusterParameterGroupStatus
    Description: Specifies the status of the DB cluster parameter group for this member of the DB cluster.
  • db_instance_identifier
    Type: STRING
    Provider name: DBInstanceIdentifier
    Description: Specifies the instance identifier for this member of the DB cluster.
  • is_cluster_writer
    Type: BOOLEAN
    Provider name: IsClusterWriter
    Description: Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.
  • promotion_tier
    Type: INT32
    Provider name: PromotionTier
    Description: A value that specifies the order in which a Read Replica is promoted to the primary instance after a failure of the existing primary instance.

db_cluster_option_group_memberships

Type: UNORDERED_LIST_STRUCT
Provider name: DBClusterOptionGroupMemberships
Description: Not supported by Neptune.

  • db_cluster_option_group_name
    Type: STRING
    Provider name: DBClusterOptionGroupName
    Description: Not supported by Neptune.
  • status
    Type: STRING
    Provider name: Status
    Description: Not supported by Neptune.

db_cluster_parameter_group

Type: STRING
Provider name: DBClusterParameterGroup
Description: Specifies the name of the DB cluster parameter group for the DB cluster.

db_cluster_resource_id

Type: STRING
Provider name: DbClusterResourceId
Description: The Amazon Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon CloudTrail log entries whenever the Amazon KMS key for the DB cluster is accessed.

db_subnet_group

Type: STRING
Provider name: DBSubnetGroup
Description: Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

deletion_protection

Type: BOOLEAN
Provider name: DeletionProtection
Description: Indicates whether or not the DB cluster has deletion protection enabled. The database can’t be deleted when deletion protection is enabled.

earliest_restorable_time

Type: TIMESTAMP
Provider name: EarliestRestorableTime
Description: Specifies the earliest time to which a database can be restored with point-in-time restore.

enabled_cloudwatch_logs_exports

Type: UNORDERED_LIST_STRING
Provider name: EnabledCloudwatchLogsExports
Description: A list of the log types that this DB cluster is configured to export to CloudWatch Logs. Valid log types are: audit (to publish audit logs to CloudWatch) and slowquery (to publish slow-query logs to CloudWatch). See Publishing Neptune logs to Amazon CloudWatch logs.

endpoint

Type: STRING
Provider name: Endpoint
Description: Specifies the connection endpoint for the primary instance of the DB cluster.

engine

Type: STRING
Provider name: Engine
Description: Provides the name of the database engine to be used for this DB cluster.

engine_version

Type: STRING
Provider name: EngineVersion
Description: Indicates the database engine version.

global_cluster_identifier

Type: STRING
Provider name: GlobalClusterIdentifier
Description: Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database.

hosted_zone_id

Type: STRING
Provider name: HostedZoneId
Description: Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

iam_database_authentication_enabled

Type: BOOLEAN
Provider name: IAMDatabaseAuthenticationEnabled
Description: True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

io_optimized_next_allowed_modification_time

Type: TIMESTAMP
Provider name: IOOptimizedNextAllowedModificationTime
Description: The next time you can modify the DB cluster to use the iopt1 storage type.

kms_key_id

Type: STRING
Provider name: KmsKeyId
Description: If StorageEncrypted is true, the Amazon KMS key identifier for the encrypted DB cluster.

latest_restorable_time

Type: TIMESTAMP
Provider name: LatestRestorableTime
Description: Specifies the latest time to which a database can be restored with point-in-time restore.

master_username

Type: STRING
Provider name: MasterUsername
Description: Not supported by Neptune.

multi_az

Type: BOOLEAN
Provider name: MultiAZ
Description: Specifies whether the DB cluster has instances in multiple Availability Zones.

pending_modified_values

Type: STRUCT
Provider name: PendingModifiedValues
Description: This data type is used as a response element in the ModifyDBCluster operation and contains changes that will be applied during the next maintenance window.

  • allocated_storage
    Type: INT32
    Provider name: AllocatedStorage
    Description: The allocated storage size in gibibytes (GiB) for database engines. For Neptune, AllocatedStorage always returns 1, because Neptune DB cluster storage size isn’t fixed, but instead automatically adjusts as needed.
  • backup_retention_period
    Type: INT32
    Provider name: BackupRetentionPeriod
    Description: The number of days for which automatic DB snapshots are retained.
  • db_cluster_identifier
    Type: STRING
    Provider name: DBClusterIdentifier
    Description: The DBClusterIdentifier value for the DB cluster.
  • engine_version
    Type: STRING
    Provider name: EngineVersion
    Description: The database engine version.
  • iam_database_authentication_enabled
    Type: BOOLEAN
    Provider name: IAMDatabaseAuthenticationEnabled
    Description: A value that indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
  • iops
    Type: INT32
    Provider name: Iops
    Description: The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters.
  • pending_cloudwatch_logs_exports
    Type: STRUCT
    Provider name: PendingCloudwatchLogsExports
    Description: This PendingCloudwatchLogsExports structure specifies pending changes to which CloudWatch logs are enabled and which are disabled.
    • log_types_to_disable
      Type: UNORDERED_LIST_STRING
      Provider name: LogTypesToDisable
      Description: Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.
    • log_types_to_enable
      Type: UNORDERED_LIST_STRING
      Provider name: LogTypesToEnable
      Description: Log types that are in the process of being deactivated. After they are deactivated, these log types aren’t exported to CloudWatch Logs.
  • storage_type
    Type: STRING
    Provider name: StorageType
    Description: The storage type for the DB cluster.

percent_progress

Type: STRING
Provider name: PercentProgress
Description: Specifies the progress of the operation as a percentage.

port

Type: INT32
Provider name: Port
Description: Specifies the port that the database engine is listening on.

preferred_backup_window

Type: STRING
Provider name: PreferredBackupWindow
Description: Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

preferred_maintenance_window

Type: STRING
Provider name: PreferredMaintenanceWindow
Description: Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

read_replica_identifiers

Type: UNORDERED_LIST_STRING
Provider name: ReadReplicaIdentifiers
Description: Contains one or more identifiers of the Read Replicas associated with this DB cluster.

reader_endpoint

Type: STRING
Provider name: ReaderEndpoint
Description: The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Read Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Neptune distributes the connection requests among the Read Replicas in the DB cluster. This functionality can help balance your read workload across multiple Read Replicas in your DB cluster. If a failover occurs, and the Read Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Read Replicas in the cluster, you can then reconnect to the reader endpoint.

replication_source_identifier

Type: STRING
Provider name: ReplicationSourceIdentifier
Description: Not supported by Neptune.

serverless_v2_scaling_configuration

Type: STRUCT
Provider name: ServerlessV2ScalingConfiguration
Description: Shows the scaling configuration for a Neptune Serverless DB cluster. For more information, see Using Amazon Neptune Serverless in the Amazon Neptune User Guide.

  • max_capacity
    Type: DOUBLE
    Provider name: MaxCapacity
    Description: The maximum number of Neptune capacity units (NCUs) for a DB instance in a Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 40, 40.5, 41, and so on.
  • min_capacity
    Type: DOUBLE
    Provider name: MinCapacity
    Description: The minimum number of Neptune capacity units (NCUs) for a DB instance in a Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 8, 8.5, 9, and so on.

status

Type: STRING
Provider name: Status
Description: Specifies the current state of this DB cluster.

storage_encrypted

Type: BOOLEAN
Provider name: StorageEncrypted
Description: Specifies whether the DB cluster is encrypted.

storage_type

Type: STRING
Provider name: StorageType
Description: The storage type associated with the DB cluster.

tags

Type: UNORDERED_LIST_STRING

vpc_security_groups

Type: UNORDERED_LIST_STRUCT
Provider name: VpcSecurityGroups
Description: Provides a list of VPC security groups that the DB cluster belongs to.

  • status
    Type: STRING
    Provider name: Status
    Description: The status of the VPC security group.
  • vpc_security_group_id
    Type: STRING
    Provider name: VpcSecurityGroupId
    Description: The name of the VPC security group.
PREVIEWING: rtrieu/product-analytics-ui-changes