Skip to content

Latest commit

 

History

History
2155 lines (1348 loc) · 101 KB

apiGatewayDomainName.csharp.md

File metadata and controls

2155 lines (1348 loc) · 101 KB

apiGatewayDomainName Submodule

Constructs

ApiGatewayDomainName

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/api_gateway_domain_name aws_api_gateway_domain_name}.

Initializers

using HashiCorp.Cdktf.Providers.Aws;

new ApiGatewayDomainName(Construct Scope, string Id, ApiGatewayDomainNameConfig Config);
Name Type Description
Scope Constructs.Construct The scope in which to define this construct.
Id string The scoped construct ID.
Config ApiGatewayDomainNameConfig 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".
PutEndpointConfiguration No description.
PutMutualTlsAuthentication No description.
ResetCertificateArn No description.
ResetCertificateBody No description.
ResetCertificateChain No description.
ResetCertificateName No description.
ResetCertificatePrivateKey No description.
ResetEndpointConfiguration No description.
ResetId No description.
ResetMutualTlsAuthentication No description.
ResetOwnershipVerificationCertificateArn No description.
ResetRegionalCertificateArn No description.
ResetRegionalCertificateName No description.
ResetSecurityPolicy No description.
ResetTags No description.
ResetTagsAll 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".


PutEndpointConfiguration
private void PutEndpointConfiguration(ApiGatewayDomainNameEndpointConfiguration Value)
ValueRequired

PutMutualTlsAuthentication
private void PutMutualTlsAuthentication(ApiGatewayDomainNameMutualTlsAuthentication Value)
ValueRequired

ResetCertificateArn
private void ResetCertificateArn()
ResetCertificateBody
private void ResetCertificateBody()
ResetCertificateChain
private void ResetCertificateChain()
ResetCertificateName
private void ResetCertificateName()
ResetCertificatePrivateKey
private void ResetCertificatePrivateKey()
ResetEndpointConfiguration
private void ResetEndpointConfiguration()
ResetId
private void ResetId()
ResetMutualTlsAuthentication
private void ResetMutualTlsAuthentication()
ResetOwnershipVerificationCertificateArn
private void ResetOwnershipVerificationCertificateArn()
ResetRegionalCertificateArn
private void ResetRegionalCertificateArn()
ResetRegionalCertificateName
private void ResetRegionalCertificateName()
ResetSecurityPolicy
private void ResetSecurityPolicy()
ResetTags
private void ResetTags()
ResetTagsAll
private void ResetTagsAll()

Static Functions

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

IsConstruct
using HashiCorp.Cdktf.Providers.Aws;

ApiGatewayDomainName.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;

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

IsTerraformResource
using HashiCorp.Cdktf.Providers.Aws;

ApiGatewayDomainName.IsTerraformResource(object X);
XRequired
  • Type: object

GenerateConfigForImport
using HashiCorp.Cdktf.Providers.Aws;

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

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


ImportFromIdRequired
  • Type: string

The id of the existing ApiGatewayDomainName that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/api_gateway_domain_name#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 ApiGatewayDomainName 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.
Arn string No description.
CertificateUploadDate string No description.
CloudfrontDomainName string No description.
CloudfrontZoneId string No description.
EndpointConfiguration ApiGatewayDomainNameEndpointConfigurationOutputReference No description.
MutualTlsAuthentication ApiGatewayDomainNameMutualTlsAuthenticationOutputReference No description.
RegionalDomainName string No description.
RegionalZoneId string No description.
CertificateArnInput string No description.
CertificateBodyInput string No description.
CertificateChainInput string No description.
CertificateNameInput string No description.
CertificatePrivateKeyInput string No description.
DomainNameInput string No description.
EndpointConfigurationInput ApiGatewayDomainNameEndpointConfiguration No description.
IdInput string No description.
MutualTlsAuthenticationInput ApiGatewayDomainNameMutualTlsAuthentication No description.
OwnershipVerificationCertificateArnInput string No description.
RegionalCertificateArnInput string No description.
RegionalCertificateNameInput string No description.
SecurityPolicyInput string No description.
TagsAllInput System.Collections.Generic.IDictionary<string, string> No description.
TagsInput System.Collections.Generic.IDictionary<string, string> No description.
CertificateArn string No description.
CertificateBody string No description.
CertificateChain string No description.
CertificateName string No description.
CertificatePrivateKey string No description.
DomainName string No description.
Id string No description.
OwnershipVerificationCertificateArn string No description.
RegionalCertificateArn string No description.
RegionalCertificateName string No description.
SecurityPolicy string No description.
Tags System.Collections.Generic.IDictionary<string, string> No description.
TagsAll 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

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

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

