dataHcpPackerArtifact.csharp.md

dataHcpPackerArtifact Submodule

Constructs

DataHcpPackerArtifact

Represents a {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/data-sources/packer_artifact hcp_packer_artifact}.

Initializers

using HashiCorp.Cdktf.Providers.Hcp;

new DataHcpPackerArtifact(Construct Scope, string Id, DataHcpPackerArtifactConfig Config);

Name	Type	Description
Scope	Constructs.Construct	The scope in which to define this construct.
Id	string	The scoped construct ID.
Config	DataHcpPackerArtifactConfig	No description.

---

Scope^Required

• Type: Constructs.Construct

The scope in which to define this construct.

---

Id^Required

• Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

---

Config^Required

• Type: DataHcpPackerArtifactConfig

---

Methods

Name	Description
ToString	Returns a string representation of this construct.
AddOverride	No description.
OverrideLogicalId	Overrides the auto-generated logical ID with a specific ID.
ResetOverrideLogicalId	Resets a previously passed logical Id to use the auto-generated logical id again.
ToHclTerraform	Adds this resource to the terraform JSON output.
ToMetadata	No description.
ToTerraform	Adds this resource to the terraform JSON output.
GetAnyMapAttribute	No description.
GetBooleanAttribute	No description.
GetBooleanMapAttribute	No description.
GetListAttribute	No description.
GetNumberAttribute	No description.
GetNumberListAttribute	No description.
GetNumberMapAttribute	No description.
GetStringAttribute	No description.
GetStringMapAttribute	No description.
InterpolationForAttribute	No description.
ResetChannelName	No description.
ResetComponentType	No description.
ResetProjectId	No description.
ResetVersionFingerprint	No description.

---

ToString

private string ToString()

Returns a string representation of this construct.

AddOverride

private void AddOverride(string Path, object Value)

Path^Required

• Type: string

---

Value^Required

• Type: object

---

OverrideLogicalId

private void OverrideLogicalId(string NewLogicalId)

Overrides the auto-generated logical ID with a specific ID.

NewLogicalId^Required

• 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)

TerraformAttribute^Required

• Type: string

---

GetBooleanAttribute

private IResolvable GetBooleanAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetBooleanMapAttribute

private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetListAttribute

private string[] GetListAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberAttribute

private double GetNumberAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberListAttribute

private double[] GetNumberListAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberMapAttribute

private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetStringAttribute

private string GetStringAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetStringMapAttribute

private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

InterpolationForAttribute

private IResolvable InterpolationForAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

ResetChannelName

private void ResetChannelName()

ResetComponentType

private void ResetComponentType()

ResetProjectId

private void ResetProjectId()

ResetVersionFingerprint

private void ResetVersionFingerprint()

Static Functions

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

---

IsConstruct

using HashiCorp.Cdktf.Providers.Hcp;

DataHcpPackerArtifact.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.

X^Required

• Type: object

Any object.

---

IsTerraformElement

using HashiCorp.Cdktf.Providers.Hcp;

DataHcpPackerArtifact.IsTerraformElement(object X);

X^Required

• Type: object

---

IsTerraformDataSource

using HashiCorp.Cdktf.Providers.Hcp;

DataHcpPackerArtifact.IsTerraformDataSource(object X);

X^Required

• Type: object

---

GenerateConfigForImport

using HashiCorp.Cdktf.Providers.Hcp;

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

Generates CDKTF code for importing a DataHcpPackerArtifact resource upon running "cdktf plan ".

Scope^Required

• Type: Constructs.Construct

The scope in which to define this construct.

---

ImportToId^Required

• Type: string

The construct id used in the generated config for the DataHcpPackerArtifact to import.

---

ImportFromId^Required

• Type: string

The id of the existing DataHcpPackerArtifact that should be imported.

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

---

Provider^Optional

• Type: HashiCorp.Cdktf.TerraformProvider

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

---

Properties

