aws_neptune_instance

account_id

Type: STRING

allocated_storage

Type: INT32
Provider name: AllocatedStorage
Description: Not supported by Neptune.

auto_minor_version_upgrade

Type: BOOLEAN
Provider name: AutoMinorVersionUpgrade
Description: Indicates that minor version patches are applied automatically.

availability_zone

Type: STRING
Provider name: AvailabilityZone
Description: Specifies the name of the Availability Zone the DB instance is located in.

backup_retention_period

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

ca_certificate_identifier

Type: STRING
Provider name: CACertificateIdentifier
Description: The identifier of the CA certificate for this DB instance.

character_set_name

Type: STRING
Provider name: CharacterSetName
Description: (Not supported by Neptune)

copy_tags_to_snapshot

Type: BOOLEAN
Provider name: CopyTagsToSnapshot
Description: Specifies whether tags are copied from the DB instance to snapshots of the DB instance.

db_cluster_identifier

Type: STRING
Provider name: DBClusterIdentifier
Description: 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.

db_instance_arn

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

db_instance_class

Type: STRING
Provider name: DBInstanceClass
Description: Contains the name of the compute and memory capacity class of the DB instance.

db_instance_identifier

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

db_instance_port

Type: INT32
Provider name: DbInstancePort
Description: Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.

db_instance_status

Type: STRING
Provider name: DBInstanceStatus
Description: Specifies the current state of this database.

db_name

Type: STRING
Provider name: DBName
Description: The database name.

db_parameter_groups

Type: UNORDERED_LIST_STRUCT
Provider name: DBParameterGroups
Description: Provides the list of DB parameter groups applied to this DB instance.

  • db_parameter_group_name
    Type: STRING
    Provider name: DBParameterGroupName
    Description: The name of the DP parameter group.
  • parameter_apply_status
    Type: STRING
    Provider name: ParameterApplyStatus
    Description: The status of parameter updates.

db_security_groups

Type: UNORDERED_LIST_STRUCT
Provider name: DBSecurityGroups
Description: Provides List of DB security group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

  • db_security_group_name
    Type: STRING
    Provider name: DBSecurityGroupName
    Description: The name of the DB security group.
  • status
    Type: STRING
    Provider name: Status
    Description: The status of the DB security group.

db_subnet_group

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

  • db_subnet_group_arn
    Type: STRING
    Provider name: DBSubnetGroupArn
    Description: The Amazon Resource Name (ARN) for the DB subnet group.
  • db_subnet_group_description
    Type: STRING
    Provider name: DBSubnetGroupDescription
    Description: Provides the description of the DB subnet group.
  • db_subnet_group_name
    Type: STRING
    Provider name: DBSubnetGroupName
    Description: The name of the DB subnet group.
  • subnet_group_status
    Type: STRING
    Provider name: SubnetGroupStatus
    Description: Provides the status of the DB subnet group.
  • subnets
    Type: UNORDERED_LIST_STRUCT
    Provider name: Subnets
    Description: Contains a list of Subnet elements.
    • subnet_availability_zone
      Type: STRUCT
      Provider name: SubnetAvailabilityZone
      Description: Specifies the EC2 Availability Zone that the subnet is in.
      • name
        Type: STRING
        Provider name: Name
        Description: The name of the availability zone.
    • subnet_identifier
      Type: STRING
      Provider name: SubnetIdentifier
      Description: Specifies the identifier of the subnet.
    • subnet_status
      Type: STRING
      Provider name: SubnetStatus
      Description: Specifies the status of the subnet.
  • vpc_id
    Type: STRING
    Provider name: VpcId
    Description: Provides the VpcId of the DB subnet group.

dbi_resource_id

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

deletion_protection

Type: BOOLEAN
Provider name: DeletionProtection
Description: Indicates whether or not the DB instance has deletion protection enabled. The instance can’t be deleted when deletion protection is enabled. See Deleting a DB Instance.

domain_memberships

Type: UNORDERED_LIST_STRUCT
Provider name: DomainMemberships
Description: Not supported

  • domain
    Type: STRING
    Provider name: Domain
    Description: The identifier of the Active Directory Domain.
  • fqdn
    Type: STRING
    Provider name: FQDN
    Description: The fully qualified domain name of the Active Directory Domain.
  • iam_role_name
    Type: STRING
    Provider name: IAMRoleName
    Description: The name of the IAM role to be used when making API calls to the Directory Service.
  • status
    Type: STRING
    Provider name: Status
    Description: The status of the DB instance’s Active Directory Domain membership, such as joined, pending-join, failed etc).

enabled_cloudwatch_logs_exports

Type: UNORDERED_LIST_STRING
Provider name: EnabledCloudwatchLogsExports
Description: A list of log types that this DB instance is configured to export to CloudWatch Logs.

endpoint

Type: STRUCT
Provider name: Endpoint
Description: Specifies the connection endpoint.

  • address
    Type: STRING
    Provider name: Address
    Description: Specifies the DNS address of the DB instance.
  • hosted_zone_id
    Type: STRING
    Provider name: HostedZoneId
    Description: Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
  • port
    Type: INT32
    Provider name: Port
    Description: Specifies the port that the database engine is listening on.

engine

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

engine_version

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

enhanced_monitoring_resource_arn

Type: STRING
Provider name: EnhancedMonitoringResourceArn
Description: The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.

iam_database_authentication_enabled

Type: BOOLEAN
Provider name: IAMDatabaseAuthenticationEnabled
Description: True if Amazon Identity and Access Management (IAM) authentication is enabled, and otherwise false.

