dataawsdbinstance

README

data_aws_db_instance

Refer to the Terraform Registory for docs: data_aws_db_instance.

Documentation

Index

• func DataAwsDbInstance_IsConstruct(x interface{}) *bool
• func DataAwsDbInstance_IsTerraformDataSource(x interface{}) *bool
• func DataAwsDbInstance_IsTerraformElement(x interface{}) *bool
• func DataAwsDbInstance_TfResourceType() *string
• func NewDataAwsDbInstanceMasterUserSecretList_Override(d DataAwsDbInstanceMasterUserSecretList, ...)
• func NewDataAwsDbInstanceMasterUserSecretOutputReference_Override(d DataAwsDbInstanceMasterUserSecretOutputReference, ...)
• func NewDataAwsDbInstance_Override(d DataAwsDbInstance, scope constructs.Construct, id *string, ...)
• type DataAwsDbInstance
  • func NewDataAwsDbInstance(scope constructs.Construct, id *string, config *DataAwsDbInstanceConfig) DataAwsDbInstance
• type DataAwsDbInstanceConfig
• type DataAwsDbInstanceMasterUserSecret
• type DataAwsDbInstanceMasterUserSecretList
  • func NewDataAwsDbInstanceMasterUserSecretList(terraformResource cdktf.IInterpolatingParent, terraformAttribute *string, ...) DataAwsDbInstanceMasterUserSecretList
• type DataAwsDbInstanceMasterUserSecretOutputReference
  • func NewDataAwsDbInstanceMasterUserSecretOutputReference(terraformResource cdktf.IInterpolatingParent, terraformAttribute *string, ...) DataAwsDbInstanceMasterUserSecretOutputReference

Functions

func DataAwsDbInstance_IsConstruct

func DataAwsDbInstance_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.

Returns: true if `x` is an object created from a class which extends `Construct`.

func DataAwsDbInstance_IsTerraformDataSource

func DataAwsDbInstance_IsTerraformDataSource(x interface{}) *bool

Experimental.

func DataAwsDbInstance_IsTerraformElement

func DataAwsDbInstance_IsTerraformElement(x interface{}) *bool

Experimental.

func DataAwsDbInstance_TfResourceType

func DataAwsDbInstance_TfResourceType() *string

func NewDataAwsDbInstanceMasterUserSecretList_Override

func NewDataAwsDbInstanceMasterUserSecretList_Override(d DataAwsDbInstanceMasterUserSecretList, terraformResource cdktf.IInterpolatingParent, terraformAttribute *string, wrapsSet *bool)

func NewDataAwsDbInstanceMasterUserSecretOutputReference_Override

func NewDataAwsDbInstanceMasterUserSecretOutputReference_Override(d DataAwsDbInstanceMasterUserSecretOutputReference, terraformResource cdktf.IInterpolatingParent, terraformAttribute *string, complexObjectIndex *float64, complexObjectIsFromSet *bool)

func NewDataAwsDbInstance_Override

func NewDataAwsDbInstance_Override(d DataAwsDbInstance, scope constructs.Construct, id *string, config *DataAwsDbInstanceConfig)