Name	Type	Description
Node	Constructs.Node	The tree node.
CdktfStack	HashiCorp.Cdktf.TerraformStack	No description.
Fqn	string	No description.
FriendlyUniqueId	string	No description.
TerraformMetaArguments	System.Collections.Generic.IDictionary<string, object>	No description.
TerraformResourceType	string	No description.
TerraformGeneratorMetadata	HashiCorp.Cdktf.TerraformProviderGeneratorMetadata	No description.
Count	object	No description.
DependsOn	string[]	No description.
ForEach	HashiCorp.Cdktf.ITerraformIterator	No description.
Lifecycle	HashiCorp.Cdktf.TerraformResourceLifecycle	No description.
Provider	HashiCorp.Cdktf.TerraformProvider	No description.
BuildId	string	No description.
CreatedAt	string	No description.
ExternalIdentifier	string	No description.
Id	string	No description.
Labels	HashiCorp.Cdktf.StringMap	No description.
OrganizationId	string	No description.
PackerRunUuid	string	No description.
RevokeAt	string	No description.
BucketNameInput	string	No description.
ChannelNameInput	string	No description.
ComponentTypeInput	string	No description.
PlatformInput	string	No description.
ProjectIdInput	string	No description.
RegionInput	string	No description.
VersionFingerprintInput	string	No description.
BucketName	string	No description.
ChannelName	string	No description.
ComponentType	string	No description.
Platform	string	No description.
ProjectId	string	No description.
Region	string	No description.
VersionFingerprint	string	No description.

---

Node^Required

public Node Node { get; }

• Type: Constructs.Node

The tree node.

---

CdktfStack^Required

public TerraformStack CdktfStack { get; }

• Type: HashiCorp.Cdktf.TerraformStack

---

Fqn^Required

public string Fqn { get; }

• Type: string

---

FriendlyUniqueId^Required

public string FriendlyUniqueId { get; }

• Type: string

---

TerraformMetaArguments^Required

public System.Collections.Generic.IDictionary<string, object> TerraformMetaArguments { get; }

• Type: System.Collections.Generic.IDictionary<string, object>

---

TerraformResourceType^Required

public string TerraformResourceType { get; }

• Type: string

---

TerraformGeneratorMetadata^Optional

public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }

• Type: HashiCorp.Cdktf.TerraformProviderGeneratorMetadata

---

Count^Optional

public object Count { get; }

• Type: object

---

DependsOn^Optional

public string[] DependsOn { get; }

• Type: string[]

---

ForEach^Optional

public ITerraformIterator ForEach { get; }

• Type: HashiCorp.Cdktf.ITerraformIterator

---

Lifecycle^Optional

public TerraformResourceLifecycle Lifecycle { get; }

• Type: HashiCorp.Cdktf.TerraformResourceLifecycle

---

Provider^Optional

public TerraformProvider Provider { get; }

• Type: HashiCorp.Cdktf.TerraformProvider

---

BuildId^Required

public string BuildId { get; }

• Type: string

---

CreatedAt^Required

public string CreatedAt { get; }

• Type: string

---

ExternalIdentifier^Required

public string ExternalIdentifier { get; }

• Type: string

---

Id^Required

public string Id { get; }

• Type: string

---

Labels^Required

public StringMap Labels { get; }

• Type: HashiCorp.Cdktf.StringMap

---

OrganizationId^Required

public string OrganizationId { get; }

• Type: string

---

PackerRunUuid^Required

public string PackerRunUuid { get; }

• Type: string

---

RevokeAt^Required

public string RevokeAt { get; }

• Type: string

---

BucketNameInput^Optional

public string BucketNameInput { get; }

• Type: string

---

ChannelNameInput^Optional

public string ChannelNameInput { get; }

• Type: string

---

ComponentTypeInput^Optional

public string ComponentTypeInput { get; }

• Type: string

---

PlatformInput^Optional

public string PlatformInput { get; }

• Type: string

---

ProjectIdInput^Optional

public string ProjectIdInput { get; }

• Type: string

---

RegionInput^Optional

public string RegionInput { get; }

• Type: string

---

VersionFingerprintInput^Optional

public string VersionFingerprintInput { get; }

• Type: string

---

BucketName^Required

public string BucketName { get; }

• Type: string

---

ChannelName^Required

public string ChannelName { get; }

