Skip to content

Latest commit

 

History

History
1650 lines (1023 loc) · 70.6 KB

dataAwsRedshiftCluster.csharp.md

File metadata and controls

1650 lines (1023 loc) · 70.6 KB

dataAwsRedshiftCluster Submodule

Constructs

DataAwsRedshiftCluster

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/data-sources/redshift_cluster aws_redshift_cluster}.

Initializers

using HashiCorp.Cdktf.Providers.Aws;

new DataAwsRedshiftCluster(Construct Scope, string Id, DataAwsRedshiftClusterConfig Config);
Name Type Description
Scope Constructs.Construct The scope in which to define this construct.
Id string The scoped construct ID.
Config DataAwsRedshiftClusterConfig No description.

ScopeRequired
  • Type: Constructs.Construct

The scope in which to define this construct.


IdRequired
  • Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope


ConfigRequired

Methods

Name Description
ToString Returns a string representation of this construct.
AddOverride No description.
OverrideLogicalId Overrides the auto-generated logical ID with a specific ID.
ResetOverrideLogicalId Resets a previously passed logical Id to use the auto-generated logical id again.
ToHclTerraform Adds this resource to the terraform JSON output.
ToMetadata No description.
ToTerraform Adds this resource to the terraform JSON output.
GetAnyMapAttribute No description.
GetBooleanAttribute No description.
GetBooleanMapAttribute No description.
GetListAttribute No description.
GetNumberAttribute No description.
GetNumberListAttribute No description.
GetNumberMapAttribute No description.
GetStringAttribute No description.
GetStringMapAttribute No description.
InterpolationForAttribute No description.
ResetId No description.
ResetTags No description.

ToString
private string ToString()

Returns a string representation of this construct.

AddOverride
private void AddOverride(string Path, object Value)
PathRequired
  • Type: string

ValueRequired
  • Type: object

OverrideLogicalId
private void OverrideLogicalId(string NewLogicalId)

Overrides the auto-generated logical ID with a specific ID.

NewLogicalIdRequired
  • Type: string

The new logical ID to use for this stack element.


ResetOverrideLogicalId
private void ResetOverrideLogicalId()

Resets a previously passed logical Id to use the auto-generated logical id again.

ToHclTerraform
private object ToHclTerraform()

Adds this resource to the terraform JSON output.

ToMetadata
private object ToMetadata()
ToTerraform
private object ToTerraform()

Adds this resource to the terraform JSON output.

GetAnyMapAttribute
private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetBooleanAttribute
private IResolvable GetBooleanAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetBooleanMapAttribute
private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetListAttribute
private string[] GetListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberAttribute
private double GetNumberAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberListAttribute
private double[] GetNumberListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberMapAttribute
private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetStringAttribute
private string GetStringAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetStringMapAttribute
private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

InterpolationForAttribute
private IResolvable InterpolationForAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

ResetId
private void ResetId()
ResetTags
private void ResetTags()

Static Functions

Name Description
IsConstruct Checks if x is a construct.
IsTerraformElement No description.
IsTerraformDataSource No description.
GenerateConfigForImport Generates CDKTF code for importing a DataAwsRedshiftCluster resource upon running "cdktf plan ".

IsConstruct
using HashiCorp.Cdktf.Providers.Aws;

DataAwsRedshiftCluster.IsConstruct(object X);

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.

XRequired
  • Type: object

Any object.


IsTerraformElement
using HashiCorp.Cdktf.Providers.Aws;

DataAwsRedshiftCluster.IsTerraformElement(object X);
XRequired
  • Type: object

IsTerraformDataSource
using HashiCorp.Cdktf.Providers.Aws;

DataAwsRedshiftCluster.IsTerraformDataSource(object X);
XRequired
  • Type: object

GenerateConfigForImport
using HashiCorp.Cdktf.Providers.Aws;

DataAwsRedshiftCluster.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null);

Generates CDKTF code for importing a DataAwsRedshiftCluster resource upon running "cdktf plan ".