Create a new {@link https://registry.terraform.io/providers/hashicorp/aws/5.21.0/docs/data-sources/db_instance aws_db_instance} Data Source.

Types

type DataAwsDbInstance

type DataAwsDbInstance interface {
	cdktf.TerraformDataSource
	Address() *string
	AllocatedStorage() *float64
	AutoMinorVersionUpgrade() cdktf.IResolvable
	AvailabilityZone() *string
	BackupRetentionPeriod() *float64
	CaCertIdentifier() *string
	// Experimental.
	CdktfStack() cdktf.TerraformStack
	// Experimental.
	ConstructNodeMetadata() *map[string]interface{}
	// Experimental.
	Count() interface{}
	// Experimental.
	SetCount(val interface{})
	DbClusterIdentifier() *string
	DbInstanceArn() *string
	DbInstanceClass() *string
	DbInstanceIdentifier() *string
	SetDbInstanceIdentifier(val *string)
	DbInstanceIdentifierInput() *string
	DbInstancePort() *float64
	DbName() *string
	DbParameterGroups() *[]*string
	DbSubnetGroup() *string
	// Experimental.
	DependsOn() *[]*string
	// Experimental.
	SetDependsOn(val *[]*string)
	EnabledCloudwatchLogsExports() *[]*string
	Endpoint() *string
	Engine() *string
	EngineVersion() *string
	// Experimental.
	ForEach() cdktf.ITerraformIterator
	// Experimental.
	SetForEach(val cdktf.ITerraformIterator)
	// Experimental.
	Fqn() *string
	// Experimental.
	FriendlyUniqueId() *string
	HostedZoneId() *string
	Id() *string
	SetId(val *string)
	IdInput() *string
	Iops() *float64
	KmsKeyId() *string
	LicenseModel() *string
	// Experimental.
	Lifecycle() *cdktf.TerraformResourceLifecycle
	// Experimental.
	SetLifecycle(val *cdktf.TerraformResourceLifecycle)
	MasterUsername() *string
	MasterUserSecret() DataAwsDbInstanceMasterUserSecretList
	MaxAllocatedStorage() *float64
	MonitoringInterval() *float64
	MonitoringRoleArn() *string
	MultiAz() cdktf.IResolvable
	NetworkType() *string
	// The tree node.
	Node() constructs.Node
	OptionGroupMemberships() *[]*string
	Port() *float64
	PreferredBackupWindow() *string
	PreferredMaintenanceWindow() *string
	// Experimental.
	Provider() cdktf.TerraformProvider
	// Experimental.
	SetProvider(val cdktf.TerraformProvider)
	PubliclyAccessible() cdktf.IResolvable
	// Experimental.
	RawOverrides() interface{}
	ReplicateSourceDb() *string
	ResourceId() *string
	StorageEncrypted() cdktf.IResolvable
	StorageThroughput() *float64
	StorageType() *string
	Tags() *map[string]*string
	SetTags(val *map[string]*string)
	TagsInput() *map[string]*string
	// Experimental.
	TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata
	// Experimental.
	TerraformMetaArguments() *map[string]interface{}
	// Experimental.
	TerraformResourceType() *string
	Timezone() *string
	VpcSecurityGroups() *[]*string
	// Experimental.
	AddOverride(path *string, value interface{})
	// Experimental.
	GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
	// Experimental.
	GetBooleanAttribute(terraformAttribute *string) cdktf.IResolvable
	// Experimental.
	GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
	// Experimental.
	GetListAttribute(terraformAttribute *string) *[]*string
	// Experimental.
	GetNumberAttribute(terraformAttribute *string) *float64
	// Experimental.
	GetNumberListAttribute(terraformAttribute *string) *[]*float64
	// Experimental.
	GetNumberMapAttribute(terraformAttribute *string) *map[string]*float64
	// Experimental.
	GetStringAttribute(terraformAttribute *string) *string
	// Experimental.
	GetStringMapAttribute(terraformAttribute *string) *map[string]*string
	// Experimental.
	InterpolationForAttribute(terraformAttribute *string) cdktf.IResolvable
	// Overrides the auto-generated logical ID with a specific ID.
	// Experimental.
	OverrideLogicalId(newLogicalId *string)
	ResetDbInstanceIdentifier()
	ResetId()
	// Resets a previously passed logical Id to use the auto-generated logical id again.
	// Experimental.
	ResetOverrideLogicalId()
	ResetTags()
	SynthesizeAttributes() *map[string]interface{}
	// Experimental.
	ToMetadata() interface{}
	// Returns a string representation of this construct.
	ToString() *string
	// Adds this resource to the terraform JSON output.
	// Experimental.
	ToTerraform() interface{}
}

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/5.21.0/docs/data-sources/db_instance aws_db_instance}.

func NewDataAwsDbInstance

func NewDataAwsDbInstance(scope constructs.Construct, id *string, config *DataAwsDbInstanceConfig) DataAwsDbInstance

