1// Code generated by smithy-go-codegen DO NOT EDIT.
2
3package types
4
5import (
6	"time"
7)
8
9// Specifies an Availability Zone.
10type AvailabilityZone struct {
11
12	// The name of the availability zone.
13	Name *string
14}
15
16// Specifies a character set.
17type CharacterSet struct {
18
19	// The description of the character set.
20	CharacterSetDescription *string
21
22	// The name of the character set.
23	CharacterSetName *string
24}
25
26// The configuration setting for the log types to be enabled for export to
27// CloudWatch Logs for a specific DB instance or DB cluster. The EnableLogTypes and
28// DisableLogTypes arrays determine which logs will be exported (or not exported)
29// to CloudWatch Logs.
30type CloudwatchLogsExportConfiguration struct {
31
32	// The list of log types to disable.
33	DisableLogTypes []string
34
35	// The list of log types to enable.
36	EnableLogTypes []string
37}
38
39// Contains the details of an Amazon Neptune DB cluster. This data type is used as
40// a response element in the DescribeDBClusters action.
41type DBCluster struct {
42
43	// AllocatedStorage always returns 1, because Neptune DB cluster storage size is
44	// not fixed, but instead automatically adjusts as needed.
45	AllocatedStorage *int32
46
47	// Provides a list of the AWS Identity and Access Management (IAM) roles that are
48	// associated with the DB cluster. IAM roles that are associated with a DB cluster
49	// grant permission for the DB cluster to access other AWS services on your behalf.
50	AssociatedRoles []DBClusterRole
51
52	// Provides the list of EC2 Availability Zones that instances in the DB cluster can
53	// be created in.
54	AvailabilityZones []string
55
56	// Specifies the number of days for which automatic DB snapshots are retained.
57	BackupRetentionPeriod *int32
58
59	// (Not supported by Neptune)
60	CharacterSetName *string
61
62	// Identifies the clone group to which the DB cluster is associated.
63	CloneGroupId *string
64
65	// Specifies the time when the DB cluster was created, in Universal Coordinated
66	// Time (UTC).
67	ClusterCreateTime *time.Time
68
69	// The Amazon Resource Name (ARN) for the DB cluster.
70	DBClusterArn *string
71
72	// Contains a user-supplied DB cluster identifier. This identifier is the unique
73	// key that identifies a DB cluster.
74	DBClusterIdentifier *string
75
76	// Provides the list of instances that make up the DB cluster.
77	DBClusterMembers []DBClusterMember
78
79	// (Not supported by Neptune)
80	DBClusterOptionGroupMemberships []DBClusterOptionGroupStatus
81
82	// Specifies the name of the DB cluster parameter group for the DB cluster.
83	DBClusterParameterGroup *string
84
85	// Specifies information on the subnet group associated with the DB cluster,
86	// including the name, description, and subnets in the subnet group.
87	DBSubnetGroup *string
88
89	// Contains the name of the initial database of this DB cluster that was provided
90	// at create time, if one was specified when the DB cluster was created. This same
91	// name is returned for the life of the DB cluster.
92	DatabaseName *string
93
94	// The AWS Region-unique, immutable identifier for the DB cluster. This identifier
95	// is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB
96	// cluster is accessed.
97	DbClusterResourceId *string
98
99	// Indicates whether or not the DB cluster has deletion protection enabled. The
100	// database can't be deleted when deletion protection is enabled.
101	DeletionProtection *bool
102
103	// Specifies the earliest time to which a database can be restored with
104	// point-in-time restore.
105	EarliestRestorableTime *time.Time
106
107	// A list of log types that this DB cluster is configured to export to CloudWatch
108	// Logs.
109	EnabledCloudwatchLogsExports []string
110
111	// Specifies the connection endpoint for the primary instance of the DB cluster.
112	Endpoint *string
113
114	// Provides the name of the database engine to be used for this DB cluster.
115	Engine *string
116
117	// Indicates the database engine version.
118	EngineVersion *string
119
120	// Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
121	HostedZoneId *string
122
123	// True if mapping of AWS Identity and Access Management (IAM) accounts to database
124	// accounts is enabled, and otherwise false.
125	IAMDatabaseAuthenticationEnabled bool
126
127	// If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB
128	// cluster.
129	KmsKeyId *string
130
131	// Specifies the latest time to which a database can be restored with point-in-time
132	// restore.
133	LatestRestorableTime *time.Time
134
135	// Contains the master username for the DB cluster.
136	MasterUsername *string
137
138	// Specifies whether the DB cluster has instances in multiple Availability Zones.
139	MultiAZ bool
140
141	// Specifies the progress of the operation as a percentage.
142	PercentProgress *string
143
144	// Specifies the port that the database engine is listening on.
145	Port *int32
146
147	// Specifies the daily time range during which automated backups are created if
148	// automated backups are enabled, as determined by the BackupRetentionPeriod.
149	PreferredBackupWindow *string
150
151	// Specifies the weekly time range during which system maintenance can occur, in
152	// Universal Coordinated Time (UTC).
153	PreferredMaintenanceWindow *string
154
155	// Contains one or more identifiers of the Read Replicas associated with this DB
156	// cluster.
157	ReadReplicaIdentifiers []string
158
159	// The reader endpoint for the DB cluster. The reader endpoint for a DB cluster
160	// load-balances connections across the Read Replicas that are available in a DB
161	// cluster. As clients request new connections to the reader endpoint, Neptune
162	// distributes the connection requests among the Read Replicas in the DB cluster.
163	// This functionality can help balance your read workload across multiple Read
164	// Replicas in your DB cluster. If a failover occurs, and the Read Replica that you
165	// are connected to is promoted to be the primary instance, your connection is
166	// dropped. To continue sending your read workload to other Read Replicas in the
167	// cluster, you can then reconnect to the reader endpoint.
168	ReaderEndpoint *string
169
170	// Not supported by Neptune.
171	ReplicationSourceIdentifier *string
172
173	// Specifies the current state of this DB cluster.
174	Status *string
175
176	// Specifies whether the DB cluster is encrypted.
177	StorageEncrypted bool
178
179	// Provides a list of VPC security groups that the DB cluster belongs to.
180	VpcSecurityGroups []VpcSecurityGroupMembership
181}
182
183// This data type represents the information you need to connect to an Amazon
184// Neptune DB cluster. This data type is used as a response element in the
185// following actions:
186//
187// * CreateDBClusterEndpoint
188//
189// * DescribeDBClusterEndpoints
190//
191// *
192// ModifyDBClusterEndpoint
193//
194// * DeleteDBClusterEndpoint
195//
196// For the data structure that
197// represents Amazon Neptune DB instance endpoints, see Endpoint.
198type DBClusterEndpoint struct {
199
200	// The type associated with a custom endpoint. One of: READER, WRITER, ANY.
201	CustomEndpointType *string
202
203	// The Amazon Resource Name (ARN) for the endpoint.
204	DBClusterEndpointArn *string
205
206	// The identifier associated with the endpoint. This parameter is stored as a
207	// lowercase string.
208	DBClusterEndpointIdentifier *string
209
210	// A unique system-generated identifier for an endpoint. It remains the same for
211	// the whole life of the endpoint.
212	DBClusterEndpointResourceIdentifier *string
213
214	// The DB cluster identifier of the DB cluster associated with the endpoint. This
215	// parameter is stored as a lowercase string.
216	DBClusterIdentifier *string
217
218	// The DNS address of the endpoint.
219	Endpoint *string
220
221	// The type of the endpoint. One of: READER, WRITER, CUSTOM.
222	EndpointType *string
223
224	// List of DB instance identifiers that aren't part of the custom endpoint group.
225	// All other eligible instances are reachable through the custom endpoint. Only
226	// relevant if the list of static members is empty.
227	ExcludedMembers []string
228
229	// List of DB instance identifiers that are part of the custom endpoint group.
230	StaticMembers []string
231
232	// The current status of the endpoint. One of: creating, available, deleting,
233	// inactive, modifying. The inactive state applies to an endpoint that cannot be
234	// used for a certain kind of cluster, such as a writer endpoint for a read-only
235	// secondary cluster in a global database.
236	Status *string
237}
238
239// Contains information about an instance that is part of a DB cluster.
240type DBClusterMember struct {
241
242	// Specifies the status of the DB cluster parameter group for this member of the DB
243	// cluster.
244	DBClusterParameterGroupStatus *string
245
246	// Specifies the instance identifier for this member of the DB cluster.
247	DBInstanceIdentifier *string
248
249	// Value that is true if the cluster member is the primary instance for the DB
250	// cluster and false otherwise.
251	IsClusterWriter bool
252
253	// A value that specifies the order in which a Read Replica is promoted to the
254	// primary instance after a failure of the existing primary instance.
255	PromotionTier *int32
256}
257
258// Contains status information for a DB cluster option group.
259type DBClusterOptionGroupStatus struct {
260
261	// Specifies the name of the DB cluster option group.
262	DBClusterOptionGroupName *string
263
264	// Specifies the status of the DB cluster option group.
265	Status *string
266}
267
268// Contains the details of an Amazon Neptune DB cluster parameter group. This data
269// type is used as a response element in the DescribeDBClusterParameterGroups
270// action.
271type DBClusterParameterGroup struct {
272
273	// The Amazon Resource Name (ARN) for the DB cluster parameter group.
274	DBClusterParameterGroupArn *string
275
276	// Provides the name of the DB cluster parameter group.
277	DBClusterParameterGroupName *string
278
279	// Provides the name of the DB parameter group family that this DB cluster
280	// parameter group is compatible with.
281	DBParameterGroupFamily *string
282
283	// Provides the customer-specified description for this DB cluster parameter group.
284	Description *string
285}
286
287// Describes an AWS Identity and Access Management (IAM) role that is associated
288// with a DB cluster.
289type DBClusterRole struct {
290
291	// The name of the feature associated with the AWS Identity and Access Management
292	// (IAM) role. For the list of supported feature names, see DBEngineVersion.
293	FeatureName *string
294
295	// The Amazon Resource Name (ARN) of the IAM role that is associated with the DB
296	// cluster.
297	RoleArn *string
298
299	// Describes the state of association between the IAM role and the DB cluster. The
300	// Status property returns one of the following values:
301	//
302	// * ACTIVE - the IAM role
303	// ARN is associated with the DB cluster and can be used to access other AWS
304	// services on your behalf.
305	//
306	// * PENDING - the IAM role ARN is being associated with
307	// the DB cluster.
308	//
309	// * INVALID - the IAM role ARN is associated with the DB cluster,
310	// but the DB cluster is unable to assume the IAM role in order to access other AWS
311	// services on your behalf.
312	Status *string
313}
314
315// Contains the details for an Amazon Neptune DB cluster snapshot This data type is
316// used as a response element in the DescribeDBClusterSnapshots action.
317type DBClusterSnapshot struct {
318
319	// Specifies the allocated storage size in gibibytes (GiB).
320	AllocatedStorage int32
321
322	// Provides the list of EC2 Availability Zones that instances in the DB cluster
323	// snapshot can be restored in.
324	AvailabilityZones []string
325
326	// Specifies the time when the DB cluster was created, in Universal Coordinated
327	// Time (UTC).
328	ClusterCreateTime *time.Time
329
330	// Specifies the DB cluster identifier of the DB cluster that this DB cluster
331	// snapshot was created from.
332	DBClusterIdentifier *string
333
334	// The Amazon Resource Name (ARN) for the DB cluster snapshot.
335	DBClusterSnapshotArn *string
336
337	// Specifies the identifier for a DB cluster snapshot. Must match the identifier of
338	// an existing snapshot. After you restore a DB cluster using a
339	// DBClusterSnapshotIdentifier, you must specify the same
340	// DBClusterSnapshotIdentifier for any future updates to the DB cluster. When you
341	// specify this property for an update, the DB cluster is not restored from the
342	// snapshot again, and the data in the database is not changed. However, if you
343	// don't specify the DBClusterSnapshotIdentifier, an empty DB cluster is created,
344	// and the original DB cluster is deleted. If you specify a property that is
345	// different from the previous snapshot restore property, the DB cluster is
346	// restored from the snapshot specified by the DBClusterSnapshotIdentifier, and the
347	// original DB cluster is deleted.
348	DBClusterSnapshotIdentifier *string
349
350	// Specifies the name of the database engine.
351	Engine *string
352
353	// Provides the version of the database engine for this DB cluster snapshot.
354	EngineVersion *string
355
356	// True if mapping of AWS Identity and Access Management (IAM) accounts to database
357	// accounts is enabled, and otherwise false.
358	IAMDatabaseAuthenticationEnabled bool
359
360	// If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB
361	// cluster snapshot.
362	KmsKeyId *string
363
364	// Provides the license model information for this DB cluster snapshot.
365	LicenseModel *string
366
367	// Provides the master username for the DB cluster snapshot.
368	MasterUsername *string
369
370	// Specifies the percentage of the estimated data that has been transferred.
371	PercentProgress int32
372
373	// Specifies the port that the DB cluster was listening on at the time of the
374	// snapshot.
375	Port int32
376
377	// Provides the time when the snapshot was taken, in Universal Coordinated Time
378	// (UTC).
379	SnapshotCreateTime *time.Time
380
381	// Provides the type of the DB cluster snapshot.
382	SnapshotType *string
383
384	// If the DB cluster snapshot was copied from a source DB cluster snapshot, the
385	// Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null
386	// value.
387	SourceDBClusterSnapshotArn *string
388
389	// Specifies the status of this DB cluster snapshot.
390	Status *string
391
392	// Specifies whether the DB cluster snapshot is encrypted.
393	StorageEncrypted bool
394
395	// Provides the VPC ID associated with the DB cluster snapshot.
396	VpcId *string
397}
398
399// Contains the name and values of a manual DB cluster snapshot attribute. Manual
400// DB cluster snapshot attributes are used to authorize other AWS accounts to
401// restore a manual DB cluster snapshot. For more information, see the
402// ModifyDBClusterSnapshotAttribute API action.
403type DBClusterSnapshotAttribute struct {
404
405	// The name of the manual DB cluster snapshot attribute. The attribute named
406	// restore refers to the list of AWS accounts that have permission to copy or
407	// restore the manual DB cluster snapshot. For more information, see the
408	// ModifyDBClusterSnapshotAttribute API action.
409	AttributeName *string
410
411	// The value(s) for the manual DB cluster snapshot attribute. If the AttributeName
412	// field is set to restore, then this element returns a list of IDs of the AWS
413	// accounts that are authorized to copy or restore the manual DB cluster snapshot.
414	// If a value of all is in the list, then the manual DB cluster snapshot is public
415	// and available for any AWS account to copy or restore.
416	AttributeValues []string
417}
418
419// Contains the results of a successful call to the
420// DescribeDBClusterSnapshotAttributes API action. Manual DB cluster snapshot
421// attributes are used to authorize other AWS accounts to copy or restore a manual
422// DB cluster snapshot. For more information, see the
423// ModifyDBClusterSnapshotAttribute API action.
424type DBClusterSnapshotAttributesResult struct {
425
426	// The list of attributes and values for the manual DB cluster snapshot.
427	DBClusterSnapshotAttributes []DBClusterSnapshotAttribute
428
429	// The identifier of the manual DB cluster snapshot that the attributes apply to.
430	DBClusterSnapshotIdentifier *string
431}
432
433// This data type is used as a response element in the action
434// DescribeDBEngineVersions.
435type DBEngineVersion struct {
436
437	// The description of the database engine.
438	DBEngineDescription *string
439
440	// The description of the database engine version.
441	DBEngineVersionDescription *string
442
443	// The name of the DB parameter group family for the database engine.
444	DBParameterGroupFamily *string
445
446	// (Not supported by Neptune)
447	DefaultCharacterSet *CharacterSet
448
449	// The name of the database engine.
450	Engine *string
451
452	// The version number of the database engine.
453	EngineVersion *string
454
455	// The types of logs that the database engine has available for export to
456	// CloudWatch Logs.
457	ExportableLogTypes []string
458
459	// (Not supported by Neptune)
460	SupportedCharacterSets []CharacterSet
461
462	// A list of the time zones supported by this engine for the Timezone parameter of
463	// the CreateDBInstance action.
464	SupportedTimezones []Timezone
465
466	// A value that indicates whether the engine version supports exporting the log
467	// types specified by ExportableLogTypes to CloudWatch Logs.
468	SupportsLogExportsToCloudwatchLogs bool
469
470	// Indicates whether the database engine version supports read replicas.
471	SupportsReadReplica bool
472
473	// A list of engine versions that this database engine version can be upgraded to.
474	ValidUpgradeTarget []UpgradeTarget
475}
476
477// Contains the details of an Amazon Neptune DB instance. This data type is used as
478// a response element in the DescribeDBInstances action.
479type DBInstance struct {
480
481	// Specifies the allocated storage size specified in gibibytes.
482	AllocatedStorage int32
483
484	// Indicates that minor version patches are applied automatically.
485	AutoMinorVersionUpgrade bool
486
487	// Specifies the name of the Availability Zone the DB instance is located in.
488	AvailabilityZone *string
489
490	// Specifies the number of days for which automatic DB snapshots are retained.
491	BackupRetentionPeriod int32
492
493	// The identifier of the CA certificate for this DB instance.
494	CACertificateIdentifier *string
495
496	// (Not supported by Neptune)
497	CharacterSetName *string
498
499	// Specifies whether tags are copied from the DB instance to snapshots of the DB
500	// instance.
501	CopyTagsToSnapshot bool
502
503	// If the DB instance is a member of a DB cluster, contains the name of the DB
504	// cluster that the DB instance is a member of.
505	DBClusterIdentifier *string
506
507	// The Amazon Resource Name (ARN) for the DB instance.
508	DBInstanceArn *string
509
510	// Contains the name of the compute and memory capacity class of the DB instance.
511	DBInstanceClass *string
512
513	// Contains a user-supplied database identifier. This identifier is the unique key
514	// that identifies a DB instance.
515	DBInstanceIdentifier *string
516
517	// Specifies the current state of this database.
518	DBInstanceStatus *string
519
520	// The database name.
521	DBName *string
522
523	// Provides the list of DB parameter groups applied to this DB instance.
524	DBParameterGroups []DBParameterGroupStatus
525
526	// Provides List of DB security group elements containing only DBSecurityGroup.Name
527	// and DBSecurityGroup.Status subelements.
528	DBSecurityGroups []DBSecurityGroupMembership
529
530	// Specifies information on the subnet group associated with the DB instance,
531	// including the name, description, and subnets in the subnet group.
532	DBSubnetGroup *DBSubnetGroup
533
534	// Specifies the port that the DB instance listens on. If the DB instance is part
535	// of a DB cluster, this can be a different port than the DB cluster port.
536	DbInstancePort int32
537
538	// The AWS Region-unique, immutable identifier for the DB instance. This identifier
539	// is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB
540	// instance is accessed.
541	DbiResourceId *string
542
543	// Indicates whether or not the DB instance has deletion protection enabled. The
544	// instance can't be deleted when deletion protection is enabled. See Deleting a DB
545	// Instance
546	// (https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-instances-delete.html).
547	DeletionProtection *bool
548
549	// Not supported
550	DomainMemberships []DomainMembership
551
552	// A list of log types that this DB instance is configured to export to CloudWatch
553	// Logs.
554	EnabledCloudwatchLogsExports []string
555
556	// Specifies the connection endpoint.
557	Endpoint *Endpoint
558
559	// Provides the name of the database engine to be used for this DB instance.
560	Engine *string
561
562	// Indicates the database engine version.
563	EngineVersion *string
564
565	// The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that
566	// receives the Enhanced Monitoring metrics data for the DB instance.
567	EnhancedMonitoringResourceArn *string
568
569	// True if AWS Identity and Access Management (IAM) authentication is enabled, and
570	// otherwise false.
571	IAMDatabaseAuthenticationEnabled bool
572
573	// Provides the date and time the DB instance was created.
574	InstanceCreateTime *time.Time
575
576	// Specifies the Provisioned IOPS (I/O operations per second) value.
577	Iops *int32
578
579	// Not supported: The encryption for DB instances is managed by the DB cluster.
580	KmsKeyId *string
581
582	// Specifies the latest time to which a database can be restored with point-in-time
583	// restore.
584	LatestRestorableTime *time.Time
585
586	// License model information for this DB instance.
587	LicenseModel *string
588
589	// Contains the master username for the DB instance.
590	MasterUsername *string
591
592	// The interval, in seconds, between points when Enhanced Monitoring metrics are
593	// collected for the DB instance.
594	MonitoringInterval *int32
595
596	// The ARN for the IAM role that permits Neptune to send Enhanced Monitoring
597	// metrics to Amazon CloudWatch Logs.
598	MonitoringRoleArn *string
599
600	// Specifies if the DB instance is a Multi-AZ deployment.
601	MultiAZ bool
602
603	// (Not supported by Neptune)
604	OptionGroupMemberships []OptionGroupMembership
605
606	// Specifies that changes to the DB instance are pending. This element is only
607	// included when changes are pending. Specific changes are identified by
608	// subelements.
609	PendingModifiedValues *PendingModifiedValues
610
611	// (Not supported by Neptune)
612	PerformanceInsightsEnabled *bool
613
614	// (Not supported by Neptune)
615	PerformanceInsightsKMSKeyId *string
616
617	// Specifies the daily time range during which automated backups are created if
618	// automated backups are enabled, as determined by the BackupRetentionPeriod.
619	PreferredBackupWindow *string
620
621	// Specifies the weekly time range during which system maintenance can occur, in
622	// Universal Coordinated Time (UTC).
623	PreferredMaintenanceWindow *string
624
625	// A value that specifies the order in which a Read Replica is promoted to the
626	// primary instance after a failure of the existing primary instance.
627	PromotionTier *int32
628
629	// This flag should no longer be used.
630	//
631	// Deprecated: This member has been deprecated.
632	PubliclyAccessible bool
633
634	// Contains one or more identifiers of DB clusters that are Read Replicas of this
635	// DB instance.
636	ReadReplicaDBClusterIdentifiers []string
637
638	// Contains one or more identifiers of the Read Replicas associated with this DB
639	// instance.
640	ReadReplicaDBInstanceIdentifiers []string
641
642	// Contains the identifier of the source DB instance if this DB instance is a Read
643	// Replica.
644	ReadReplicaSourceDBInstanceIdentifier *string
645
646	// If present, specifies the name of the secondary Availability Zone for a DB
647	// instance with multi-AZ support.
648	SecondaryAvailabilityZone *string
649
650	// The status of a Read Replica. If the instance is not a Read Replica, this is
651	// blank.
652	StatusInfos []DBInstanceStatusInfo
653
654	// Not supported: The encryption for DB instances is managed by the DB cluster.
655	StorageEncrypted bool
656
657	// Specifies the storage type associated with DB instance.
658	StorageType *string
659
660	// The ARN from the key store with which the instance is associated for TDE
661	// encryption.
662	TdeCredentialArn *string
663
664	// Not supported.
665	Timezone *string
666
667	// Provides a list of VPC security group elements that the DB instance belongs to.
668	VpcSecurityGroups []VpcSecurityGroupMembership
669}
670
671// Provides a list of status information for a DB instance.
672type DBInstanceStatusInfo struct {
673
674	// Details of the error if there is an error for the instance. If the instance is
675	// not in an error state, this value is blank.
676	Message *string
677
678	// Boolean value that is true if the instance is operating normally, or false if
679	// the instance is in an error state.
680	Normal bool
681
682	// Status of the DB instance. For a StatusType of read replica, the values can be
683	// replicating, error, stopped, or terminated.
684	Status *string
685
686	// This value is currently "read replication."
687	StatusType *string
688}
689
690// Contains the details of an Amazon Neptune DB parameter group. This data type is
691// used as a response element in the DescribeDBParameterGroups action.
692type DBParameterGroup struct {
693
694	// The Amazon Resource Name (ARN) for the DB parameter group.
695	DBParameterGroupArn *string
696
697	// Provides the name of the DB parameter group family that this DB parameter group
698	// is compatible with.
699	DBParameterGroupFamily *string
700
701	// Provides the name of the DB parameter group.
702	DBParameterGroupName *string
703
704	// Provides the customer-specified description for this DB parameter group.
705	Description *string
706}
707
708// The status of the DB parameter group. This data type is used as a response
709// element in the following actions:
710//
711// * CreateDBInstance
712//
713// * DeleteDBInstance
714//
715// *
716// ModifyDBInstance
717//
718// * RebootDBInstance
719type DBParameterGroupStatus struct {
720
721	// The name of the DP parameter group.
722	DBParameterGroupName *string
723
724	// The status of parameter updates.
725	ParameterApplyStatus *string
726}
727
728// Specifies membership in a designated DB security group.
729type DBSecurityGroupMembership struct {
730
731	// The name of the DB security group.
732	DBSecurityGroupName *string
733
734	// The status of the DB security group.
735	Status *string
736}
737
738// Contains the details of an Amazon Neptune DB subnet group. This data type is
739// used as a response element in the DescribeDBSubnetGroups action.
740type DBSubnetGroup struct {
741
742	// The Amazon Resource Name (ARN) for the DB subnet group.
743	DBSubnetGroupArn *string
744
745	// Provides the description of the DB subnet group.
746	DBSubnetGroupDescription *string
747
748	// The name of the DB subnet group.
749	DBSubnetGroupName *string
750
751	// Provides the status of the DB subnet group.
752	SubnetGroupStatus *string
753
754	// Contains a list of Subnet elements.
755	Subnets []Subnet
756
757	// Provides the VpcId of the DB subnet group.
758	VpcId *string
759}
760
761// An Active Directory Domain membership record associated with a DB instance.
762type DomainMembership struct {
763
764	// The identifier of the Active Directory Domain.
765	Domain *string
766
767	// The fully qualified domain name of the Active Directory Domain.
768	FQDN *string
769
770	// The name of the IAM role to be used when making API calls to the Directory
771	// Service.
772	IAMRoleName *string
773
774	// The status of the DB instance's Active Directory Domain membership, such as
775	// joined, pending-join, failed etc).
776	Status *string
777}
778
779// A range of double values.
780type DoubleRange struct {
781
782	// The minimum value in the range.
783	From float64
784
785	// The maximum value in the range.
786	To float64
787}
788
789// Specifies a connection endpoint. For the data structure that represents Amazon
790// Neptune DB cluster endpoints, see DBClusterEndpoint.
791type Endpoint struct {
792
793	// Specifies the DNS address of the DB instance.
794	Address *string
795
796	// Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
797	HostedZoneId *string
798
799	// Specifies the port that the database engine is listening on.
800	Port int32
801}
802
803// Contains the result of a successful invocation of the
804// DescribeEngineDefaultParameters action.
805type EngineDefaults struct {
806
807	// Specifies the name of the DB parameter group family that the engine default
808	// parameters apply to.
809	DBParameterGroupFamily *string
810
811	// An optional pagination token provided by a previous EngineDefaults request. If
812	// this parameter is specified, the response includes only records beyond the
813	// marker, up to the value specified by MaxRecords .
814	Marker *string
815
816	// Contains a list of engine default parameters.
817	Parameters []Parameter
818}
819
820// This data type is used as a response element in the DescribeEvents action.
821type Event struct {
822
823	// Specifies the date and time of the event.
824	Date *time.Time
825
826	// Specifies the category for the event.
827	EventCategories []string
828
829	// Provides the text of this event.
830	Message *string
831
832	// The Amazon Resource Name (ARN) for the event.
833	SourceArn *string
834
835	// Provides the identifier for the source of the event.
836	SourceIdentifier *string
837
838	// Specifies the source type for this event.
839	SourceType SourceType
840}
841
842// Contains the results of a successful invocation of the DescribeEventCategories
843// action.
844type EventCategoriesMap struct {
845
846	// The event categories for the specified source type
847	EventCategories []string
848
849	// The source type that the returned categories belong to
850	SourceType *string
851}
852
853// Contains the results of a successful invocation of the
854// DescribeEventSubscriptions action.
855type EventSubscription struct {
856
857	// The event notification subscription Id.
858	CustSubscriptionId *string
859
860	// The AWS customer account associated with the event notification subscription.
861	CustomerAwsId *string
862
863	// A Boolean value indicating if the subscription is enabled. True indicates the
864	// subscription is enabled.
865	Enabled bool
866
867	// A list of event categories for the event notification subscription.
868	EventCategoriesList []string
869
870	// The Amazon Resource Name (ARN) for the event subscription.
871	EventSubscriptionArn *string
872
873	// The topic ARN of the event notification subscription.
874	SnsTopicArn *string
875
876	// A list of source IDs for the event notification subscription.
877	SourceIdsList []string
878
879	// The source type for the event notification subscription.
880	SourceType *string
881
882	// The status of the event notification subscription. Constraints: Can be one of
883	// the following: creating | modifying | deleting | active | no-permission |
884	// topic-not-exist The status "no-permission" indicates that Neptune no longer has
885	// permission to post to the SNS topic. The status "topic-not-exist" indicates that
886	// the topic was deleted after the subscription was created.
887	Status *string
888
889	// The time the event notification subscription was created.
890	SubscriptionCreationTime *string
891}
892
893// This type is not currently supported.
894type Filter struct {
895
896	// This parameter is not currently supported.
897	//
898	// This member is required.
899	Name *string
900
901	// This parameter is not currently supported.
902	//
903	// This member is required.
904	Values []string
905}
906
907// Provides information on the option groups the DB instance is a member of.
908type OptionGroupMembership struct {
909
910	// The name of the option group that the instance belongs to.
911	OptionGroupName *string
912
913	// The status of the DB instance's option group membership. Valid values are:
914	// in-sync, pending-apply, pending-removal, pending-maintenance-apply,
915	// pending-maintenance-removal, applying, removing, and failed.
916	Status *string
917}
918
919// Contains a list of available options for a DB instance. This data type is used
920// as a response element in the DescribeOrderableDBInstanceOptions action.
921type OrderableDBInstanceOption struct {
922
923	// A list of Availability Zones for a DB instance.
924	AvailabilityZones []AvailabilityZone
925
926	// The DB instance class for a DB instance.
927	DBInstanceClass *string
928
929	// The engine type of a DB instance.
930	Engine *string
931
932	// The engine version of a DB instance.
933	EngineVersion *string
934
935	// The license model for a DB instance.
936	LicenseModel *string
937
938	// Maximum total provisioned IOPS for a DB instance.
939	MaxIopsPerDbInstance *int32
940
941	// Maximum provisioned IOPS per GiB for a DB instance.
942	MaxIopsPerGib *float64
943
944	// Maximum storage size for a DB instance.
945	MaxStorageSize *int32
946
947	// Minimum total provisioned IOPS for a DB instance.
948	MinIopsPerDbInstance *int32
949
950	// Minimum provisioned IOPS per GiB for a DB instance.
951	MinIopsPerGib *float64
952
953	// Minimum storage size for a DB instance.
954	MinStorageSize *int32
955
956	// Indicates whether a DB instance is Multi-AZ capable.
957	MultiAZCapable bool
958
959	// Indicates whether a DB instance can have a Read Replica.
960	ReadReplicaCapable bool
961
962	// Indicates the storage type for a DB instance.
963	StorageType *string
964
965	// Indicates whether a DB instance supports Enhanced Monitoring at intervals from 1
966	// to 60 seconds.
967	SupportsEnhancedMonitoring bool
968
969	// Indicates whether a DB instance supports IAM database authentication.
970	SupportsIAMDatabaseAuthentication bool
971
972	// Indicates whether a DB instance supports provisioned IOPS.
973	SupportsIops bool
974
975	// (Not supported by Neptune)
976	SupportsPerformanceInsights bool
977
978	// Indicates whether a DB instance supports encrypted storage.
979	SupportsStorageEncryption bool
980
981	// Indicates whether a DB instance is in a VPC.
982	Vpc bool
983}
984
985// Specifies a parameter.
986type Parameter struct {
987
988	// Specifies the valid range of values for the parameter.
989	AllowedValues *string
990
991	// Indicates when to apply parameter updates.
992	ApplyMethod ApplyMethod
993
994	// Specifies the engine specific parameters type.
995	ApplyType *string
996
997	// Specifies the valid data type for the parameter.
998	DataType *string
999
1000	// Provides a description of the parameter.
1001	Description *string
1002
1003	// Indicates whether (true) or not (false) the parameter can be modified. Some
1004	// parameters have security or operational implications that prevent them from
1005	// being changed.
1006	IsModifiable bool
1007
1008	// The earliest engine version to which the parameter can apply.
1009	MinimumEngineVersion *string
1010
1011	// Specifies the name of the parameter.
1012	ParameterName *string
1013
1014	// Specifies the value of the parameter.
1015	ParameterValue *string
1016
1017	// Indicates the source of the parameter value.
1018	Source *string
1019}
1020
1021// A list of the log types whose configuration is still pending. In other words,
1022// these log types are in the process of being activated or deactivated.
1023type PendingCloudwatchLogsExports struct {
1024
1025	// Log types that are in the process of being enabled. After they are enabled,
1026	// these log types are exported to CloudWatch Logs.
1027	LogTypesToDisable []string
1028
1029	// Log types that are in the process of being deactivated. After they are
1030	// deactivated, these log types aren't exported to CloudWatch Logs.
1031	LogTypesToEnable []string
1032}
1033
1034// Provides information about a pending maintenance action for a resource.
1035type PendingMaintenanceAction struct {
1036
1037	// The type of pending maintenance action that is available for the resource.
1038	Action *string
1039
1040	// The date of the maintenance window when the action is applied. The maintenance
1041	// action is applied to the resource during its first maintenance window after this
1042	// date. If this date is specified, any next-maintenance opt-in requests are
1043	// ignored.
1044	AutoAppliedAfterDate *time.Time
1045
1046	// The effective date when the pending maintenance action is applied to the
1047	// resource. This date takes into account opt-in requests received from the
1048	// ApplyPendingMaintenanceAction API, the AutoAppliedAfterDate, and the
1049	// ForcedApplyDate. This value is blank if an opt-in request has not been received
1050	// and nothing has been specified as AutoAppliedAfterDate or ForcedApplyDate.
1051	CurrentApplyDate *time.Time
1052
1053	// A description providing more detail about the maintenance action.
1054	Description *string
1055
1056	// The date when the maintenance action is automatically applied. The maintenance
1057	// action is applied to the resource on this date regardless of the maintenance
1058	// window for the resource. If this date is specified, any immediate opt-in
1059	// requests are ignored.
1060	ForcedApplyDate *time.Time
1061
1062	// Indicates the type of opt-in request that has been received for the resource.
1063	OptInStatus *string
1064}
1065
1066// This data type is used as a response element in the ModifyDBInstance action.
1067type PendingModifiedValues struct {
1068
1069	// Contains the new AllocatedStorage size for the DB instance that will be applied
1070	// or is currently being applied.
1071	AllocatedStorage *int32
1072
1073	// Specifies the pending number of days for which automated backups are retained.
1074	BackupRetentionPeriod *int32
1075
1076	// Specifies the identifier of the CA certificate for the DB instance.
1077	CACertificateIdentifier *string
1078
1079	// Contains the new DBInstanceClass for the DB instance that will be applied or is
1080	// currently being applied.
1081	DBInstanceClass *string
1082
1083	// Contains the new DBInstanceIdentifier for the DB instance that will be applied
1084	// or is currently being applied.
1085	DBInstanceIdentifier *string
1086
1087	// The new DB subnet group for the DB instance.
1088	DBSubnetGroupName *string
1089
1090	// Indicates the database engine version.
1091	EngineVersion *string
1092
1093	// Specifies the new Provisioned IOPS value for the DB instance that will be
1094	// applied or is currently being applied.
1095	Iops *int32
1096
1097	// The license model for the DB instance. Valid values: license-included |
1098	// bring-your-own-license | general-public-license
1099	LicenseModel *string
1100
1101	// Contains the pending or currently-in-progress change of the master credentials
1102	// for the DB instance.
1103	MasterUserPassword *string
1104
1105	// Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.
1106	MultiAZ *bool
1107
1108	// This PendingCloudwatchLogsExports structure specifies pending changes to which
1109	// CloudWatch logs are enabled and which are disabled.
1110	PendingCloudwatchLogsExports *PendingCloudwatchLogsExports
1111
1112	// Specifies the pending port for the DB instance.
1113	Port *int32
1114
1115	// Specifies the storage type to be associated with the DB instance.
1116	StorageType *string
1117}
1118
1119// A range of integer values.
1120type Range struct {
1121
1122	// The minimum value in the range.
1123	From int32
1124
1125	// The step value for the range. For example, if you have a range of 5,000 to
1126	// 10,000, with a step value of 1,000, the valid values start at 5,000 and step up
1127	// by 1,000. Even though 7,500 is within the range, it isn't a valid value for the
1128	// range. The valid values are 5,000, 6,000, 7,000, 8,000...
1129	Step *int32
1130
1131	// The maximum value in the range.
1132	To int32
1133}
1134
1135// Describes the pending maintenance actions for a resource.
1136type ResourcePendingMaintenanceActions struct {
1137
1138	// A list that provides details about the pending maintenance actions for the
1139	// resource.
1140	PendingMaintenanceActionDetails []PendingMaintenanceAction
1141
1142	// The ARN of the resource that has pending maintenance actions.
1143	ResourceIdentifier *string
1144}
1145
1146// Specifies a subnet. This data type is used as a response element in the
1147// DescribeDBSubnetGroups action.
1148type Subnet struct {
1149
1150	// Specifies the EC2 Availability Zone that the subnet is in.
1151	SubnetAvailabilityZone *AvailabilityZone
1152
1153	// Specifies the identifier of the subnet.
1154	SubnetIdentifier *string
1155
1156	// Specifies the status of the subnet.
1157	SubnetStatus *string
1158}
1159
1160// Metadata assigned to an Amazon Neptune resource consisting of a key-value pair.
1161type Tag struct {
1162
1163	// A key is the required name of the tag. The string value can be from 1 to 128
1164	// Unicode characters in length and can't be prefixed with "aws:" or "rds:". The
1165	// string can only contain only the set of Unicode letters, digits, white-space,
1166	// '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").
1167	Key *string
1168
1169	// A value is the optional value of the tag. The string value can be from 1 to 256
1170	// Unicode characters in length and can't be prefixed with "aws:" or "rds:". The
1171	// string can only contain only the set of Unicode letters, digits, white-space,
1172	// '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").
1173	Value *string
1174}
1175
1176// A time zone associated with a DBInstance.
1177type Timezone struct {
1178
1179	// The name of the time zone.
1180	TimezoneName *string
1181}
1182
1183// The version of the database engine that a DB instance can be upgraded to.
1184type UpgradeTarget struct {
1185
1186	// A value that indicates whether the target version is applied to any source DB
1187	// instances that have AutoMinorVersionUpgrade set to true.
1188	AutoUpgrade bool
1189
1190	// The version of the database engine that a DB instance can be upgraded to.
1191	Description *string
1192
1193	// The name of the upgrade target database engine.
1194	Engine *string
1195
1196	// The version number of the upgrade target database engine.
1197	EngineVersion *string
1198
1199	// A value that indicates whether a database engine is upgraded to a major version.
1200	IsMajorVersionUpgrade bool
1201}
1202
1203// Information about valid modifications that you can make to your DB instance.
1204// Contains the result of a successful call to the
1205// DescribeValidDBInstanceModifications action. You can use this information when
1206// you call ModifyDBInstance.
1207type ValidDBInstanceModificationsMessage struct {
1208
1209	// Valid storage options for your DB instance.
1210	Storage []ValidStorageOptions
1211}
1212
1213// Information about valid modifications that you can make to your DB instance.
1214// Contains the result of a successful call to the
1215// DescribeValidDBInstanceModifications action.
1216type ValidStorageOptions struct {
1217
1218	// The valid range of Provisioned IOPS to gibibytes of storage multiplier. For
1219	// example, 3-10, which means that provisioned IOPS can be between 3 and 10 times
1220	// storage.
1221	IopsToStorageRatio []DoubleRange
1222
1223	// The valid range of provisioned IOPS. For example, 1000-20000.
1224	ProvisionedIops []Range
1225
1226	// The valid range of storage in gibibytes. For example, 100 to 16384.
1227	StorageSize []Range
1228
1229	// The valid storage types for your DB instance. For example, gp2, io1.
1230	StorageType *string
1231}
1232
1233// This data type is used as a response element for queries on VPC security group
1234// membership.
1235type VpcSecurityGroupMembership struct {
1236
1237	// The status of the VPC security group.
1238	Status *string
1239
1240	// The name of the VPC security group.
1241	VpcSecurityGroupId *string
1242}
1243