datahcppackerimage

README

data_hcp_packer_image

Refer to the Terraform Registory for docs: data_hcp_packer_image.

Documentation

Index

• func DataHcpPackerImage_IsConstruct(x interface{}) *bool
• func DataHcpPackerImage_IsTerraformDataSource(x interface{}) *bool
• func DataHcpPackerImage_IsTerraformElement(x interface{}) *bool
• func DataHcpPackerImage_TfResourceType() *string
• func NewDataHcpPackerImageTimeoutsOutputReference_Override(d DataHcpPackerImageTimeoutsOutputReference, ...)
• func NewDataHcpPackerImage_Override(d DataHcpPackerImage, scope constructs.Construct, id *string, ...)
• type DataHcpPackerImage
  • func NewDataHcpPackerImage(scope constructs.Construct, id *string, config *DataHcpPackerImageConfig) DataHcpPackerImage
• type DataHcpPackerImageConfig
• type DataHcpPackerImageTimeouts
• type DataHcpPackerImageTimeoutsOutputReference
  • func NewDataHcpPackerImageTimeoutsOutputReference(terraformResource cdktf.IInterpolatingParent, terraformAttribute *string) DataHcpPackerImageTimeoutsOutputReference

Functions

func DataHcpPackerImage_IsConstruct

func DataHcpPackerImage_IsConstruct(x interface{}) *bool

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.

Returns: true if `x` is an object created from a class which extends `Construct`.

func DataHcpPackerImage_IsTerraformDataSource

func DataHcpPackerImage_IsTerraformDataSource(x interface{}) *bool

Experimental.

func DataHcpPackerImage_IsTerraformElement

func DataHcpPackerImage_IsTerraformElement(x interface{}) *bool

Experimental.

func DataHcpPackerImage_TfResourceType

func DataHcpPackerImage_TfResourceType() *string

func NewDataHcpPackerImageTimeoutsOutputReference_Override

func NewDataHcpPackerImageTimeoutsOutputReference_Override(d DataHcpPackerImageTimeoutsOutputReference, terraformResource cdktf.IInterpolatingParent, terraformAttribute *string)

func NewDataHcpPackerImage_Override

func NewDataHcpPackerImage_Override(d DataHcpPackerImage, scope constructs.Construct, id *string, config *DataHcpPackerImageConfig)