CertificateUploadDateRequired
public string CertificateUploadDate { get; }
  • Type: string

CloudfrontDomainNameRequired
public string CloudfrontDomainName { get; }
  • Type: string

CloudfrontZoneIdRequired
public string CloudfrontZoneId { get; }
  • Type: string

EndpointConfigurationRequired
public ApiGatewayDomainNameEndpointConfigurationOutputReference EndpointConfiguration { get; }

MutualTlsAuthenticationRequired
public ApiGatewayDomainNameMutualTlsAuthenticationOutputReference MutualTlsAuthentication { get; }

RegionalDomainNameRequired
public string RegionalDomainName { get; }
  • Type: string

RegionalZoneIdRequired
public string RegionalZoneId { get; }
  • Type: string

CertificateArnInputOptional
public string CertificateArnInput { get; }
  • Type: string

CertificateBodyInputOptional
public string CertificateBodyInput { get; }
  • Type: string

CertificateChainInputOptional
public string CertificateChainInput { get; }
  • Type: string

CertificateNameInputOptional
public string CertificateNameInput { get; }
  • Type: string

CertificatePrivateKeyInputOptional
public string CertificatePrivateKeyInput { get; }
  • Type: string

DomainNameInputOptional
public string DomainNameInput { get; }
  • Type: string

EndpointConfigurationInputOptional
public ApiGatewayDomainNameEndpointConfiguration EndpointConfigurationInput { get; }

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

MutualTlsAuthenticationInputOptional
public ApiGatewayDomainNameMutualTlsAuthentication MutualTlsAuthenticationInput { get; }

OwnershipVerificationCertificateArnInputOptional
public string OwnershipVerificationCertificateArnInput { get; }
  • Type: string

RegionalCertificateArnInputOptional
public string RegionalCertificateArnInput { get; }
  • Type: string

RegionalCertificateNameInputOptional
public string RegionalCertificateNameInput { get; }
  • Type: string

SecurityPolicyInputOptional
public string SecurityPolicyInput { get; }
  • Type: string

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

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

CertificateArnRequired
public string CertificateArn { get; }
  • Type: string

CertificateBodyRequired
public string CertificateBody { get; }
  • Type: string

CertificateChainRequired
public string CertificateChain { get; }
  • Type: string

CertificateNameRequired
public string CertificateName { get; }
  • Type: string

CertificatePrivateKeyRequired
public string CertificatePrivateKey { get; }
  • Type: string

DomainNameRequired
public string DomainName { get; }
  • Type: string

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

OwnershipVerificationCertificateArnRequired
public string OwnershipVerificationCertificateArn { get; }
  • Type: string

RegionalCertificateArnRequired
public string RegionalCertificateArn { get; }
  • Type: string

RegionalCertificateNameRequired
public string RegionalCertificateName { get; }
  • Type: string

SecurityPolicyRequired
public string SecurityPolicy { get; }
  • Type: string

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

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

Constants

Name Type Description
TfResourceType string No description.

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

Structs

ApiGatewayDomainNameConfig

Initializer

using HashiCorp.Cdktf.Providers.Aws;

new ApiGatewayDomainNameConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    string DomainName,
    string CertificateArn = null,
    string CertificateBody = null,
    string CertificateChain = null,
    string CertificateName = null,
    string CertificatePrivateKey = null,
    ApiGatewayDomainNameEndpointConfiguration EndpointConfiguration = null,
    string Id = null,
    ApiGatewayDomainNameMutualTlsAuthentication MutualTlsAuthentication = null,
    string OwnershipVerificationCertificateArn = null,
    string RegionalCertificateArn = null,
    string RegionalCertificateName = null,
    string SecurityPolicy = null,
    System.Collections.Generic.IDictionary<string, string> Tags = null,
    System.Collections.Generic.IDictionary<string, string> TagsAll = 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.
