Represents a {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.18.1/docs/resources/google_apigee_instance google_apigee_instance}.
using HashiCorp.Cdktf.Providers.GoogleBeta;
new GoogleApigeeInstance(Construct Scope, string Id, GoogleApigeeInstanceConfig Config);
Name | Type | Description |
---|---|---|
Scope |
Constructs.Construct |
The scope in which to define this construct. |
Id |
string |
The scoped construct ID. |
Config |
GoogleApigeeInstanceConfig |
No description. |
- Type: Constructs.Construct
The scope in which to define this construct.
- Type: string
The scoped construct ID.
Must be unique amongst siblings in the same scope
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". |
PutTimeouts |
No description. |
ResetConsumerAcceptList |
No description. |
ResetDescription |
No description. |
ResetDiskEncryptionKeyName |
No description. |
ResetDisplayName |
No description. |
ResetId |
No description. |
ResetIpRange |
No description. |
ResetPeeringCidrRange |
No description. |
ResetTimeouts |
No description. |
private string ToString()
Returns a string representation of this construct.
private void AddOverride(string Path, object Value)
- Type: string
- Type: object
private void OverrideLogicalId(string NewLogicalId)
Overrides the auto-generated logical ID with a specific ID.
- Type: string
The new logical ID to use for this stack element.
private void ResetOverrideLogicalId()
Resets a previously passed logical Id to use the auto-generated logical id again.
private object ToHclTerraform()
private object ToMetadata()
private object ToTerraform()
Adds this resource to the terraform JSON output.
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.
- Type: string
The string move target that will correspond to this resource.
private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)
- Type: string
private IResolvable GetBooleanAttribute(string TerraformAttribute)
- Type: string
private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)
- Type: string
private string[] GetListAttribute(string TerraformAttribute)
- Type: string
private double GetNumberAttribute(string TerraformAttribute)
- Type: string
private double[] GetNumberListAttribute(string TerraformAttribute)
- Type: string
private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)
- Type: string
private string GetStringAttribute(string TerraformAttribute)
- Type: string
private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)
- Type: string
private object HasResourceMove()
private void ImportFrom(string Id, TerraformProvider Provider = null)
- Type: string
- Type: HashiCorp.Cdktf.TerraformProvider
private IResolvable InterpolationForAttribute(string TerraformAttribute)
- Type: string
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.
- Type: string
Full id of resource being moved from, e.g. "aws_s3_bucket.example".
private void MoveTo(string MoveTarget, object Index = null)
Moves this resource to the target resource given by moveTarget.
- Type: string
The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.
- Type: object
Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.
private void MoveToId(string Id)
Moves this resource to the resource corresponding to "id".
- Type: string
Full id of resource to move to, e.g. "aws_s3_bucket.example".
private void PutTimeouts(GoogleApigeeInstanceTimeouts Value)
private void ResetConsumerAcceptList()
private void ResetDescription()
private void ResetDiskEncryptionKeyName()
private void ResetDisplayName()
private void ResetId()
private void ResetIpRange()
private void ResetPeeringCidrRange()
private void ResetTimeouts()
Name | Description |
---|---|
IsConstruct |
Checks if x is a construct. |
IsTerraformElement |
No description. |
IsTerraformResource |
No description. |
GenerateConfigForImport |
Generates CDKTF code for importing a GoogleApigeeInstance resource upon running "cdktf plan ". |
using HashiCorp.Cdktf.Providers.GoogleBeta;
GoogleApigeeInstance.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.
- Type: object
Any object.
using HashiCorp.Cdktf.Providers.GoogleBeta;
GoogleApigeeInstance.IsTerraformElement(object X);
- Type: object
using HashiCorp.Cdktf.Providers.GoogleBeta;
GoogleApigeeInstance.IsTerraformResource(object X);
- Type: object
using HashiCorp.Cdktf.Providers.GoogleBeta;
GoogleApigeeInstance.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null);
Generates CDKTF code for importing a GoogleApigeeInstance resource upon running "cdktf plan ".
- Type: Constructs.Construct
The scope in which to define this construct.
- Type: string
The construct id used in the generated config for the GoogleApigeeInstance to import.
- Type: string
The id of the existing GoogleApigeeInstance that should be imported.
Refer to the {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.18.1/docs/resources/google_apigee_instance#import import section} in the documentation of this resource for the id to use
- Type: HashiCorp.Cdktf.TerraformProvider
? Optional instance of the provider where the GoogleApigeeInstance to import is found.
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. |
Host |
string |
No description. |
Port |
string |
No description. |
ServiceAttachment |
string |
No description. |
Timeouts |
GoogleApigeeInstanceTimeoutsOutputReference |
No description. |
ConsumerAcceptListInput |
string[] |
No description. |
DescriptionInput |
string |
No description. |
DiskEncryptionKeyNameInput |
string |
No description. |
DisplayNameInput |
string |
No description. |
IdInput |
string |
No description. |
IpRangeInput |
string |
No description. |
LocationInput |
string |
No description. |
NameInput |
string |
No description. |
OrgIdInput |
string |
No description. |
PeeringCidrRangeInput |
string |
No description. |
TimeoutsInput |
object |
No description. |
ConsumerAcceptList |
string[] |
No description. |
Description |
string |
No description. |
DiskEncryptionKeyName |
string |
No description. |
DisplayName |
string |
No description. |
Id |
string |
No description. |
IpRange |
string |
No description. |
Location |
string |
No description. |
Name |
string |
No description. |
OrgId |
string |
No description. |
PeeringCidrRange |
string |
No description. |
public Node Node { get; }
- Type: Constructs.Node
The tree node.
public TerraformStack CdktfStack { get; }
- Type: HashiCorp.Cdktf.TerraformStack
public string Fqn { get; }
- Type: string
public string FriendlyUniqueId { get; }
- Type: string
public System.Collections.Generic.IDictionary<string, object> TerraformMetaArguments { get; }
- Type: System.Collections.Generic.IDictionary<string, object>
public string TerraformResourceType { get; }
- Type: string
public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }
- Type: HashiCorp.Cdktf.TerraformProviderGeneratorMetadata
public object Connection { get; }
- Type: object
public object Count { get; }
- Type: object
public string[] DependsOn { get; }
- Type: string[]
public ITerraformIterator ForEach { get; }
- Type: HashiCorp.Cdktf.ITerraformIterator
public TerraformResourceLifecycle Lifecycle { get; }
- Type: HashiCorp.Cdktf.TerraformResourceLifecycle
public TerraformProvider Provider { get; }
- Type: HashiCorp.Cdktf.TerraformProvider
public object[] Provisioners { get; }
- Type: object[]
public string Host { get; }
- Type: string
public string Port { get; }
- Type: string
public string ServiceAttachment { get; }
- Type: string
public GoogleApigeeInstanceTimeoutsOutputReference Timeouts { get; }
public string[] ConsumerAcceptListInput { get; }
- Type: string[]
public string DescriptionInput { get; }
- Type: string
public string DiskEncryptionKeyNameInput { get; }
- Type: string
public string DisplayNameInput { get; }
- Type: string
public string IdInput { get; }
- Type: string
public string IpRangeInput { get; }
- Type: string
public string LocationInput { get; }
- Type: string
public string NameInput { get; }
- Type: string
public string OrgIdInput { get; }
- Type: string
public string PeeringCidrRangeInput { get; }
- Type: string
public object TimeoutsInput { get; }
- Type: object
public string[] ConsumerAcceptList { get; }
- Type: string[]
public string Description { get; }
- Type: string
public string DiskEncryptionKeyName { get; }
- Type: string
public string DisplayName { get; }
- Type: string
public string Id { get; }
- Type: string
public string IpRange { get; }
- Type: string
public string Location { get; }
- Type: string
public string Name { get; }
- Type: string
public string OrgId { get; }
- Type: string
public string PeeringCidrRange { get; }
- Type: string
Name | Type | Description |
---|---|---|
TfResourceType |
string |
No description. |
public string TfResourceType { get; }
- Type: string
using HashiCorp.Cdktf.Providers.GoogleBeta;
new GoogleApigeeInstanceConfig {
object Connection = null,
object Count = null,
ITerraformDependable[] DependsOn = null,
ITerraformIterator ForEach = null,
TerraformResourceLifecycle Lifecycle = null,
TerraformProvider Provider = null,
object[] Provisioners = null,
string Location,
string Name,
string OrgId,
string[] ConsumerAcceptList = null,
string Description = null,
string DiskEncryptionKeyName = null,
string DisplayName = null,
string Id = null,
string IpRange = null,
string PeeringCidrRange = null,
GoogleApigeeInstanceTimeouts Timeouts = null
};
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. |
Location |
string |
Required. Compute Engine location where the instance resides. |
Name |
string |
Resource ID of the instance. |
OrgId |
string |
The Apigee Organization associated with the Apigee instance, in the format 'organizations/{{org_name}}'. |
ConsumerAcceptList |
string[] |
Optional. |
Description |
string |
Description of the instance. |
DiskEncryptionKeyName |
string |
Customer Managed Encryption Key (CMEK) used for disk and volume encryption. |
DisplayName |
string |
Display name of the instance. |
Id |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.18.1/docs/resources/google_apigee_instance#id GoogleApigeeInstance#id}. |
IpRange |
string |
IP range represents the customer-provided CIDR block of length 22 that will be used for the Apigee instance creation. |
PeeringCidrRange |
string |
The size of the CIDR block range that will be reserved by the instance. |
Timeouts |
GoogleApigeeInstanceTimeouts |
timeouts block. |
public object Connection { get; set; }
- Type: object
public object Count { get; set; }
- Type: object
public ITerraformDependable[] DependsOn { get; set; }
- Type: HashiCorp.Cdktf.ITerraformDependable[]
public ITerraformIterator ForEach { get; set; }
- Type: HashiCorp.Cdktf.ITerraformIterator
public TerraformResourceLifecycle Lifecycle { get; set; }
- Type: HashiCorp.Cdktf.TerraformResourceLifecycle
public TerraformProvider Provider { get; set; }
- Type: HashiCorp.Cdktf.TerraformProvider
public object[] Provisioners { get; set; }
- Type: object[]
public string Location { get; set; }
- Type: string
Required. Compute Engine location where the instance resides.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.18.1/docs/resources/google_apigee_instance#location GoogleApigeeInstance#location}
public string Name { get; set; }
- Type: string
Resource ID of the instance.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.18.1/docs/resources/google_apigee_instance#name GoogleApigeeInstance#name}
public string OrgId { get; set; }
- Type: string
The Apigee Organization associated with the Apigee instance, in the format 'organizations/{{org_name}}'.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.18.1/docs/resources/google_apigee_instance#org_id GoogleApigeeInstance#org_id}
public string[] ConsumerAcceptList { get; set; }
- Type: string[]
Optional.
Customer accept list represents the list of projects (id/number) on customer side that can privately connect to the service attachment. It is an optional field which the customers can provide during the instance creation. By default, the customer project associated with the Apigee organization will be included to the list.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.18.1/docs/resources/google_apigee_instance#consumer_accept_list GoogleApigeeInstance#consumer_accept_list}
public string Description { get; set; }
- Type: string
Description of the instance.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.18.1/docs/resources/google_apigee_instance#description GoogleApigeeInstance#description}
public string DiskEncryptionKeyName { get; set; }
- Type: string
Customer Managed Encryption Key (CMEK) used for disk and volume encryption.
Required for Apigee paid subscriptions only. Use the following format: 'projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)'
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.18.1/docs/resources/google_apigee_instance#disk_encryption_key_name GoogleApigeeInstance#disk_encryption_key_name}
public string DisplayName { get; set; }
- Type: string
Display name of the instance.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.18.1/docs/resources/google_apigee_instance#display_name GoogleApigeeInstance#display_name}
public string Id { get; set; }
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.18.1/docs/resources/google_apigee_instance#id GoogleApigeeInstance#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.
public string IpRange { get; set; }
- Type: string
IP range represents the customer-provided CIDR block of length 22 that will be used for the Apigee instance creation.
This optional range, if provided, should be freely available as part of larger named range the customer has allocated to the Service Networking peering. If this is not provided, Apigee will automatically request for any available /22 CIDR block from Service Networking. The customer should use this CIDR block for configuring their firewall needs to allow traffic from Apigee. Input format: "a.b.c.d/22"
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.18.1/docs/resources/google_apigee_instance#ip_range GoogleApigeeInstance#ip_range}
public string PeeringCidrRange { get; set; }
- Type: string
The size of the CIDR block range that will be reserved by the instance.
For valid values, see CidrRange on the documentation.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.18.1/docs/resources/google_apigee_instance#peering_cidr_range GoogleApigeeInstance#peering_cidr_range}
public GoogleApigeeInstanceTimeouts Timeouts { get; set; }
timeouts block.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.18.1/docs/resources/google_apigee_instance#timeouts GoogleApigeeInstance#timeouts}
using HashiCorp.Cdktf.Providers.GoogleBeta;
new GoogleApigeeInstanceTimeouts {
string Create = null,
string Delete = null,
string Update = null
};
Name | Type | Description |
---|---|---|
Create |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.18.1/docs/resources/google_apigee_instance#create GoogleApigeeInstance#create}. |
Delete |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.18.1/docs/resources/google_apigee_instance#delete GoogleApigeeInstance#delete}. |
Update |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.18.1/docs/resources/google_apigee_instance#update GoogleApigeeInstance#update}. |
public string Create { get; set; }
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.18.1/docs/resources/google_apigee_instance#create GoogleApigeeInstance#create}.
public string Delete { get; set; }
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.18.1/docs/resources/google_apigee_instance#delete GoogleApigeeInstance#delete}.
public string Update { get; set; }
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.18.1/docs/resources/google_apigee_instance#update GoogleApigeeInstance#update}.
using HashiCorp.Cdktf.Providers.GoogleBeta;
new GoogleApigeeInstanceTimeoutsOutputReference(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. |
- Type: HashiCorp.Cdktf.IInterpolatingParent
The parent resource.
- Type: string
The attribute on the parent resource this class is referencing.
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. |
ResetCreate |
No description. |
ResetDelete |
No description. |
ResetUpdate |
No description. |
private string ComputeFqn()
private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)
- Type: string
private IResolvable GetBooleanAttribute(string TerraformAttribute)
- Type: string
private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)
- Type: string
private string[] GetListAttribute(string TerraformAttribute)
- Type: string
private double GetNumberAttribute(string TerraformAttribute)
- Type: string
private double[] GetNumberListAttribute(string TerraformAttribute)
- Type: string
private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)
- Type: string
private string GetStringAttribute(string TerraformAttribute)
- Type: string
private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)
- Type: string
private IResolvable InterpolationForAttribute(string Property)
- Type: string
private object Resolve(IResolveContext Context)
Produce the Token's value at resolution time.
- Type: HashiCorp.Cdktf.IResolveContext
private string ToString()
Return a string representation of this resolvable object.
Returns a reversible string representation.
private void ResetCreate()
private void ResetDelete()
private void ResetUpdate()
Name | Type | Description |
---|---|---|
CreationStack |
string[] |
The creation stack of this resolvable which will be appended to errors thrown during resolution. |
Fqn |
string |
No description. |
CreateInput |
string |
No description. |
DeleteInput |
string |
No description. |
UpdateInput |
string |
No description. |
Create |
string |
No description. |
Delete |
string |
No description. |
Update |
string |
No description. |
InternalValue |
object |
No description. |
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.
public string Fqn { get; }
- Type: string
public string CreateInput { get; }
- Type: string
public string DeleteInput { get; }
- Type: string
public string UpdateInput { get; }
- Type: string
public string Create { get; }
- Type: string
public string Delete { get; }
- Type: string
public string Update { get; }
- Type: string
public object InternalValue { get; }
- Type: object