• Type: string

---

ComponentType^Required

public string ComponentType { get; }

• Type: string

---

Platform^Required

public string Platform { get; }

• Type: string

---

ProjectId^Required

public string ProjectId { get; }

• Type: string

---

Region^Required

public string Region { get; }

• Type: string

---

VersionFingerprint^Required

public string VersionFingerprint { get; }

• Type: string

---

Constants

Name	Type	Description
TfResourceType	string	No description.

---

TfResourceType^Required

public string TfResourceType { get; }

• Type: string

---

Structs

DataHcpPackerArtifactConfig

Initializer

using HashiCorp.Cdktf.Providers.Hcp;

new DataHcpPackerArtifactConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    string BucketName,
    string Platform,
    string Region,
    string ChannelName = null,
    string ComponentType = null,
    string ProjectId = null,
    string VersionFingerprint = 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.
BucketName	string	The name of the HCP Packer Bucket where the Artifact is located.
Platform	string	Name of the platform where the HCP Packer Artifact is stored.
Region	string	The Region where the HCP Packer Artifact is stored, if any.
ChannelName	string	The name of the HCP Packer Channel the Version containing this Artifact is assigned to.
ComponentType	string	Name of the Packer builder that built this Artifact. Ex: amazon-ebs.example.
ProjectId	string	The ID of the HCP Organization where the Artifact is located.
VersionFingerprint	string	The fingerprint of the HCP Packer Version where the Artifact is located.

---

Connection^Optional

public object Connection { get; set; }

• Type: object

---

Count^Optional

public object Count { get; set; }

• Type: object

---

DependsOn^Optional

public ITerraformDependable[] DependsOn { get; set; }

• Type: HashiCorp.Cdktf.ITerraformDependable[]

---

ForEach^Optional

public ITerraformIterator ForEach { get; set; }

• Type: HashiCorp.Cdktf.ITerraformIterator

---

Lifecycle^Optional

public TerraformResourceLifecycle Lifecycle { get; set; }

• Type: HashiCorp.Cdktf.TerraformResourceLifecycle

---

Provider^Optional

public TerraformProvider Provider { get; set; }

• Type: HashiCorp.Cdktf.TerraformProvider

---

Provisioners^Optional

public object[] Provisioners { get; set; }

• Type: object[]

---

BucketName^Required

public string BucketName { get; set; }

• Type: string

The name of the HCP Packer Bucket where the Artifact is located.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/data-sources/packer_artifact#bucket_name DataHcpPackerArtifact#bucket_name}

---

Platform^Required

public string Platform { get; set; }

• Type: string

Name of the platform where the HCP Packer Artifact is stored.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/data-sources/packer_artifact#platform DataHcpPackerArtifact#platform}

---

Region^Required

public string Region { get; set; }

• Type: string

The Region where the HCP Packer Artifact is stored, if any.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/data-sources/packer_artifact#region DataHcpPackerArtifact#region}

---

ChannelName^Optional

public string ChannelName { get; set; }

• Type: string

The name of the HCP Packer Channel the Version containing this Artifact is assigned to.

The Version currently assigned to the Channel will be fetched. Exactly one of channel_name or version_fingerprint must be provided.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/data-sources/packer_artifact#channel_name DataHcpPackerArtifact#channel_name}

---

ComponentType^Optional

public string ComponentType { get; set; }

• Type: string

Name of the Packer builder that built this Artifact. Ex: amazon-ebs.example.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/data-sources/packer_artifact#component_type DataHcpPackerArtifact#component_type}

---

ProjectId^Optional

public string ProjectId { get; set; }

• Type: string

The ID of the HCP Organization where the Artifact is located.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/data-sources/packer_artifact#project_id DataHcpPackerArtifact#project_id}

---

VersionFingerprint^Optional

public string VersionFingerprint { get; set; }

• Type: string

The fingerprint of the HCP Packer Version where the Artifact is located.

If provided in the config, it is used to fetch the Version. Exactly one of channel_name or version_fingerprint must be provided.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/data-sources/packer_artifact#version_fingerprint DataHcpPackerArtifact#version_fingerprint}

---