DomainName string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/api_gateway_domain_name#domain_name ApiGatewayDomainName#domain_name}.
CertificateArn string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/api_gateway_domain_name#certificate_arn ApiGatewayDomainName#certificate_arn}.
CertificateBody string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/api_gateway_domain_name#certificate_body ApiGatewayDomainName#certificate_body}.
CertificateChain string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/api_gateway_domain_name#certificate_chain ApiGatewayDomainName#certificate_chain}.
CertificateName string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/api_gateway_domain_name#certificate_name ApiGatewayDomainName#certificate_name}.
CertificatePrivateKey string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/api_gateway_domain_name#certificate_private_key ApiGatewayDomainName#certificate_private_key}.
EndpointConfiguration ApiGatewayDomainNameEndpointConfiguration endpoint_configuration block.
Id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/api_gateway_domain_name#id ApiGatewayDomainName#id}.
MutualTlsAuthentication ApiGatewayDomainNameMutualTlsAuthentication mutual_tls_authentication block.
OwnershipVerificationCertificateArn string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/api_gateway_domain_name#ownership_verification_certificate_arn ApiGatewayDomainName#ownership_verification_certificate_arn}.
RegionalCertificateArn string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/api_gateway_domain_name#regional_certificate_arn ApiGatewayDomainName#regional_certificate_arn}.
RegionalCertificateName string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/api_gateway_domain_name#regional_certificate_name ApiGatewayDomainName#regional_certificate_name}.
SecurityPolicy string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/api_gateway_domain_name#security_policy ApiGatewayDomainName#security_policy}.
Tags System.Collections.Generic.IDictionary<string, string> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/api_gateway_domain_name#tags ApiGatewayDomainName#tags}.
TagsAll System.Collections.Generic.IDictionary<string, string> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/api_gateway_domain_name#tags_all ApiGatewayDomainName#tags_all}.

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