ScopeRequired
  • Type: Constructs.Construct

The scope in which to define this construct.


ImportToIdRequired
  • Type: string

The construct id used in the generated config for the DataAwsRedshiftCluster to import.


ImportFromIdRequired
  • Type: string

The id of the existing DataAwsRedshiftCluster that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/data-sources/redshift_cluster#import import section} in the documentation of this resource for the id to use


ProviderOptional
  • Type: HashiCorp.Cdktf.TerraformProvider

? Optional instance of the provider where the DataAwsRedshiftCluster to import is found.


Properties

Name Type Description
Node Constructs.Node The tree node.
CdktfStack HashiCorp.Cdktf.TerraformStack No description.
Fqn string No description.
FriendlyUniqueId string No description.
TerraformMetaArguments System.Collections.Generic.IDictionary<string, object> No description.
TerraformResourceType string No description.
TerraformGeneratorMetadata HashiCorp.Cdktf.TerraformProviderGeneratorMetadata No description.
Count object No description.
DependsOn string[] No description.
ForEach HashiCorp.Cdktf.ITerraformIterator No description.
Lifecycle HashiCorp.Cdktf.TerraformResourceLifecycle No description.
Provider HashiCorp.Cdktf.TerraformProvider No description.
AllowVersionUpgrade HashiCorp.Cdktf.IResolvable No description.
AquaConfigurationStatus string No description.
Arn string No description.
AutomatedSnapshotRetentionPeriod double No description.
AvailabilityZone string No description.
AvailabilityZoneRelocationEnabled HashiCorp.Cdktf.IResolvable No description.
BucketName string No description.
ClusterNamespaceArn string No description.
ClusterNodes DataAwsRedshiftClusterClusterNodesList No description.
ClusterParameterGroupName string No description.
ClusterPublicKey string No description.
ClusterRevisionNumber string No description.
ClusterSubnetGroupName string No description.
ClusterType string No description.
ClusterVersion string No description.
DatabaseName string No description.
DefaultIamRoleArn string No description.
ElasticIp string No description.
EnableLogging HashiCorp.Cdktf.IResolvable No description.
Encrypted HashiCorp.Cdktf.IResolvable No description.
Endpoint string No description.
EnhancedVpcRouting HashiCorp.Cdktf.IResolvable No description.
IamRoles string[] No description.
KmsKeyId string No description.
LogDestinationType string No description.
LogExports string[] No description.
MaintenanceTrackName string No description.
ManualSnapshotRetentionPeriod double No description.
MasterUsername string No description.
MultiAz HashiCorp.Cdktf.IResolvable No description.
NodeType string No description.
NumberOfNodes double No description.
Port double No description.
PreferredMaintenanceWindow string No description.
PubliclyAccessible HashiCorp.Cdktf.IResolvable No description.
S3KeyPrefix string No description.
VpcId string No description.
VpcSecurityGroupIds string[] No description.
ClusterIdentifierInput string No description.
IdInput string No description.
TagsInput System.Collections.Generic.IDictionary<string, string> No description.
ClusterIdentifier string No description.
Id string No description.
Tags System.Collections.Generic.IDictionary<string, string> No description.

NodeRequired
public Node Node { get; }
  • Type: Constructs.Node

The tree node.


CdktfStackRequired
public TerraformStack CdktfStack { get; }
  • Type: HashiCorp.Cdktf.TerraformStack

FqnRequired
public string Fqn { get; }
  • Type: string

FriendlyUniqueIdRequired
public string FriendlyUniqueId { get; }
  • Type: string

TerraformMetaArgumentsRequired
public System.Collections.Generic.IDictionary<string, object> TerraformMetaArguments { get; }
  • Type: System.Collections.Generic.IDictionary<string, object>

TerraformResourceTypeRequired
public string TerraformResourceType { get; }
  • Type: string

