Skip to content

Latest commit

 

History

History
1092 lines (687 loc) · 45.7 KB

File metadata and controls

1092 lines (687 loc) · 45.7 KB

dataGoogleComputeImage Submodule

Constructs

DataGoogleComputeImage

Represents a {@link https://registry.terraform.io/providers/hashicorp/google/7.36.0/docs/data-sources/compute_image google_compute_image}.

Initializers

using Io.Cdktn.Providers.Google;

new DataGoogleComputeImage(Construct Scope, string Id, DataGoogleComputeImageConfig Config = null);
Name Type Description
Scope Constructs.Construct The scope in which to define this construct.
Id string The scoped construct ID.
Config DataGoogleComputeImageConfig 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


ConfigOptional

Methods

Name Description
ToString Returns a string representation of this construct.
With Applies one or more mixins to 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.
ResetFamily No description.
ResetFilter No description.
ResetId No description.
ResetMostRecent No description.
ResetName No description.
ResetProject No description.

ToString
private string ToString()

Returns a string representation of this construct.

With
private IConstruct With(params IMixin[] Mixins)

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

MixinsRequired
  • Type: params Constructs.IMixin[]

The mixins to apply.


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

ResetFamily
private void ResetFamily()
ResetFilter
private void ResetFilter()
ResetId
private void ResetId()
ResetMostRecent
private void ResetMostRecent()
ResetName
private void ResetName()
ResetProject
private void ResetProject()

Static Functions

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

IsConstruct
using Io.Cdktn.Providers.Google;

DataGoogleComputeImage.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 Io.Cdktn.Providers.Google;

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

IsTerraformDataSource
using Io.Cdktn.Providers.Google;

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

GenerateConfigForImport
using Io.Cdktn.Providers.Google;

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

Generates CDKTN code for importing a DataGoogleComputeImage resource upon running "cdktn 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 DataGoogleComputeImage to import.


ImportFromIdRequired
  • Type: string

The id of the existing DataGoogleComputeImage that should be imported.

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


ProviderOptional
  • Type: Io.Cdktn.TerraformProvider

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


Properties

Name Type Description
Node Constructs.Node The tree node.
CdktfStack Io.Cdktn.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 Io.Cdktn.TerraformProviderGeneratorMetadata No description.
Count double|Io.Cdktn.TerraformCount No description.
DependsOn string[] No description.
ForEach Io.Cdktn.ITerraformIterator No description.
Lifecycle Io.Cdktn.TerraformResourceLifecycle No description.
Provider Io.Cdktn.TerraformProvider No description.
ArchiveSizeBytes double No description.
CreationTimestamp string No description.
Description string No description.
DiskSizeGb double No description.
ImageEncryptionKeySha256 string No description.
ImageId string No description.
LabelFingerprint string No description.
Labels Io.Cdktn.StringMap No description.
Licenses string[] No description.
SelfLink string No description.
SourceDisk string No description.
SourceDiskEncryptionKeySha256 string No description.
SourceDiskId string No description.
SourceImageId string No description.
Status string No description.
FamilyInput string No description.
FilterInput string No description.
IdInput string No description.
MostRecentInput bool|Io.Cdktn.IResolvable No description.
NameInput string No description.
ProjectInput string No description.
Family string No description.
Filter string No description.
Id string No description.
MostRecent bool|Io.Cdktn.IResolvable No description.
Name string No description.
Project string No description.

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

The tree node.


CdktfStackRequired
public TerraformStack CdktfStack { get; }
  • Type: Io.Cdktn.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: Io.Cdktn.TerraformProviderGeneratorMetadata

CountOptional
public double|TerraformCount Count { get; }
  • Type: double|Io.Cdktn.TerraformCount

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

ForEachOptional
public ITerraformIterator ForEach { get; }
  • Type: Io.Cdktn.ITerraformIterator

LifecycleOptional
public TerraformResourceLifecycle Lifecycle { get; }
  • Type: Io.Cdktn.TerraformResourceLifecycle

ProviderOptional
public TerraformProvider Provider { get; }
  • Type: Io.Cdktn.TerraformProvider

ArchiveSizeBytesRequired
public double ArchiveSizeBytes { get; }
  • Type: double

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

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

DiskSizeGbRequired
public double DiskSizeGb { get; }
  • Type: double

ImageEncryptionKeySha256Required
public string ImageEncryptionKeySha256 { get; }
  • Type: string

ImageIdRequired
public string ImageId { get; }
  • Type: string

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

LabelsRequired
public StringMap Labels { get; }
  • Type: Io.Cdktn.StringMap

LicensesRequired
public string[] Licenses { get; }
  • Type: string[]

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

SourceDiskRequired
public string SourceDisk { get; }
  • Type: string

SourceDiskEncryptionKeySha256Required
public string SourceDiskEncryptionKeySha256 { get; }
  • Type: string

SourceDiskIdRequired
public string SourceDiskId { get; }
  • Type: string

SourceImageIdRequired
public string SourceImageId { get; }
  • Type: string

StatusRequired
public string Status { get; }
  • Type: string

FamilyInputOptional
public string FamilyInput { get; }
  • Type: string

FilterInputOptional
public string FilterInput { get; }
  • Type: string

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

MostRecentInputOptional
public bool|IResolvable MostRecentInput { get; }
  • Type: bool|Io.Cdktn.IResolvable

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

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

FamilyRequired
public string Family { get; }
  • Type: string

FilterRequired
public string Filter { get; }
  • Type: string

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

MostRecentRequired
public bool|IResolvable MostRecent { get; }
  • Type: bool|Io.Cdktn.IResolvable

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

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

Constants

Name Type Description
TfResourceType string No description.

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

Structs

DataGoogleComputeImageConfig

Initializer

using Io.Cdktn.Providers.Google;

new DataGoogleComputeImageConfig {
    SSHProvisionerConnection|WinrmProvisionerConnection Connection = null,
    double|TerraformCount Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners = null,
    string Family = null,
    string Filter = null,
    string Id = null,
    bool|IResolvable MostRecent = null,
    string Name = null,
    string Project = null
};

Properties

Name Type Description
Connection Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection No description.
Count double|Io.Cdktn.TerraformCount No description.
DependsOn Io.Cdktn.ITerraformDependable[] No description.
ForEach Io.Cdktn.ITerraformIterator No description.
Lifecycle Io.Cdktn.TerraformResourceLifecycle No description.
Provider Io.Cdktn.TerraformProvider No description.
Provisioners Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] No description.
Family string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.36.0/docs/data-sources/compute_image#family DataGoogleComputeImage#family}.
Filter string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.36.0/docs/data-sources/compute_image#filter DataGoogleComputeImage#filter}.
Id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.36.0/docs/data-sources/compute_image#id DataGoogleComputeImage#id}.
MostRecent bool|Io.Cdktn.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.36.0/docs/data-sources/compute_image#most_recent DataGoogleComputeImage#most_recent}.
Name string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.36.0/docs/data-sources/compute_image#name DataGoogleComputeImage#name}.
Project string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.36.0/docs/data-sources/compute_image#project DataGoogleComputeImage#project}.