Create a new {@link https://registry.terraform.io/providers/hashicorp/hcp/0.67.0/docs/data-sources/packer_image hcp_packer_image} Data Source.

Types

type DataHcpPackerImage

type DataHcpPackerImage interface {
	cdktf.TerraformDataSource
	BucketName() *string
	SetBucketName(val *string)
	BucketNameInput() *string
	BuildId() *string
	// Experimental.
	CdktfStack() cdktf.TerraformStack
	Channel() *string
	SetChannel(val *string)
	ChannelInput() *string
	CloudImageId() *string
	CloudProvider() *string
	SetCloudProvider(val *string)
	CloudProviderInput() *string
	ComponentType() *string
	SetComponentType(val *string)
	ComponentTypeInput() *string
	// Experimental.
	ConstructNodeMetadata() *map[string]interface{}
	// Experimental.
	Count() interface{}
	// Experimental.
	SetCount(val interface{})
	CreatedAt() *string
	// Experimental.
	DependsOn() *[]*string
	// Experimental.
	SetDependsOn(val *[]*string)
	// Experimental.
	ForEach() cdktf.ITerraformIterator
	// Experimental.
	SetForEach(val cdktf.ITerraformIterator)
	// Experimental.
	Fqn() *string
	// Experimental.
	FriendlyUniqueId() *string
	Id() *string
	SetId(val *string)
	IdInput() *string
	IterationId() *string
	SetIterationId(val *string)
	IterationIdInput() *string
	Labels() cdktf.StringMap
	// Experimental.
	Lifecycle() *cdktf.TerraformResourceLifecycle
	// Experimental.
	SetLifecycle(val *cdktf.TerraformResourceLifecycle)
	// The tree node.
	Node() constructs.Node
	OrganizationId() *string
	PackerRunUuid() *string
	ProjectId() *string
	SetProjectId(val *string)
	ProjectIdInput() *string
	// Experimental.
	Provider() cdktf.TerraformProvider
	// Experimental.
	SetProvider(val cdktf.TerraformProvider)
	// Experimental.
	RawOverrides() interface{}
	Region() *string
	SetRegion(val *string)
	RegionInput() *string
	RevokeAt() *string
	// Experimental.
	TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata
	// Experimental.
	TerraformMetaArguments() *map[string]interface{}
	// Experimental.
	TerraformResourceType() *string
	Timeouts() DataHcpPackerImageTimeoutsOutputReference
	TimeoutsInput() interface{}
	// Experimental.
	AddOverride(path *string, value interface{})
	// Experimental.
	GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
	// Experimental.
	GetBooleanAttribute(terraformAttribute *string) cdktf.IResolvable
	// Experimental.
	GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
	// Experimental.
	GetListAttribute(terraformAttribute *string) *[]*string
	// Experimental.
	GetNumberAttribute(terraformAttribute *string) *float64
	// Experimental.
	GetNumberListAttribute(terraformAttribute *string) *[]*float64
	// Experimental.
	GetNumberMapAttribute(terraformAttribute *string) *map[string]*float64
	// Experimental.
	GetStringAttribute(terraformAttribute *string) *string
	// Experimental.
	GetStringMapAttribute(terraformAttribute *string) *map[string]*string
	// Experimental.
	InterpolationForAttribute(terraformAttribute *string) cdktf.IResolvable
	// Overrides the auto-generated logical ID with a specific ID.
	// Experimental.
	OverrideLogicalId(newLogicalId *string)
	PutTimeouts(value *DataHcpPackerImageTimeouts)
	ResetChannel()
	ResetComponentType()
	ResetId()
	ResetIterationId()
	// Resets a previously passed logical Id to use the auto-generated logical id again.
	// Experimental.
	ResetOverrideLogicalId()
	ResetProjectId()
	ResetTimeouts()
	SynthesizeAttributes() *map[string]interface{}
	// Experimental.
	ToMetadata() interface{}
	// Returns a string representation of this construct.
	ToString() *string
	// Adds this resource to the terraform JSON output.
	// Experimental.
	ToTerraform() interface{}
}

Represents a {@link https://registry.terraform.io/providers/hashicorp/hcp/0.67.0/docs/data-sources/packer_image hcp_packer_image}.

func NewDataHcpPackerImage

func NewDataHcpPackerImage(scope constructs.Construct, id *string, config *DataHcpPackerImageConfig) DataHcpPackerImage

Create a new {@link https://registry.terraform.io/providers/hashicorp/hcp/0.67.0/docs/data-sources/packer_image hcp_packer_image} Data Source.

type DataHcpPackerImageConfig

type DataHcpPackerImageConfig struct {
	// Experimental.
	Connection interface{} `field:"optional" json:"connection" yaml:"connection"`
	// Experimental.
	Count interface{} `field:"optional" json:"count" yaml:"count"`
	// Experimental.
	DependsOn *[]cdktf.ITerraformDependable `field:"optional" json:"dependsOn" yaml:"dependsOn"`
	// Experimental.
	ForEach cdktf.ITerraformIterator `field:"optional" json:"forEach" yaml:"forEach"`
	// Experimental.
	Lifecycle *cdktf.TerraformResourceLifecycle `field:"optional" json:"lifecycle" yaml:"lifecycle"`
	// Experimental.
	Provider cdktf.TerraformProvider `field:"optional" json:"provider" yaml:"provider"`
	// Experimental.
	Provisioners *[]interface{} `field:"optional" json:"provisioners" yaml:"provisioners"`
	// The slug of the HCP Packer Registry bucket to pull from.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.67.0/docs/data-sources/packer_image#bucket_name DataHcpPackerImage#bucket_name}
	BucketName *string `field:"required" json:"bucketName" yaml:"bucketName"`
	// Name of the cloud provider this image is stored-in.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.67.0/docs/data-sources/packer_image#cloud_provider DataHcpPackerImage#cloud_provider}
	CloudProvider *string `field:"required" json:"cloudProvider" yaml:"cloudProvider"`
	// Region this image is stored in, if any.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.67.0/docs/data-sources/packer_image#region DataHcpPackerImage#region}
	Region *string `field:"required" json:"region" yaml:"region"`
	// The channel that points to the version of the image being retrieved.
	//
	// Either this or `iteration_id` must be specified. Note: will incur a billable request
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.67.0/docs/data-sources/packer_image#channel DataHcpPackerImage#channel}
	Channel *string `field:"optional" json:"channel" yaml:"channel"`
	// Name of the builder that built this image. Ex: `amazon-ebs.example`.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.67.0/docs/data-sources/packer_image#component_type DataHcpPackerImage#component_type}
	ComponentType *string `field:"optional" json:"componentType" yaml:"componentType"`
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.67.0/docs/data-sources/packer_image#id DataHcpPackerImage#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.
	Id *string `field:"optional" json:"id" yaml:"id"`
	// The iteration from which to get the image. Either this or `channel` must be specified.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.67.0/docs/data-sources/packer_image#iteration_id DataHcpPackerImage#iteration_id}
	IterationId *string `field:"optional" json:"iterationId" yaml:"iterationId"`
	// The ID of the HCP project where the HCP Packer Registry image is located.
	//
	// If not specified, the project specified in the HCP Provider config block will be used, if configured.
	// If a project is not configured in the HCP Provider config block, the oldest project in the organization will be used.
	//
	//  Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.67.0/docs/data-sources/packer_image#project_id DataHcpPackerImage#project_id}
	ProjectId *string `field:"optional" json:"projectId" yaml:"projectId"`
	// timeouts block.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.67.0/docs/data-sources/packer_image#timeouts DataHcpPackerImage#timeouts}
	Timeouts *DataHcpPackerImageTimeouts `field:"optional" json:"timeouts" yaml:"timeouts"`
}

type DataHcpPackerImageTimeouts

type DataHcpPackerImageTimeouts struct {
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.67.0/docs/data-sources/packer_image#default DataHcpPackerImage#default}.
	Default *string `field:"optional" json:"default" yaml:"default"`
}

type DataHcpPackerImageTimeoutsOutputReference

type DataHcpPackerImageTimeoutsOutputReference interface {
	cdktf.ComplexObject
	// the index of the complex object in a list.
	// Experimental.
	ComplexObjectIndex() interface{}
	// Experimental.
	SetComplexObjectIndex(val interface{})
	// set to true if this item is from inside a set and needs tolist() for accessing it set to "0" for single list items.
	// Experimental.
	ComplexObjectIsFromSet() *bool
	// Experimental.
	SetComplexObjectIsFromSet(val *bool)
	// 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.
	// Experimental.
	CreationStack() *[]*string
	Default() *string
	SetDefault(val *string)
	DefaultInput() *string
	// Experimental.
	Fqn() *string
	InternalValue() interface{}
	SetInternalValue(val interface{})
	// Experimental.
	TerraformAttribute() *string
	// Experimental.
	SetTerraformAttribute(val *string)
	// Experimental.
	TerraformResource() cdktf.IInterpolatingParent
	// Experimental.
	SetTerraformResource(val cdktf.IInterpolatingParent)
	// Experimental.
	ComputeFqn() *string
	// Experimental.
	GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
	// Experimental.
	GetBooleanAttribute(terraformAttribute *string) cdktf.IResolvable
	// Experimental.
	GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
	// Experimental.
	GetListAttribute(terraformAttribute *string) *[]*string
	// Experimental.
	GetNumberAttribute(terraformAttribute *string) *float64
	// Experimental.
	GetNumberListAttribute(terraformAttribute *string) *[]*float64
	// Experimental.
	GetNumberMapAttribute(terraformAttribute *string) *map[string]*float64
	// Experimental.
	GetStringAttribute(terraformAttribute *string) *string
	// Experimental.
	GetStringMapAttribute(terraformAttribute *string) *map[string]*string
	// Experimental.
	InterpolationAsList() cdktf.IResolvable
	// Experimental.
	InterpolationForAttribute(property *string) cdktf.IResolvable
	ResetDefault()
	// Produce the Token's value at resolution time.
	// Experimental.
	Resolve(_context cdktf.IResolveContext) interface{}
	// Return a string representation of this resolvable object.
	//
	// Returns a reversible string representation.
	// Experimental.
	ToString() *string
}

func NewDataHcpPackerImageTimeoutsOutputReference

func NewDataHcpPackerImageTimeoutsOutputReference(terraformResource cdktf.IInterpolatingParent, terraformAttribute *string) DataHcpPackerImageTimeoutsOutputReference