Documentation
¶
Index ¶
- func DocdbCluster_IsConstruct(x interface{}) *bool
- func DocdbCluster_TfResourceType() *string
- func NewDocdbClusterTimeoutsOutputReference_Override(d DocdbClusterTimeoutsOutputReference, ...)
- func NewDocdbCluster_Override(d DocdbCluster, scope constructs.Construct, id *string, ...)
- type DocdbCluster
- type DocdbClusterConfig
- type DocdbClusterTimeouts
- type DocdbClusterTimeoutsOutputReference
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func DocdbCluster_IsConstruct ¶
func DocdbCluster_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 DocdbCluster_TfResourceType ¶
func DocdbCluster_TfResourceType() *string
func NewDocdbClusterTimeoutsOutputReference_Override ¶
func NewDocdbClusterTimeoutsOutputReference_Override(d DocdbClusterTimeoutsOutputReference, terraformResource cdktf.IInterpolatingParent, terraformAttribute *string)
func NewDocdbCluster_Override ¶
func NewDocdbCluster_Override(d DocdbCluster, scope constructs.Construct, id *string, config *DocdbClusterConfig)
Create a new {@link https://www.terraform.io/docs/providers/aws/r/docdb_cluster aws_docdb_cluster} Resource.
Types ¶
type DocdbCluster ¶
type DocdbCluster interface { cdktf.TerraformResource ApplyImmediately() interface{} SetApplyImmediately(val interface{}) ApplyImmediatelyInput() interface{} Arn() *string AvailabilityZones() *[]*string SetAvailabilityZones(val *[]*string) AvailabilityZonesInput() *[]*string BackupRetentionPeriod() *float64 SetBackupRetentionPeriod(val *float64) BackupRetentionPeriodInput() *float64 // Experimental. CdktfStack() cdktf.TerraformStack ClusterIdentifier() *string SetClusterIdentifier(val *string) ClusterIdentifierInput() *string ClusterIdentifierPrefix() *string SetClusterIdentifierPrefix(val *string) ClusterIdentifierPrefixInput() *string ClusterMembers() *[]*string SetClusterMembers(val *[]*string) ClusterMembersInput() *[]*string ClusterResourceId() *string // Experimental. Connection() interface{} // Experimental. SetConnection(val interface{}) // Experimental. ConstructNodeMetadata() *map[string]interface{} // Experimental. Count() *float64 // Experimental. SetCount(val *float64) DbClusterParameterGroupName() *string SetDbClusterParameterGroupName(val *string) DbClusterParameterGroupNameInput() *string DbSubnetGroupName() *string SetDbSubnetGroupName(val *string) DbSubnetGroupNameInput() *string DeletionProtection() interface{} SetDeletionProtection(val interface{}) DeletionProtectionInput() interface{} // Experimental. DependsOn() *[]*string // Experimental. SetDependsOn(val *[]*string) EnabledCloudwatchLogsExports() *[]*string SetEnabledCloudwatchLogsExports(val *[]*string) EnabledCloudwatchLogsExportsInput() *[]*string Endpoint() *string Engine() *string SetEngine(val *string) EngineInput() *string EngineVersion() *string SetEngineVersion(val *string) EngineVersionInput() *string FinalSnapshotIdentifier() *string SetFinalSnapshotIdentifier(val *string) FinalSnapshotIdentifierInput() *string // Experimental. ForEach() cdktf.ITerraformIterator // Experimental. SetForEach(val cdktf.ITerraformIterator) // Experimental. Fqn() *string // Experimental. FriendlyUniqueId() *string GlobalClusterIdentifier() *string SetGlobalClusterIdentifier(val *string) GlobalClusterIdentifierInput() *string HostedZoneId() *string Id() *string SetId(val *string) IdInput() *string KmsKeyId() *string SetKmsKeyId(val *string) KmsKeyIdInput() *string // Experimental. Lifecycle() *cdktf.TerraformResourceLifecycle // Experimental. SetLifecycle(val *cdktf.TerraformResourceLifecycle) MasterPassword() *string SetMasterPassword(val *string) MasterPasswordInput() *string MasterUsername() *string SetMasterUsername(val *string) MasterUsernameInput() *string // The tree node. Node() constructs.Node Port() *float64 SetPort(val *float64) PortInput() *float64 PreferredBackupWindow() *string SetPreferredBackupWindow(val *string) PreferredBackupWindowInput() *string PreferredMaintenanceWindow() *string SetPreferredMaintenanceWindow(val *string) PreferredMaintenanceWindowInput() *string // Experimental. Provider() cdktf.TerraformProvider // Experimental. SetProvider(val cdktf.TerraformProvider) // Experimental. Provisioners() *[]interface{} // Experimental. SetProvisioners(val *[]interface{}) // Experimental. RawOverrides() interface{} ReaderEndpoint() *string SkipFinalSnapshot() interface{} SetSkipFinalSnapshot(val interface{}) SkipFinalSnapshotInput() interface{} SnapshotIdentifier() *string SetSnapshotIdentifier(val *string) SnapshotIdentifierInput() *string StorageEncrypted() interface{} SetStorageEncrypted(val interface{}) StorageEncryptedInput() interface{} Tags() *map[string]*string SetTags(val *map[string]*string) TagsAll() *map[string]*string SetTagsAll(val *map[string]*string) TagsAllInput() *map[string]*string TagsInput() *map[string]*string // Experimental. TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata // Experimental. TerraformMetaArguments() *map[string]interface{} // Experimental. TerraformResourceType() *string Timeouts() DocdbClusterTimeoutsOutputReference TimeoutsInput() interface{} VpcSecurityGroupIds() *[]*string SetVpcSecurityGroupIds(val *[]*string) VpcSecurityGroupIdsInput() *[]*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) PutTimeouts(value *DocdbClusterTimeouts) ResetApplyImmediately() ResetAvailabilityZones() ResetBackupRetentionPeriod() ResetClusterIdentifier() ResetClusterIdentifierPrefix() ResetClusterMembers() ResetDbClusterParameterGroupName() ResetDbSubnetGroupName() ResetDeletionProtection() ResetEnabledCloudwatchLogsExports() ResetEngine() ResetEngineVersion() ResetFinalSnapshotIdentifier() ResetGlobalClusterIdentifier() ResetId() ResetKmsKeyId() ResetMasterPassword() ResetMasterUsername() // Resets a previously passed logical Id to use the auto-generated logical id again. // Experimental. ResetOverrideLogicalId() ResetPort() ResetPreferredBackupWindow() ResetPreferredMaintenanceWindow() ResetSkipFinalSnapshot() ResetSnapshotIdentifier() ResetStorageEncrypted() ResetTags() ResetTagsAll() ResetTimeouts() ResetVpcSecurityGroupIds() 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://www.terraform.io/docs/providers/aws/r/docdb_cluster aws_docdb_cluster}.
func NewDocdbCluster ¶
func NewDocdbCluster(scope constructs.Construct, id *string, config *DocdbClusterConfig) DocdbCluster
Create a new {@link https://www.terraform.io/docs/providers/aws/r/docdb_cluster aws_docdb_cluster} Resource.
type DocdbClusterConfig ¶
type DocdbClusterConfig struct { // Experimental. Connection interface{} `field:"optional" json:"connection" yaml:"connection"` // Experimental. Count *float64 `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://www.terraform.io/docs/providers/aws/r/docdb_cluster#apply_immediately DocdbCluster#apply_immediately}. ApplyImmediately interface{} `field:"optional" json:"applyImmediately" yaml:"applyImmediately"` // Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/docdb_cluster#availability_zones DocdbCluster#availability_zones}. AvailabilityZones *[]*string `field:"optional" json:"availabilityZones" yaml:"availabilityZones"` // Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/docdb_cluster#backup_retention_period DocdbCluster#backup_retention_period}. BackupRetentionPeriod *float64 `field:"optional" json:"backupRetentionPeriod" yaml:"backupRetentionPeriod"` // Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/docdb_cluster#cluster_identifier DocdbCluster#cluster_identifier}. ClusterIdentifier *string `field:"optional" json:"clusterIdentifier" yaml:"clusterIdentifier"` // Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/docdb_cluster#cluster_identifier_prefix DocdbCluster#cluster_identifier_prefix}. ClusterIdentifierPrefix *string `field:"optional" json:"clusterIdentifierPrefix" yaml:"clusterIdentifierPrefix"` // Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/docdb_cluster#cluster_members DocdbCluster#cluster_members}. ClusterMembers *[]*string `field:"optional" json:"clusterMembers" yaml:"clusterMembers"` // Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/docdb_cluster#db_cluster_parameter_group_name DocdbCluster#db_cluster_parameter_group_name}. DbClusterParameterGroupName *string `field:"optional" json:"dbClusterParameterGroupName" yaml:"dbClusterParameterGroupName"` // Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/docdb_cluster#db_subnet_group_name DocdbCluster#db_subnet_group_name}. DbSubnetGroupName *string `field:"optional" json:"dbSubnetGroupName" yaml:"dbSubnetGroupName"` // Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/docdb_cluster#deletion_protection DocdbCluster#deletion_protection}. DeletionProtection interface{} `field:"optional" json:"deletionProtection" yaml:"deletionProtection"` // Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/docdb_cluster#enabled_cloudwatch_logs_exports DocdbCluster#enabled_cloudwatch_logs_exports}. EnabledCloudwatchLogsExports *[]*string `field:"optional" json:"enabledCloudwatchLogsExports" yaml:"enabledCloudwatchLogsExports"` // Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/docdb_cluster#engine DocdbCluster#engine}. Engine *string `field:"optional" json:"engine" yaml:"engine"` // Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/docdb_cluster#engine_version DocdbCluster#engine_version}. EngineVersion *string `field:"optional" json:"engineVersion" yaml:"engineVersion"` // Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/docdb_cluster#final_snapshot_identifier DocdbCluster#final_snapshot_identifier}. FinalSnapshotIdentifier *string `field:"optional" json:"finalSnapshotIdentifier" yaml:"finalSnapshotIdentifier"` // Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/docdb_cluster#global_cluster_identifier DocdbCluster#global_cluster_identifier}. GlobalClusterIdentifier *string `field:"optional" json:"globalClusterIdentifier" yaml:"globalClusterIdentifier"` // Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/docdb_cluster#id DocdbCluster#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://www.terraform.io/docs/providers/aws/r/docdb_cluster#kms_key_id DocdbCluster#kms_key_id}. KmsKeyId *string `field:"optional" json:"kmsKeyId" yaml:"kmsKeyId"` // Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/docdb_cluster#master_password DocdbCluster#master_password}. MasterPassword *string `field:"optional" json:"masterPassword" yaml:"masterPassword"` // Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/docdb_cluster#master_username DocdbCluster#master_username}. MasterUsername *string `field:"optional" json:"masterUsername" yaml:"masterUsername"` // Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/docdb_cluster#port DocdbCluster#port}. Port *float64 `field:"optional" json:"port" yaml:"port"` // Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/docdb_cluster#preferred_backup_window DocdbCluster#preferred_backup_window}. PreferredBackupWindow *string `field:"optional" json:"preferredBackupWindow" yaml:"preferredBackupWindow"` // Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/docdb_cluster#preferred_maintenance_window DocdbCluster#preferred_maintenance_window}. PreferredMaintenanceWindow *string `field:"optional" json:"preferredMaintenanceWindow" yaml:"preferredMaintenanceWindow"` // Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/docdb_cluster#skip_final_snapshot DocdbCluster#skip_final_snapshot}. SkipFinalSnapshot interface{} `field:"optional" json:"skipFinalSnapshot" yaml:"skipFinalSnapshot"` // Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/docdb_cluster#snapshot_identifier DocdbCluster#snapshot_identifier}. SnapshotIdentifier *string `field:"optional" json:"snapshotIdentifier" yaml:"snapshotIdentifier"` // Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/docdb_cluster#storage_encrypted DocdbCluster#storage_encrypted}. StorageEncrypted interface{} `field:"optional" json:"storageEncrypted" yaml:"storageEncrypted"` // Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/docdb_cluster#tags DocdbCluster#tags}. Tags *map[string]*string `field:"optional" json:"tags" yaml:"tags"` // Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/docdb_cluster#tags_all DocdbCluster#tags_all}. TagsAll *map[string]*string `field:"optional" json:"tagsAll" yaml:"tagsAll"` // timeouts block. // // Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/docdb_cluster#timeouts DocdbCluster#timeouts} Timeouts *DocdbClusterTimeouts `field:"optional" json:"timeouts" yaml:"timeouts"` // Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/docdb_cluster#vpc_security_group_ids DocdbCluster#vpc_security_group_ids}. VpcSecurityGroupIds *[]*string `field:"optional" json:"vpcSecurityGroupIds" yaml:"vpcSecurityGroupIds"` }
type DocdbClusterTimeouts ¶
type DocdbClusterTimeouts struct { // Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/docdb_cluster#create DocdbCluster#create}. Create *string `field:"optional" json:"create" yaml:"create"` // Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/docdb_cluster#delete DocdbCluster#delete}. Delete *string `field:"optional" json:"delete" yaml:"delete"` // Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/docdb_cluster#update DocdbCluster#update}. Update *string `field:"optional" json:"update" yaml:"update"` }
type DocdbClusterTimeoutsOutputReference ¶
type DocdbClusterTimeoutsOutputReference 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) Create() *string SetCreate(val *string) CreateInput() *string // 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 Delete() *string SetDelete(val *string) DeleteInput() *string // Experimental. Fqn() *string InternalValue() interface{} SetInternalValue(val interface{}) // Experimental. TerraformAttribute() *string // Experimental. SetTerraformAttribute(val *string) // Experimental. TerraformResource() cdktf.IInterpolatingParent // Experimental. SetTerraformResource(val cdktf.IInterpolatingParent) Update() *string SetUpdate(val *string) UpdateInput() *string // 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 ResetCreate() ResetDelete() ResetUpdate() // 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 NewDocdbClusterTimeoutsOutputReference ¶
func NewDocdbClusterTimeoutsOutputReference(terraformResource cdktf.IInterpolatingParent, terraformAttribute *string) DocdbClusterTimeoutsOutputReference