TerraformGeneratorMetadataOptional
public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }
  • Type: HashiCorp.Cdktf.TerraformProviderGeneratorMetadata

CountOptional
public object Count { get; }
  • Type: object

DependsOnOptional
public string[] DependsOn { get; }
  • Type: string[]

ForEachOptional
public ITerraformIterator ForEach { get; }
  • Type: HashiCorp.Cdktf.ITerraformIterator

LifecycleOptional
public TerraformResourceLifecycle Lifecycle { get; }
  • Type: HashiCorp.Cdktf.TerraformResourceLifecycle

ProviderOptional
public TerraformProvider Provider { get; }
  • Type: HashiCorp.Cdktf.TerraformProvider

AllowVersionUpgradeRequired
public IResolvable AllowVersionUpgrade { get; }
  • Type: HashiCorp.Cdktf.IResolvable

AquaConfigurationStatusRequired
public string AquaConfigurationStatus { get; }
  • Type: string

ArnRequired
public string Arn { get; }
  • Type: string

AutomatedSnapshotRetentionPeriodRequired
public double AutomatedSnapshotRetentionPeriod { get; }
  • Type: double

AvailabilityZoneRequired
public string AvailabilityZone { get; }
  • Type: string

AvailabilityZoneRelocationEnabledRequired
public IResolvable AvailabilityZoneRelocationEnabled { get; }
  • Type: HashiCorp.Cdktf.IResolvable

BucketNameRequired
public string BucketName { get; }
  • Type: string

ClusterNamespaceArnRequired
public string ClusterNamespaceArn { get; }
  • Type: string

ClusterNodesRequired
public DataAwsRedshiftClusterClusterNodesList ClusterNodes { get; }

ClusterParameterGroupNameRequired
public string ClusterParameterGroupName { get; }
  • Type: string

ClusterPublicKeyRequired
public string ClusterPublicKey { get; }
  • Type: string

ClusterRevisionNumberRequired
public string ClusterRevisionNumber { get; }
  • Type: string

ClusterSubnetGroupNameRequired
public string ClusterSubnetGroupName { get; }
  • Type: string

ClusterTypeRequired
public string ClusterType { get; }
  • Type: string

ClusterVersionRequired
public string ClusterVersion { get; }
  • Type: string

DatabaseNameRequired
public string DatabaseName { get; }
  • Type: string

DefaultIamRoleArnRequired
public string DefaultIamRoleArn { get; }
  • Type: string

ElasticIpRequired
public string ElasticIp { get; }
  • Type: string

EnableLoggingRequired
public IResolvable EnableLogging { get; }
  • Type: HashiCorp.Cdktf.IResolvable

EncryptedRequired
public IResolvable Encrypted { get; }
  • Type: HashiCorp.Cdktf.IResolvable

EndpointRequired
public string Endpoint { get; }
  • Type: string

EnhancedVpcRoutingRequired
public IResolvable EnhancedVpcRouting { get; }
  • Type: HashiCorp.Cdktf.IResolvable

IamRolesRequired
public string[] IamRoles { get; }
  • Type: string[]

KmsKeyIdRequired
public string KmsKeyId { get; }
  • Type: string

LogDestinationTypeRequired
public string LogDestinationType { get; }
  • Type: string

LogExportsRequired
public string[] LogExports { get; }
  • Type: string[]

MaintenanceTrackNameRequired
public string MaintenanceTrackName { get; }
  • Type: string

ManualSnapshotRetentionPeriodRequired
public double ManualSnapshotRetentionPeriod { get; }
  • Type: double

MasterUsernameRequired
public string MasterUsername { get; }
  • Type: string

MultiAzRequired
public IResolvable MultiAz { get; }
  • Type: HashiCorp.Cdktf.IResolvable

NodeTypeRequired
public string NodeType { get; }
  • Type: string

NumberOfNodesRequired
public double NumberOfNodes { get; }
  • Type: double

PortRequired
public double Port { get; }
  • Type: double