instance_create_time

Type: TIMESTAMP
Provider name: InstanceCreateTime
Description: Provides the date and time the DB instance was created.

iops

Type: INT32
Provider name: Iops
Description: Specifies the Provisioned IOPS (I/O operations per second) value.

kms_key_id

Type: STRING
Provider name: KmsKeyId
Description: Not supported: The encryption for DB instances is managed by the 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.

license_model

Type: STRING
Provider name: LicenseModel
Description: License model information for this DB instance.

master_username

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

monitoring_interval

Type: INT32
Provider name: MonitoringInterval
Description: The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.

monitoring_role_arn

Type: STRING
Provider name: MonitoringRoleArn
Description: The ARN for the IAM role that permits Neptune to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

multi_az

Type: BOOLEAN
Provider name: MultiAZ
Description: Specifies if the DB instance is a Multi-AZ deployment.

option_group_memberships

Type: UNORDERED_LIST_STRUCT
Provider name: OptionGroupMemberships
Description: (Not supported by Neptune)

  • option_group_name
    Type: STRING
    Provider name: OptionGroupName
    Description: Not supported by Neptune.
  • status
    Type: STRING
    Provider name: Status
    Description: Not supported by Neptune.

pending_modified_values

Type: STRUCT
Provider name: PendingModifiedValues
Description: Specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.

  • allocated_storage
    Type: INT32
    Provider name: AllocatedStorage
    Description: Contains the new AllocatedStorage size for the DB instance that will be applied or is currently being applied.
  • backup_retention_period
    Type: INT32
    Provider name: BackupRetentionPeriod
    Description: Specifies the pending number of days for which automated backups are retained.
  • ca_certificate_identifier
    Type: STRING
    Provider name: CACertificateIdentifier
    Description: Specifies the identifier of the CA certificate for the DB instance.
  • db_instance_class
    Type: STRING
    Provider name: DBInstanceClass
    Description: Contains the new DBInstanceClass for the DB instance that will be applied or is currently being applied.
  • db_instance_identifier
    Type: STRING
    Provider name: DBInstanceIdentifier
    Description: Contains the new DBInstanceIdentifier for the DB instance that will be applied or is currently being applied.
  • db_subnet_group_name
    Type: STRING
    Provider name: DBSubnetGroupName
    Description: The new DB subnet group for the DB instance.
  • engine_version
    Type: STRING
    Provider name: EngineVersion
    Description: Indicates the database engine version.
  • iops
    Type: INT32
    Provider name: Iops
    Description: Specifies the new Provisioned IOPS value for the DB instance that will be applied or is currently being applied.
  • license_model
    Type: STRING
    Provider name: LicenseModel
    Description: Not supported by Neptune.
  • master_user_password
    Type: STRING
    Provider name: MasterUserPassword
    Description: Not supported by Neptune.
  • multi_az
    Type: BOOLEAN
    Provider name: MultiAZ
    Description: Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.
  • 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.
  • port
    Type: INT32
    Provider name: Port
    Description: Specifies the pending port for the DB instance.
  • storage_type
    Type: STRING
    Provider name: StorageType
    Description: Specifies the storage type to be associated with the DB instance.

performance_insights_enabled

Type: BOOLEAN
Provider name: PerformanceInsightsEnabled
Description: (Not supported by Neptune)

performance_insights_kms_key_id

Type: STRING
Provider name: PerformanceInsightsKMSKeyId
Description: (Not supported by Neptune)

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).

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.

publicly_accessible

Type: BOOLEAN
Provider name: PubliclyAccessible
Description: This flag should no longer be used.

read_replica_db_cluster_identifiers

Type: UNORDERED_LIST_STRING
Provider name: ReadReplicaDBClusterIdentifiers
Description: Contains one or more identifiers of DB clusters that are Read Replicas of this DB instance.

read_replica_db_instance_identifiers

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

read_replica_source_db_instance_identifier

Type: STRING
Provider name: ReadReplicaSourceDBInstanceIdentifier
Description: Contains the identifier of the source DB instance if this DB instance is a Read Replica.

secondary_availability_zone

Type: STRING
Provider name: SecondaryAvailabilityZone
Description: If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

status_infos

Type: UNORDERED_LIST_STRUCT
Provider name: StatusInfos
Description: The status of a Read Replica. If the instance is not a Read Replica, this is blank.

  • message
    Type: STRING
    Provider name: Message
    Description: Details of the error if there is an error for the instance. If the instance is not in an error state, this value is blank.
  • normal
    Type: BOOLEAN
    Provider name: Normal
    Description: Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.
  • status
    Type: STRING
    Provider name: Status
    Description: Status of the DB instance. For a StatusType of read replica, the values can be replicating, error, stopped, or terminated.
  • status_type
    Type: STRING
    Provider name: StatusType
    Description: This value is currently “read replication."

storage_encrypted

Type: BOOLEAN
Provider name: StorageEncrypted
Description: Not supported: The encryption for DB instances is managed by the DB cluster.

storage_type

Type: STRING
Provider name: StorageType
Description: Specifies the storage type associated with DB instance.

tags

Type: UNORDERED_LIST_STRING

tde_credential_arn

Type: STRING
Provider name: TdeCredentialArn
Description: The ARN from the key store with which the instance is associated for TDE encryption.

timezone

Type: STRING
Provider name: Timezone
Description: Not supported.

vpc_security_groups

Type: UNORDERED_LIST_STRUCT
Provider name: VpcSecurityGroups
Description: Provides a list of VPC security group elements that the DB instance 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