Skip to content

Latest commit

 

History

History
1636 lines (1016 loc) · 77.3 KB

dataGoogleComputeForwardingRule.csharp.md

File metadata and controls

1636 lines (1016 loc) · 77.3 KB

dataGoogleComputeForwardingRule Submodule

Constructs

DataGoogleComputeForwardingRule

Represents a {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/data-sources/compute_forwarding_rule google_compute_forwarding_rule}.

Initializers

using HashiCorp.Cdktf.Providers.Google;

new DataGoogleComputeForwardingRule(Construct Scope, string Id, DataGoogleComputeForwardingRuleConfig Config);
Name Type Description
Scope Constructs.Construct The scope in which to define this construct.
Id string The scoped construct ID.
Config DataGoogleComputeForwardingRuleConfig 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.
ResetProject No description.
ResetRegion 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()
ResetProject
private void ResetProject()
ResetRegion
private void ResetRegion()

Static Functions

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

IsConstruct
using HashiCorp.Cdktf.Providers.Google;

DataGoogleComputeForwardingRule.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.Google;

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

IsTerraformDataSource
using HashiCorp.Cdktf.Providers.Google;

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

GenerateConfigForImport
using HashiCorp.Cdktf.Providers.Google;

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

Generates CDKTF code for importing a DataGoogleComputeForwardingRule 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 DataGoogleComputeForwardingRule to import.


ImportFromIdRequired
  • Type: string

The id of the existing DataGoogleComputeForwardingRule that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/data-sources/compute_forwarding_rule#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 DataGoogleComputeForwardingRule 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.
AllowGlobalAccess HashiCorp.Cdktf.IResolvable No description.
AllowPscGlobalAccess HashiCorp.Cdktf.IResolvable No description.
AllPorts HashiCorp.Cdktf.IResolvable No description.
BackendService string No description.
BaseForwardingRule string No description.
CreationTimestamp string No description.
Description string No description.
EffectiveLabels HashiCorp.Cdktf.StringMap No description.
ForwardingRuleId double No description.
IpAddress string No description.
IpProtocol string No description.
IpVersion string No description.
IsMirroringCollector HashiCorp.Cdktf.IResolvable No description.
LabelFingerprint string No description.
Labels HashiCorp.Cdktf.StringMap No description.
LoadBalancingScheme string No description.
Network string No description.
NetworkTier string No description.
NoAutomateDnsZone HashiCorp.Cdktf.IResolvable No description.
PortRange string No description.
Ports string[] No description.
PscConnectionId string No description.
PscConnectionStatus string No description.
RecreateClosedPsc HashiCorp.Cdktf.IResolvable No description.
SelfLink string No description.
ServiceDirectoryRegistrations DataGoogleComputeForwardingRuleServiceDirectoryRegistrationsList No description.
ServiceLabel string No description.
ServiceName string No description.
SourceIpRanges string[] No description.
Subnetwork string No description.
Target string No description.
TerraformLabels HashiCorp.Cdktf.StringMap No description.
IdInput string No description.
NameInput string No description.
ProjectInput string No description.
RegionInput string No description.
Id string No description.
Name string No description.
Project string No description.
Region 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

AllowGlobalAccessRequired
public IResolvable AllowGlobalAccess { get; }
  • Type: HashiCorp.Cdktf.IResolvable

AllowPscGlobalAccessRequired
public IResolvable AllowPscGlobalAccess { get; }
  • Type: HashiCorp.Cdktf.IResolvable

AllPortsRequired
public IResolvable AllPorts { get; }
  • Type: HashiCorp.Cdktf.IResolvable

BackendServiceRequired
public string BackendService { get; }
  • Type: string

BaseForwardingRuleRequired
public string BaseForwardingRule { get; }
  • Type: string

CreationTimestampRequired
public string CreationTimestamp { get; }
  • Type: string

DescriptionRequired
public string Description { get; }
  • Type: string

EffectiveLabelsRequired
public StringMap EffectiveLabels { get; }
  • Type: HashiCorp.Cdktf.StringMap

ForwardingRuleIdRequired
public double ForwardingRuleId { get; }
  • Type: double

IpAddressRequired
public string IpAddress { get; }
  • Type: string

IpProtocolRequired
public string IpProtocol { get; }
  • Type: string

IpVersionRequired
public string IpVersion { get; }
  • Type: string

IsMirroringCollectorRequired
public IResolvable IsMirroringCollector { get; }
  • Type: HashiCorp.Cdktf.IResolvable

LabelFingerprintRequired
public string LabelFingerprint { get; }
  • Type: string

LabelsRequired
public StringMap Labels { get; }
  • Type: HashiCorp.Cdktf.StringMap