PreferredMaintenanceWindowRequired
public string PreferredMaintenanceWindow { get; }
  • Type: string

PubliclyAccessibleRequired
public IResolvable PubliclyAccessible { get; }
  • Type: HashiCorp.Cdktf.IResolvable

S3KeyPrefixRequired
public string S3KeyPrefix { get; }
  • Type: string

VpcIdRequired
public string VpcId { get; }
  • Type: string

VpcSecurityGroupIdsRequired
public string[] VpcSecurityGroupIds { get; }
  • Type: string[]

ClusterIdentifierInputOptional
public string ClusterIdentifierInput { get; }
  • Type: string

IdInputOptional
public string IdInput { get; }
  • Type: string

TagsInputOptional
public System.Collections.Generic.IDictionary<string, string> TagsInput { get; }
  • Type: System.Collections.Generic.IDictionary<string, string>

ClusterIdentifierRequired
public string ClusterIdentifier { get; }
  • Type: string

IdRequired
public string Id { get; }
  • Type: string

TagsRequired
public System.Collections.Generic.IDictionary<string, string> Tags { get; }
  • Type: System.Collections.Generic.IDictionary<string, string>

Constants

Name Type Description
TfResourceType string No description.

TfResourceTypeRequired
public string TfResourceType { get; }
  • Type: string

Structs

DataAwsRedshiftClusterClusterNodes

Initializer

using HashiCorp.Cdktf.Providers.Aws;

new DataAwsRedshiftClusterClusterNodes {

};

DataAwsRedshiftClusterConfig

Initializer

using HashiCorp.Cdktf.Providers.Aws;

new DataAwsRedshiftClusterConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    string ClusterIdentifier,
    string Id = null,
    System.Collections.Generic.IDictionary<string, string> Tags = null
};

Properties

Name Type Description
Connection object No description.
Count object No description.
DependsOn HashiCorp.Cdktf.ITerraformDependable[] No description.
ForEach HashiCorp.Cdktf.ITerraformIterator No description.
Lifecycle HashiCorp.Cdktf.TerraformResourceLifecycle No description.
Provider HashiCorp.Cdktf.TerraformProvider No description.
Provisioners object[] No description.
ClusterIdentifier string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/data-sources/redshift_cluster#cluster_identifier DataAwsRedshiftCluster#cluster_identifier}.
Id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/data-sources/redshift_cluster#id DataAwsRedshiftCluster#id}.
Tags System.Collections.Generic.IDictionary<string, string> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/data-sources/redshift_cluster#tags DataAwsRedshiftCluster#tags}.

ConnectionOptional
public object Connection { get; set; }
  • Type: object

CountOptional
public object Count { get; set; }
  • Type: object

DependsOnOptional
public ITerraformDependable[] DependsOn { get; set; }
  • Type: HashiCorp.Cdktf.ITerraformDependable[]

ForEachOptional
public ITerraformIterator ForEach { get; set; }
  • Type: HashiCorp.Cdktf.ITerraformIterator

LifecycleOptional
public TerraformResourceLifecycle Lifecycle { get; set; }
  • Type: HashiCorp.Cdktf.TerraformResourceLifecycle

ProviderOptional
public TerraformProvider Provider { get; set; }
  • Type: HashiCorp.Cdktf.TerraformProvider

ProvisionersOptional
public object[] Provisioners { get; set; }
  • Type: object[]

ClusterIdentifierRequired
public string ClusterIdentifier { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/data-sources/redshift_cluster#cluster_identifier DataAwsRedshiftCluster#cluster_identifier}.


IdOptional
public string Id { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/data-sources/redshift_cluster#id DataAwsRedshiftCluster#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.


TagsOptional
public System.Collections.Generic.IDictionary<string, string> Tags { get; set; }
  • Type: System.Collections.Generic.IDictionary<string, string>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/data-sources/redshift_cluster#tags DataAwsRedshiftCluster#tags}.


Classes

DataAwsRedshiftClusterClusterNodesList

Initializers

using HashiCorp.Cdktf.Providers.Aws;

new DataAwsRedshiftClusterClusterNodesList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet);
Name Type Description
TerraformResource HashiCorp.Cdktf.IInterpolatingParent The parent resource.
TerraformAttribute string The attribute on the parent resource this class is referencing.
WrapsSet bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

TerraformResourceRequired
  • Type: HashiCorp.Cdktf.IInterpolatingParent

The parent resource.


TerraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.


WrapsSetRequired
  • Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).