ConnectionOptional
public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; }
  • Type: Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection

CountOptional
public double|TerraformCount Count { get; set; }
  • Type: double|Io.Cdktn.TerraformCount

DependsOnOptional
public ITerraformDependable[] DependsOn { get; set; }
  • Type: Io.Cdktn.ITerraformDependable[]

ForEachOptional
public ITerraformIterator ForEach { get; set; }
  • Type: Io.Cdktn.ITerraformIterator

LifecycleOptional
public TerraformResourceLifecycle Lifecycle { get; set; }
  • Type: Io.Cdktn.TerraformResourceLifecycle

ProviderOptional
public TerraformProvider Provider { get; set; }
  • Type: Io.Cdktn.TerraformProvider

ProvisionersOptional
public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; }
  • Type: Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[]

FamilyOptional
public string Family { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.36.0/docs/data-sources/compute_image#family DataGoogleComputeImage#family}.


FilterOptional
public string Filter { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.36.0/docs/data-sources/compute_image#filter DataGoogleComputeImage#filter}.


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

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


MostRecentOptional
public bool|IResolvable MostRecent { get; set; }
  • Type: bool|Io.Cdktn.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.36.0/docs/data-sources/compute_image#most_recent DataGoogleComputeImage#most_recent}.


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

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


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

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