DomainNameRequired
public string DomainName { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/api_gateway_domain_name#domain_name ApiGatewayDomainName#domain_name}.


CertificateArnOptional
public string CertificateArn { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/api_gateway_domain_name#certificate_arn ApiGatewayDomainName#certificate_arn}.


CertificateBodyOptional
public string CertificateBody { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/api_gateway_domain_name#certificate_body ApiGatewayDomainName#certificate_body}.


CertificateChainOptional
public string CertificateChain { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/api_gateway_domain_name#certificate_chain ApiGatewayDomainName#certificate_chain}.


CertificateNameOptional
public string CertificateName { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/api_gateway_domain_name#certificate_name ApiGatewayDomainName#certificate_name}.


CertificatePrivateKeyOptional
public string CertificatePrivateKey { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/api_gateway_domain_name#certificate_private_key ApiGatewayDomainName#certificate_private_key}.


EndpointConfigurationOptional
public ApiGatewayDomainNameEndpointConfiguration EndpointConfiguration { get; set; }

endpoint_configuration block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/api_gateway_domain_name#endpoint_configuration ApiGatewayDomainName#endpoint_configuration}


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

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


MutualTlsAuthenticationOptional
public ApiGatewayDomainNameMutualTlsAuthentication MutualTlsAuthentication { get; set; }

mutual_tls_authentication block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/api_gateway_domain_name#mutual_tls_authentication ApiGatewayDomainName#mutual_tls_authentication}


OwnershipVerificationCertificateArnOptional
public string OwnershipVerificationCertificateArn { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/api_gateway_domain_name#ownership_verification_certificate_arn ApiGatewayDomainName#ownership_verification_certificate_arn}.


RegionalCertificateArnOptional
public string RegionalCertificateArn { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/api_gateway_domain_name#regional_certificate_arn ApiGatewayDomainName#regional_certificate_arn}.


RegionalCertificateNameOptional
public string RegionalCertificateName { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/api_gateway_domain_name#regional_certificate_name ApiGatewayDomainName#regional_certificate_name}.


SecurityPolicyOptional
public string SecurityPolicy { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/api_gateway_domain_name#security_policy ApiGatewayDomainName#security_policy}.


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/resources/api_gateway_domain_name#tags ApiGatewayDomainName#tags}.


TagsAllOptional
public System.Collections.Generic.IDictionary<string, string> TagsAll { 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/resources/api_gateway_domain_name#tags_all ApiGatewayDomainName#tags_all}.


ApiGatewayDomainNameEndpointConfiguration

Initializer

using HashiCorp.Cdktf.Providers.Aws;

new ApiGatewayDomainNameEndpointConfiguration {
    string[] Types
};

Properties

Name Type Description
Types string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/api_gateway_domain_name#types ApiGatewayDomainName#types}.

TypesRequired
public string[] Types { get; set; }
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/api_gateway_domain_name#types ApiGatewayDomainName#types}.


ApiGatewayDomainNameMutualTlsAuthentication

Initializer

using HashiCorp.Cdktf.Providers.Aws;

new ApiGatewayDomainNameMutualTlsAuthentication {
    string TruststoreUri,
    string TruststoreVersion = null
};

Properties

Name Type Description
TruststoreUri string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/api_gateway_domain_name#truststore_uri ApiGatewayDomainName#truststore_uri}.
TruststoreVersion string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/api_gateway_domain_name#truststore_version ApiGatewayDomainName#truststore_version}.

TruststoreUriRequired
public string TruststoreUri { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/api_gateway_domain_name#truststore_uri ApiGatewayDomainName#truststore_uri}.


TruststoreVersionOptional
public string TruststoreVersion { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/api_gateway_domain_name#truststore_version ApiGatewayDomainName#truststore_version}.


Classes

ApiGatewayDomainNameEndpointConfigurationOutputReference

Initializers

using HashiCorp.Cdktf.Providers.Aws;

new ApiGatewayDomainNameEndpointConfigurationOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute);
Name Type Description
TerraformResource HashiCorp.Cdktf.IInterpolatingParent The parent resource.
TerraformAttribute string The attribute on the parent resource this class is referencing.

TerraformResourceRequired
  • Type: HashiCorp.Cdktf.IInterpolatingParent

The parent resource.


TerraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.


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.
TypesInput string[] No description.
Types string[] No description.
InternalValue ApiGatewayDomainNameEndpointConfiguration 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

TypesInputOptional
public string[] TypesInput { get; }
  • Type: string[]

TypesRequired
public string[] Types { get; }
  • Type: string[]

InternalValueOptional
public ApiGatewayDomainNameEndpointConfiguration InternalValue { get; }

ApiGatewayDomainNameMutualTlsAuthenticationOutputReference

Initializers

using HashiCorp.Cdktf.Providers.Aws;

new ApiGatewayDomainNameMutualTlsAuthenticationOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute);
Name Type Description
TerraformResource HashiCorp.Cdktf.IInterpolatingParent The parent resource.
TerraformAttribute string The attribute on the parent resource this class is referencing.

TerraformResourceRequired
  • Type: HashiCorp.Cdktf.IInterpolatingParent

The parent resource.


TerraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.


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.
ResetTruststoreVersion No description.

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.

ResetTruststoreVersion
private void ResetTruststoreVersion()

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.
TruststoreUriInput string No description.
TruststoreVersionInput string No description.
TruststoreUri string No description.
TruststoreVersion string No description.
InternalValue ApiGatewayDomainNameMutualTlsAuthentication 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

TruststoreUriInputOptional
public string TruststoreUriInput { get; }
  • Type: string

TruststoreVersionInputOptional
public string TruststoreVersionInput { get; }
  • Type: string

TruststoreUriRequired
public string TruststoreUri { get; }
  • Type: string

TruststoreVersionRequired
public string TruststoreVersion { get; }
  • Type: string

InternalValueOptional
public ApiGatewayDomainNameMutualTlsAuthentication InternalValue { get; }