LoadBalancingSchemeRequired
public string LoadBalancingScheme { get; }
  • Type: string

NetworkRequired
public string Network { get; }
  • Type: string

NetworkTierRequired
public string NetworkTier { get; }
  • Type: string

NoAutomateDnsZoneRequired
public IResolvable NoAutomateDnsZone { get; }
  • Type: HashiCorp.Cdktf.IResolvable

PortRangeRequired
public string PortRange { get; }
  • Type: string

PortsRequired
public string[] Ports { get; }
  • Type: string[]

PscConnectionIdRequired
public string PscConnectionId { get; }
  • Type: string

PscConnectionStatusRequired
public string PscConnectionStatus { get; }
  • Type: string

RecreateClosedPscRequired
public IResolvable RecreateClosedPsc { get; }
  • Type: HashiCorp.Cdktf.IResolvable

SelfLinkRequired
public string SelfLink { get; }
  • Type: string

ServiceDirectoryRegistrationsRequired
public DataGoogleComputeForwardingRuleServiceDirectoryRegistrationsList ServiceDirectoryRegistrations { get; }

ServiceLabelRequired
public string ServiceLabel { get; }
  • Type: string

ServiceNameRequired
public string ServiceName { get; }
  • Type: string

SourceIpRangesRequired
public string[] SourceIpRanges { get; }
  • Type: string[]

SubnetworkRequired
public string Subnetwork { get; }
  • Type: string

TargetRequired
public string Target { get; }
  • Type: string

TerraformLabelsRequired
public StringMap TerraformLabels { get; }
  • Type: HashiCorp.Cdktf.StringMap

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

NameInputOptional
public string NameInput { get; }
  • Type: string

ProjectInputOptional
public string ProjectInput { get; }
  • Type: string

RegionInputOptional
public string RegionInput { get; }
  • Type: string

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

NameRequired
public string Name { get; }
  • Type: string

ProjectRequired
public string Project { get; }
  • Type: string

RegionRequired
public string Region { get; }
  • Type: string

Constants

Name Type Description
TfResourceType string No description.

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

Structs

DataGoogleComputeForwardingRuleConfig

Initializer

using HashiCorp.Cdktf.Providers.Google;

new DataGoogleComputeForwardingRuleConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    string Name,
    string Id = null,
    string Project = null,
    string Region = 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.
Name string Name of the resource;
Id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/data-sources/compute_forwarding_rule#id DataGoogleComputeForwardingRule#id}.
Project string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/data-sources/compute_forwarding_rule#project DataGoogleComputeForwardingRule#project}.
Region string A reference to the region where the regional forwarding rule resides.

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[]

NameRequired
public string Name { get; set; }
  • Type: string

Name of the resource;

provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.

Specifically, the name must be 1-63 characters long and match the regular expression 'a-z?' which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

For Private Service Connect forwarding rules that forward traffic to Google APIs, the forwarding rule name must be a 1-20 characters string with lowercase letters and numbers and must start with a letter.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/data-sources/compute_forwarding_rule#name DataGoogleComputeForwardingRule#name}


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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/data-sources/compute_forwarding_rule#id DataGoogleComputeForwardingRule#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.


ProjectOptional
public string Project { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/data-sources/compute_forwarding_rule#project DataGoogleComputeForwardingRule#project}.


RegionOptional
public string Region { get; set; }
  • Type: string

A reference to the region where the regional forwarding rule resides.

This field is not applicable to global forwarding rules.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/data-sources/compute_forwarding_rule#region DataGoogleComputeForwardingRule#region}


DataGoogleComputeForwardingRuleServiceDirectoryRegistrations

Initializer

using HashiCorp.Cdktf.Providers.Google;

new DataGoogleComputeForwardingRuleServiceDirectoryRegistrations {

};

Classes

DataGoogleComputeForwardingRuleServiceDirectoryRegistrationsList

Initializers

using HashiCorp.Cdktf.Providers.Google;

new DataGoogleComputeForwardingRuleServiceDirectoryRegistrationsList(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 DataGoogleComputeForwardingRuleServiceDirectoryRegistrationsOutputReference 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

DataGoogleComputeForwardingRuleServiceDirectoryRegistrationsOutputReference

Initializers

using HashiCorp.Cdktf.Providers.Google;

new DataGoogleComputeForwardingRuleServiceDirectoryRegistrationsOutputReference(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.
Namespace string No description.
Service string No description.
InternalValue DataGoogleComputeForwardingRuleServiceDirectoryRegistrations 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

NamespaceRequired
public string Namespace { get; }
  • Type: string

ServiceRequired
public string Service { get; }
  • Type: string

InternalValueOptional
public DataGoogleComputeForwardingRuleServiceDirectoryRegistrations InternalValue { get; }