Methods

Name Description
AllWithMapKey Creating an iterator for this complex list.
ComputeFqn No description.
Resolve Produce the Token's value at resolution time.
ToString Return a string representation of this resolvable object.
Get No description.

AllWithMapKey
private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName)

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

MapKeyAttributeNameRequired
  • Type: string

ComputeFqn
private string ComputeFqn()
Resolve
private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

ContextRequired
  • Type: HashiCorp.Cdktf.IResolveContext

ToString
private string ToString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

Get
private DataAwsRedshiftClusterClusterNodesOutputReference Get(double Index)
IndexRequired
  • Type: double

the index of the item to return.


Properties

Name Type Description
CreationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
Fqn string No description.

CreationStackRequired
public string[] CreationStack { get; }
  • Type: 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.


FqnRequired
public string Fqn { get; }
  • Type: string

DataAwsRedshiftClusterClusterNodesOutputReference

Initializers

using HashiCorp.Cdktf.Providers.Aws;

new DataAwsRedshiftClusterClusterNodesOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet);
Name Type Description
TerraformResource HashiCorp.Cdktf.IInterpolatingParent The parent resource.
TerraformAttribute string The attribute on the parent resource this class is referencing.
ComplexObjectIndex double the index of this item in the list.
ComplexObjectIsFromSet bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

TerraformResourceRequired
  • Type: HashiCorp.Cdktf.IInterpolatingParent

The parent resource.


TerraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.


ComplexObjectIndexRequired
  • Type: double

the index of this item in the list.


ComplexObjectIsFromSetRequired
  • Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).


Methods

Name Description
ComputeFqn No description.
GetAnyMapAttribute No description.
GetBooleanAttribute No description.
GetBooleanMapAttribute No description.
GetListAttribute No description.
GetNumberAttribute No description.
GetNumberListAttribute No description.
GetNumberMapAttribute No description.
GetStringAttribute No description.
GetStringMapAttribute No description.
InterpolationForAttribute No description.
Resolve Produce the Token's value at resolution time.
ToString Return a string representation of this resolvable object.

ComputeFqn
private string ComputeFqn()
GetAnyMapAttribute
private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetBooleanAttribute
private IResolvable GetBooleanAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetBooleanMapAttribute
private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetListAttribute
private string[] GetListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberAttribute
private double GetNumberAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberListAttribute
private double[] GetNumberListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberMapAttribute
private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetStringAttribute
private string GetStringAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetStringMapAttribute
private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

InterpolationForAttribute
private IResolvable InterpolationForAttribute(string Property)
PropertyRequired
  • Type: string

Resolve
private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

ContextRequired
  • Type: HashiCorp.Cdktf.IResolveContext

ToString
private string ToString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

Name Type Description
CreationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
Fqn string No description.
NodeRole string No description.
PrivateIpAddress string No description.
PublicIpAddress string No description.
InternalValue DataAwsRedshiftClusterClusterNodes No description.

CreationStackRequired
public string[] CreationStack { get; }
  • Type: 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.


FqnRequired
public string Fqn { get; }
  • Type: string

NodeRoleRequired
public string NodeRole { get; }
  • Type: string

PrivateIpAddressRequired
public string PrivateIpAddress { get; }
  • Type: string

PublicIpAddressRequired
public string PublicIpAddress { get; }
  • Type: string

InternalValueOptional
public DataAwsRedshiftClusterClusterNodes InternalValue { get; }