Create a new {@link https://registry.terraform.io/providers/hashicorp/aws/5.21.0/docs/data-sources/db_instance aws_db_instance} Data Source.

type DataAwsDbInstanceConfig

type DataAwsDbInstanceConfig struct {
	// Experimental.
	Connection interface{} `field:"optional" json:"connection" yaml:"connection"`
	// Experimental.
	Count interface{} `field:"optional" json:"count" yaml:"count"`
	// Experimental.
	DependsOn *[]cdktf.ITerraformDependable `field:"optional" json:"dependsOn" yaml:"dependsOn"`
	// Experimental.
	ForEach cdktf.ITerraformIterator `field:"optional" json:"forEach" yaml:"forEach"`
	// Experimental.
	Lifecycle *cdktf.TerraformResourceLifecycle `field:"optional" json:"lifecycle" yaml:"lifecycle"`
	// Experimental.
	Provider cdktf.TerraformProvider `field:"optional" json:"provider" yaml:"provider"`
	// Experimental.
	Provisioners *[]interface{} `field:"optional" json:"provisioners" yaml:"provisioners"`
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.21.0/docs/data-sources/db_instance#db_instance_identifier DataAwsDbInstance#db_instance_identifier}.
	DbInstanceIdentifier *string `field:"optional" json:"dbInstanceIdentifier" yaml:"dbInstanceIdentifier"`
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.21.0/docs/data-sources/db_instance#id DataAwsDbInstance#id}.
	//
	// Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2.
	// If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.
	Id *string `field:"optional" json:"id" yaml:"id"`
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.21.0/docs/data-sources/db_instance#tags DataAwsDbInstance#tags}.
	Tags *map[string]*string `field:"optional" json:"tags" yaml:"tags"`
}

type DataAwsDbInstanceMasterUserSecret

type DataAwsDbInstanceMasterUserSecret struct {
}

type DataAwsDbInstanceMasterUserSecretList

type DataAwsDbInstanceMasterUserSecretList interface {
	cdktf.ComplexList
	// The creation stack of this resolvable which will be appended to errors thrown during resolution.
	//
	// If this returns an empty array the stack will not be attached.
	// Experimental.
	CreationStack() *[]*string
	// Experimental.
	Fqn() *string
	// The attribute on the parent resource this class is referencing.
	TerraformAttribute() *string
	SetTerraformAttribute(val *string)
	// The parent resource.
	TerraformResource() cdktf.IInterpolatingParent
	SetTerraformResource(val cdktf.IInterpolatingParent)
	// whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
	WrapsSet() *bool
	SetWrapsSet(val *bool)
	// Experimental.
	ComputeFqn() *string
	Get(index *float64) DataAwsDbInstanceMasterUserSecretOutputReference
	// Produce the Token's value at resolution time.
	// Experimental.
	Resolve(_context cdktf.IResolveContext) interface{}
	// Return a string representation of this resolvable object.
	//
	// Returns a reversible string representation.
	// Experimental.
	ToString() *string
}

func NewDataAwsDbInstanceMasterUserSecretList

func NewDataAwsDbInstanceMasterUserSecretList(terraformResource cdktf.IInterpolatingParent, terraformAttribute *string, wrapsSet *bool) DataAwsDbInstanceMasterUserSecretList

type DataAwsDbInstanceMasterUserSecretOutputReference

type DataAwsDbInstanceMasterUserSecretOutputReference interface {
	cdktf.ComplexObject
	// the index of the complex object in a list.
	// Experimental.
	ComplexObjectIndex() interface{}
	// Experimental.
	SetComplexObjectIndex(val interface{})
	// set to true if this item is from inside a set and needs tolist() for accessing it set to "0" for single list items.
	// Experimental.
	ComplexObjectIsFromSet() *bool
	// Experimental.
	SetComplexObjectIsFromSet(val *bool)
	// The creation stack of this resolvable which will be appended to errors thrown during resolution.
	//
	// If this returns an empty array the stack will not be attached.
	// Experimental.
	CreationStack() *[]*string
	// Experimental.
	Fqn() *string
	InternalValue() *DataAwsDbInstanceMasterUserSecret
	SetInternalValue(val *DataAwsDbInstanceMasterUserSecret)
	KmsKeyId() *string
	SecretArn() *string
	SecretStatus() *string
	// Experimental.
	TerraformAttribute() *string
	// Experimental.
	SetTerraformAttribute(val *string)
	// Experimental.
	TerraformResource() cdktf.IInterpolatingParent
	// Experimental.
	SetTerraformResource(val cdktf.IInterpolatingParent)
	// Experimental.
	ComputeFqn() *string
	// Experimental.
	GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
	// Experimental.
	GetBooleanAttribute(terraformAttribute *string) cdktf.IResolvable
	// Experimental.
	GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
	// Experimental.
	GetListAttribute(terraformAttribute *string) *[]*string
	// Experimental.
	GetNumberAttribute(terraformAttribute *string) *float64
	// Experimental.
	GetNumberListAttribute(terraformAttribute *string) *[]*float64
	// Experimental.
	GetNumberMapAttribute(terraformAttribute *string) *map[string]*float64
	// Experimental.
	GetStringAttribute(terraformAttribute *string) *string
	// Experimental.
	GetStringMapAttribute(terraformAttribute *string) *map[string]*string
	// Experimental.
	InterpolationAsList() cdktf.IResolvable
	// Experimental.
	InterpolationForAttribute(property *string) cdktf.IResolvable
	// Produce the Token's value at resolution time.
	// Experimental.
	Resolve(_context cdktf.IResolveContext) interface{}
	// Return a string representation of this resolvable object.
	//
	// Returns a reversible string representation.
	// Experimental.
	ToString() *string
}

func NewDataAwsDbInstanceMasterUserSecretOutputReference

func NewDataAwsDbInstanceMasterUserSecretOutputReference(terraformResource cdktf.IInterpolatingParent, terraformAttribute *string, complexObjectIndex *float64, complexObjectIsFromSet *bool) DataAwsDbInstanceMasterUserSecretOutputReference