Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/opensearch_package aws_opensearch_package}.
using HashiCorp.Cdktf.Providers.Aws;
new OpensearchPackage(Construct Scope, string Id, OpensearchPackageConfig Config);
Name | Type | Description |
---|---|---|
Scope |
Constructs.Construct |
The scope in which to define this construct. |
Id |
string |
The scoped construct ID. |
Config |
OpensearchPackageConfig |
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
- Type: OpensearchPackageConfig
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". |
PutPackageSource |
No description. |
ResetId |
No description. |
ResetPackageDescription |
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 PutPackageSource(OpensearchPackagePackageSource Value)
private void ResetId()
private void ResetPackageDescription()
Name | Description |
---|---|
IsConstruct |
Checks if x is a construct. |
IsTerraformElement |
No description. |
IsTerraformResource |
No description. |
GenerateConfigForImport |
Generates CDKTF code for importing a OpensearchPackage resource upon running "cdktf plan ". |
using HashiCorp.Cdktf.Providers.Aws;
OpensearchPackage.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.Aws;
OpensearchPackage.IsTerraformElement(object X);
- Type: object
using HashiCorp.Cdktf.Providers.Aws;
OpensearchPackage.IsTerraformResource(object X);
- Type: object
using HashiCorp.Cdktf.Providers.Aws;
OpensearchPackage.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null);
Generates CDKTF code for importing a OpensearchPackage 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 OpensearchPackage to import.
- Type: string
The id of the existing OpensearchPackage that should be imported.
Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/opensearch_package#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 OpensearchPackage 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. |
AvailablePackageVersion |
string |
No description. |
PackageId |
string |
No description. |
PackageSource |
OpensearchPackagePackageSourceOutputReference |
No description. |
IdInput |
string |
No description. |
PackageDescriptionInput |
string |
No description. |
PackageNameInput |
string |
No description. |
PackageSourceInput |
OpensearchPackagePackageSource |
No description. |
PackageTypeInput |
string |
No description. |
Id |
string |
No description. |
PackageDescription |
string |
No description. |
PackageName |
string |
No description. |
PackageType |
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 AvailablePackageVersion { get; }
- Type: string
public string PackageId { get; }
- Type: string
public OpensearchPackagePackageSourceOutputReference PackageSource { get; }
public string IdInput { get; }
- Type: string
public string PackageDescriptionInput { get; }
- Type: string
public string PackageNameInput { get; }
- Type: string
public OpensearchPackagePackageSource PackageSourceInput { get; }
public string PackageTypeInput { get; }
- Type: string
public string Id { get; }
- Type: string
public string PackageDescription { get; }
- Type: string
public string PackageName { get; }
- Type: string
public string PackageType { get; }
- Type: string
Name | Type | Description |
---|---|---|
TfResourceType |
string |
No description. |
public string TfResourceType { get; }
- Type: string
using HashiCorp.Cdktf.Providers.Aws;
new OpensearchPackageConfig {
object Connection = null,
object Count = null,
ITerraformDependable[] DependsOn = null,
ITerraformIterator ForEach = null,
TerraformResourceLifecycle Lifecycle = null,
TerraformProvider Provider = null,
object[] Provisioners = null,
string PackageName,
OpensearchPackagePackageSource PackageSource,
string PackageType,
string Id = null,
string PackageDescription = 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. |
PackageName |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/opensearch_package#package_name OpensearchPackage#package_name}. |
PackageSource |
OpensearchPackagePackageSource |
package_source block. |
PackageType |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/opensearch_package#package_type OpensearchPackage#package_type}. |
Id |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/opensearch_package#id OpensearchPackage#id}. |
PackageDescription |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/opensearch_package#package_description OpensearchPackage#package_description}. |
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 PackageName { get; set; }
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/opensearch_package#package_name OpensearchPackage#package_name}.
public OpensearchPackagePackageSource PackageSource { get; set; }
package_source block.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/opensearch_package#package_source OpensearchPackage#package_source}
public string PackageType { get; set; }
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/opensearch_package#package_type OpensearchPackage#package_type}.
public string Id { get; set; }
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/opensearch_package#id OpensearchPackage#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 PackageDescription { get; set; }
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/opensearch_package#package_description OpensearchPackage#package_description}.
using HashiCorp.Cdktf.Providers.Aws;
new OpensearchPackagePackageSource {
string S3BucketName,
string S3Key
};
Name | Type | Description |
---|---|---|
S3BucketName |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/opensearch_package#s3_bucket_name OpensearchPackage#s3_bucket_name}. |
S3Key |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/opensearch_package#s3_key OpensearchPackage#s3_key}. |
public string S3BucketName { get; set; }
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/opensearch_package#s3_bucket_name OpensearchPackage#s3_bucket_name}.
public string S3Key { get; set; }
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/opensearch_package#s3_key OpensearchPackage#s3_key}.
using HashiCorp.Cdktf.Providers.Aws;
new OpensearchPackagePackageSourceOutputReference(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. |
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.
Name | Type | Description |
---|---|---|
CreationStack |
string[] |
The creation stack of this resolvable which will be appended to errors thrown during resolution. |
Fqn |
string |
No description. |
S3BucketNameInput |
string |
No description. |
S3KeyInput |
string |
No description. |
S3BucketName |
string |
No description. |
S3Key |
string |
No description. |
InternalValue |
OpensearchPackagePackageSource |
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 S3BucketNameInput { get; }
- Type: string
public string S3KeyInput { get; }
- Type: string
public string S3BucketName { get; }
- Type: string
public string S3Key { get; }
- Type: string
public OpensearchPackagePackageSource InternalValue { get; }