Skip to content

Latest commit

 

History

History
1558 lines (958 loc) · 58.1 KB

srvRecordSet.csharp.md

File metadata and controls

1558 lines (958 loc) · 58.1 KB
Raw

srvRecordSet Submodule

Constructs

SrvRecordSet

Represents a {@link https://registry.terraform.io/providers/hashicorp/dns/3.4.2/docs/resources/srv_record_set dns_srv_record_set}.

Initializers 

using HashiCorp.Cdktf.Providers.Dns;

new SrvRecordSet(Construct Scope, string Id, SrvRecordSetConfig Config);
Name Type Description
Scope Constructs.Construct The scope in which to define this construct.
Id string The scoped construct ID.
Config SrvRecordSetConfig 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 No description.
ToMetadata No description.
ToTerraform Adds this resource to the terraform JSON output.
AddMoveTarget Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
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.
HasResourceMove No description.
ImportFrom No description.
InterpolationForAttribute No description.
MoveFromId Move the resource corresponding to "id" to this resource.
MoveTo Moves this resource to the target resource given by moveTarget.
MoveToId Moves this resource to the resource corresponding to "id".
PutSrv No description.
ResetSrv No description.
ResetTtl 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()
ToMetadata 
private object ToMetadata()
ToTerraform 
private object ToTerraform()

Adds this resource to the terraform JSON output.

AddMoveTarget 
private void AddMoveTarget(string MoveTarget)

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

MoveTargetRequired
  • Type: string

The string move target that will correspond to this resource.

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
HasResourceMove 
private object HasResourceMove()
ImportFrom 
private void ImportFrom(string Id, TerraformProvider Provider = null)
IdRequired
  • Type: string
ProviderOptional
  • Type: HashiCorp.Cdktf.TerraformProvider
InterpolationForAttribute 
private IResolvable InterpolationForAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
MoveFromId 
private void MoveFromId(string Id)

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

IdRequired
  • Type: string

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

MoveTo 
private void MoveTo(string MoveTarget, object Index = null)

Moves this resource to the target resource given by moveTarget.

MoveTargetRequired
  • Type: string

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

IndexOptional
  • Type: object

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

MoveToId 
private void MoveToId(string Id)

Moves this resource to the resource corresponding to "id".

IdRequired
  • Type: string

Full id of resource to move to, e.g. "aws_s3_bucket.example".

PutSrv 
private void PutSrv(object Value)
ValueRequired
  • Type: object
ResetSrv 
private void ResetSrv()
ResetTtl 
private void ResetTtl()

Static Functions

Name Description
IsConstruct Checks if x is a construct.
IsTerraformElement No description.
IsTerraformResource No description.
GenerateConfigForImport Generates CDKTF code for importing a SrvRecordSet resource upon running "cdktf plan ".
IsConstruct 
using HashiCorp.Cdktf.Providers.Dns;

SrvRecordSet.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.Dns;

SrvRecordSet.IsTerraformElement(object X);
XRequired
  • Type: object
IsTerraformResource 
using HashiCorp.Cdktf.Providers.Dns;

SrvRecordSet.IsTerraformResource(object X);
XRequired
  • Type: object
GenerateConfigForImport 
using HashiCorp.Cdktf.Providers.Dns;

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

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

ImportFromIdRequired
  • Type: string

The id of the existing SrvRecordSet that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/dns/3.4.2/docs/resources/srv_record_set#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 SrvRecordSet 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.
Connection object 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.
Provisioners object[] No description.
Id string No description.
Srv SrvRecordSetSrvList No description.
NameInput string No description.
SrvInput object No description.
TtlInput double No description.
ZoneInput string No description.
Name string No description.
Ttl double No description.
Zone 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
ConnectionOptional 
public object Connection { get; }
  • Type: object
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
ProvisionersOptional 
public object[] Provisioners { get; }
  • Type: object[]
IdRequired 
public string Id { get; }
  • Type: string
SrvRequired 
public SrvRecordSetSrvList Srv { get; }
NameInputOptional 
public string NameInput { get; }
  • Type: string
SrvInputOptional 
public object SrvInput { get; }
  • Type: object
TtlInputOptional 
public double TtlInput { get; }
  • Type: double
ZoneInputOptional 
public string ZoneInput { get; }
  • Type: string
NameRequired 
public string Name { get; }
  • Type: string
TtlRequired 
public double Ttl { get; }
  • Type: double
ZoneRequired 
public string Zone { get; }
  • Type: string

Constants

Name Type Description
TfResourceType string No description.
TfResourceTypeRequired 
public string TfResourceType { get; }
  • Type: string

Structs

SrvRecordSetConfig

Initializer 

using HashiCorp.Cdktf.Providers.Dns;

new SrvRecordSetConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    string Name,
    string Zone,
    object Srv = null,
    double Ttl = 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 The name of the record set.
Zone string DNS zone the record set belongs to. It must be an FQDN, that is, include the trailing dot.
Srv object srv block.
Ttl double The TTL of the record set. Defaults to 3600.
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

The name of the record set.

The zone argument will be appended to this value to create the full record path.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/dns/3.4.2/docs/resources/srv_record_set#name SrvRecordSet#name}

ZoneRequired 
public string Zone { get; set; }
  • Type: string

DNS zone the record set belongs to. It must be an FQDN, that is, include the trailing dot.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/dns/3.4.2/docs/resources/srv_record_set#zone SrvRecordSet#zone}

SrvOptional 
public object Srv { get; set; }
  • Type: object

srv block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/dns/3.4.2/docs/resources/srv_record_set#srv SrvRecordSet#srv}

TtlOptional 
public double Ttl { get; set; }
  • Type: double

The TTL of the record set. Defaults to 3600.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/dns/3.4.2/docs/resources/srv_record_set#ttl SrvRecordSet#ttl}

SrvRecordSetSrv

Initializer 

using HashiCorp.Cdktf.Providers.Dns;

new SrvRecordSetSrv {
    double Port,
    double Priority,
    string Target,
    double Weight
};

Properties

Name Type Description
Port double The port for the service on the target.
Priority double The priority for the record.
Target string The FQDN of the target, include the trailing dot.
Weight double The weight for the record.
PortRequired 
public double Port { get; set; }
  • Type: double

The port for the service on the target.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/dns/3.4.2/docs/resources/srv_record_set#port SrvRecordSet#port}

PriorityRequired 
public double Priority { get; set; }
  • Type: double

The priority for the record.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/dns/3.4.2/docs/resources/srv_record_set#priority SrvRecordSet#priority}

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

The FQDN of the target, include the trailing dot.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/dns/3.4.2/docs/resources/srv_record_set#target SrvRecordSet#target}

WeightRequired 
public double Weight { get; set; }
  • Type: double

The weight for the record.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/dns/3.4.2/docs/resources/srv_record_set#weight SrvRecordSet#weight}

Classes

SrvRecordSetSrvList

Initializers 

using HashiCorp.Cdktf.Providers.Dns;

new SrvRecordSetSrvList(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 SrvRecordSetSrvOutputReference 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.
InternalValue object 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
InternalValueOptional 
public object InternalValue { get; }
  • Type: object

SrvRecordSetSrvOutputReference

Initializers 

using HashiCorp.Cdktf.Providers.Dns;

new SrvRecordSetSrvOutputReference(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.
PortInput double No description.
PriorityInput double No description.
TargetInput string No description.
WeightInput double No description.
Port double No description.
Priority double No description.
Target string No description.
Weight double No description.
InternalValue object 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
PortInputOptional 
public double PortInput { get; }
  • Type: double
PriorityInputOptional 
public double PriorityInput { get; }
  • Type: double
TargetInputOptional 
public string TargetInput { get; }
  • Type: string
WeightInputOptional 
public double WeightInput { get; }
  • Type: double
PortRequired 
public double Port { get; }
  • Type: double
PriorityRequired 
public double Priority { get; }
  • Type: double
TargetRequired 
public string Target { get; }
  • Type: string
WeightRequired 
public double Weight { get; }
  • Type: double
InternalValueOptional 
public object InternalValue { get; }
  • Type: object