secretsSyncAwsDestination.go.md

secretsSyncAwsDestination Submodule

Constructs

SecretsSyncAwsDestination

Represents a {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/secrets_sync_aws_destination vault_secrets_sync_aws_destination}.

Initializers

import "github.com/cdktf/cdktf-provider-vault-go/vault/v13/secretssyncawsdestination"

secretssyncawsdestination.NewSecretsSyncAwsDestination(scope Construct, id *string, config SecretsSyncAwsDestinationConfig) SecretsSyncAwsDestination

Name	Type	Description
scope	github.com/aws/constructs-go/constructs/v10.Construct	The scope in which to define this construct.
id	*string	The scoped construct ID.
config	SecretsSyncAwsDestinationConfig	No description.

---

scope^Required

• Type: github.com/aws/constructs-go/constructs/v10.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: SecretsSyncAwsDestinationConfig

---

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	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".
ResetAccessKeyId	No description.
ResetCustomTags	No description.
ResetExternalId	No description.
ResetGranularity	No description.
ResetId	No description.
ResetNamespace	No description.
ResetRegion	No description.
ResetRoleArn	No description.
ResetSecretAccessKey	No description.
ResetSecretNameTemplate	No description.

---

ToString

func ToString() *string

Returns a string representation of this construct.

AddOverride

func AddOverride(path *string, value interface{})

path^Required

• Type: *string

---

value^Required

• Type: interface{}

---

OverrideLogicalId

func OverrideLogicalId(newLogicalId *string)

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

func ResetOverrideLogicalId()

Resets a previously passed logical Id to use the auto-generated logical id again.

ToHclTerraform

func ToHclTerraform() interface{}

ToMetadata

func ToMetadata() interface{}

ToTerraform

func ToTerraform() interface{}

Adds this resource to the terraform JSON output.

AddMoveTarget

func AddMoveTarget(moveTarget *string)

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

moveTarget^Required

• Type: *string

The string move target that will correspond to this resource.

---

GetAnyMapAttribute

func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}

terraformAttribute^Required

• Type: *string

---

GetBooleanAttribute

func GetBooleanAttribute(terraformAttribute *string) IResolvable

terraformAttribute^Required

• Type: *string

---

GetBooleanMapAttribute

func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool

terraformAttribute^Required

• Type: *string

---

GetListAttribute

func GetListAttribute(terraformAttribute *string) *[]*string

terraformAttribute^Required

• Type: *string

---

GetNumberAttribute

func GetNumberAttribute(terraformAttribute *string) *f64

terraformAttribute^Required

• Type: *string

---

GetNumberListAttribute

func GetNumberListAttribute(terraformAttribute *string) *[]*f64

terraformAttribute^Required

• Type: *string

---

GetNumberMapAttribute

func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64

terraformAttribute^Required

• Type: *string

---

GetStringAttribute

func GetStringAttribute(terraformAttribute *string) *string

terraformAttribute^Required

• Type: *string

---

GetStringMapAttribute

func GetStringMapAttribute(terraformAttribute *string) *map[string]*string

terraformAttribute^Required

• Type: *string

---

HasResourceMove

func HasResourceMove() interface{}

ImportFrom

func ImportFrom(id *string, provider TerraformProvider)

id^Required

• Type: *string

---

provider^Optional

• Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

---

InterpolationForAttribute

func InterpolationForAttribute(terraformAttribute *string) IResolvable

terraformAttribute^Required

• Type: *string

---

MoveFromId

func MoveFromId(id *string)

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.

id^Required

• Type: *string

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

---

MoveTo

func MoveTo(moveTarget *string, index interface{})

Moves this resource to the target resource given by moveTarget.

moveTarget^Required

• Type: *string

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

---

index^Optional

• Type: interface{}

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

---

MoveToId

func MoveToId(id *string)

Moves this resource to the resource corresponding to "id".

id^Required

• Type: *string

Full id of resource to move to, e.g. "aws_s3_bucket.example".

---

ResetAccessKeyId

func ResetAccessKeyId()

ResetCustomTags

func ResetCustomTags()

ResetExternalId

func ResetExternalId()

ResetGranularity

func ResetGranularity()

ResetId

func ResetId()

ResetNamespace

func ResetNamespace()

ResetRegion

func ResetRegion()

ResetRoleArn

func ResetRoleArn()

ResetSecretAccessKey

func ResetSecretAccessKey()

ResetSecretNameTemplate

func ResetSecretNameTemplate()

Static Functions

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

---

IsConstruct

import "github.com/cdktf/cdktf-provider-vault-go/vault/v13/secretssyncawsdestination"

secretssyncawsdestination.SecretsSyncAwsDestination_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.

x^Required

• Type: interface{}

Any object.

---

IsTerraformElement

import "github.com/cdktf/cdktf-provider-vault-go/vault/v13/secretssyncawsdestination"

secretssyncawsdestination.SecretsSyncAwsDestination_IsTerraformElement(x interface{}) *bool

x^Required

• Type: interface{}

---

IsTerraformResource

import "github.com/cdktf/cdktf-provider-vault-go/vault/v13/secretssyncawsdestination"

secretssyncawsdestination.SecretsSyncAwsDestination_IsTerraformResource(x interface{}) *bool

x^Required

• Type: interface{}

---

GenerateConfigForImport

import "github.com/cdktf/cdktf-provider-vault-go/vault/v13/secretssyncawsdestination"

secretssyncawsdestination.SecretsSyncAwsDestination_GenerateConfigForImport(scope Construct, importToId *string, importFromId *string, provider TerraformProvider) ImportableResource

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

scope^Required

• Type: github.com/aws/constructs-go/constructs/v10.Construct

The scope in which to define this construct.

---

importToId^Required

• Type: *string

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

---

importFromId^Required

• Type: *string

The id of the existing SecretsSyncAwsDestination that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/secrets_sync_aws_destination#import import section} in the documentation of this resource for the id to use

---

provider^Optional

• Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

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

---

Properties

Name	Type	Description
Node	github.com/aws/constructs-go/constructs/v10.Node	The tree node.
CdktfStack	github.com/hashicorp/terraform-cdk-go/cdktf.TerraformStack	No description.
Fqn	*string	No description.
FriendlyUniqueId	*string	No description.
TerraformMetaArguments	*map[string]interface{}	No description.
TerraformResourceType	*string	No description.
TerraformGeneratorMetadata	github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProviderGeneratorMetadata	No description.
Connection	interface{}	No description.
Count	interface{}	No description.
DependsOn	*[]*string	No description.
ForEach	github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator	No description.
Lifecycle	github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle	No description.
Provider	github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider	No description.
Provisioners	*[]interface{}	No description.
Type	*string	No description.
AccessKeyIdInput	*string	No description.
CustomTagsInput	*map[string]*string	No description.
ExternalIdInput	*string	No description.
GranularityInput	*string	No description.
IdInput	*string	No description.
NameInput	*string	No description.
NamespaceInput	*string	No description.
RegionInput	*string	No description.
RoleArnInput	*string	No description.
SecretAccessKeyInput	*string	No description.
SecretNameTemplateInput	*string	No description.
AccessKeyId	*string	No description.
CustomTags	*map[string]*string	No description.
ExternalId	*string	No description.
Granularity	*string	No description.
Id	*string	No description.
Name	*string	No description.
Namespace	*string	No description.
Region	*string	No description.
RoleArn	*string	No description.
SecretAccessKey	*string	No description.
SecretNameTemplate	*string	No description.

---

Node^Required

func Node() Node

• Type: github.com/aws/constructs-go/constructs/v10.Node

The tree node.

---

CdktfStack^Required

func CdktfStack() TerraformStack

• Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformStack

---

Fqn^Required

func Fqn() *string

• Type: *string

---

FriendlyUniqueId^Required

func FriendlyUniqueId() *string

• Type: *string

---

TerraformMetaArguments^Required

func TerraformMetaArguments() *map[string]interface{}

• Type: *map[string]interface{}

---

TerraformResourceType^Required

func TerraformResourceType() *string

• Type: *string

---

TerraformGeneratorMetadata^Optional

func TerraformGeneratorMetadata() TerraformProviderGeneratorMetadata

• Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProviderGeneratorMetadata

---

Connection^Optional

func Connection() interface{}

• Type: interface{}

---

Count^Optional

func Count() interface{}

• Type: interface{}

---

DependsOn^Optional

func DependsOn() *[]*string

• Type: *[]*string

---

ForEach^Optional

func ForEach() ITerraformIterator

• Type: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator

---

Lifecycle^Optional

func Lifecycle() TerraformResourceLifecycle

• Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle

---

Provider^Optional

func Provider() TerraformProvider

• Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

---

Provisioners^Optional

func Provisioners() *[]interface{}

• Type: *[]interface{}

---

Type^Required

func Type() *string

• Type: *string

---

AccessKeyIdInput^Optional

func AccessKeyIdInput() *string

• Type: *string

---

CustomTagsInput^Optional

func CustomTagsInput() *map[string]*string

• Type: *map[string]*string

---

ExternalIdInput^Optional

func ExternalIdInput() *string

• Type: *string

---

GranularityInput^Optional

func GranularityInput() *string

• Type: *string

---

IdInput^Optional

func IdInput() *string

• Type: *string

---

NameInput^Optional

func NameInput() *string

• Type: *string

---

NamespaceInput^Optional

func NamespaceInput() *string

• Type: *string

---

RegionInput^Optional

func RegionInput() *string

• Type: *string

---

RoleArnInput^Optional

func RoleArnInput() *string

• Type: *string

---

SecretAccessKeyInput^Optional

func SecretAccessKeyInput() *string

• Type: *string

---

SecretNameTemplateInput^Optional

func SecretNameTemplateInput() *string

• Type: *string

---

AccessKeyId^Required

func AccessKeyId() *string

• Type: *string

---

CustomTags^Required

func CustomTags() *map[string]*string

• Type: *map[string]*string

---

ExternalId^Required

func ExternalId() *string

• Type: *string

---

Granularity^Required

func Granularity() *string

• Type: *string

---

Id^Required

func Id() *string

• Type: *string

---

Name^Required

func Name() *string

• Type: *string

---

Namespace^Required

func Namespace() *string

• Type: *string

---

Region^Required

func Region() *string

• Type: *string

---

RoleArn^Required

func RoleArn() *string

• Type: *string

---

SecretAccessKey^Required

func SecretAccessKey() *string

• Type: *string

---

SecretNameTemplate^Required

func SecretNameTemplate() *string

• Type: *string

---

Constants

Name	Type	Description
TfResourceType	*string	No description.

---

TfResourceType^Required

func TfResourceType() *string

• Type: *string

---

Structs

SecretsSyncAwsDestinationConfig

Initializer

import "github.com/cdktf/cdktf-provider-vault-go/vault/v13/secretssyncawsdestination"

&secretssyncawsdestination.SecretsSyncAwsDestinationConfig {
	Connection: interface{},
	Count: interface{},
	DependsOn: *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable,
	ForEach: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator,
	Lifecycle: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle,
	Provider: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider,
	Provisioners: *[]interface{},
	Name: *string,
	AccessKeyId: *string,
	CustomTags: *map[string]*string,
	ExternalId: *string,
	Granularity: *string,
	Id: *string,
	Namespace: *string,
	Region: *string,
	RoleArn: *string,
	SecretAccessKey: *string,
	SecretNameTemplate: *string,
}

Properties

Name	Type	Description
Connection	interface{}	No description.
Count	interface{}	No description.
DependsOn	*[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable	No description.
ForEach	github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator	No description.
Lifecycle	github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle	No description.
Provider	github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider	No description.
Provisioners	*[]interface{}	No description.
Name	*string	Unique name of the AWS destination.
AccessKeyId	*string	Access key id to authenticate against the AWS secrets manager.
CustomTags	*map[string]*string	Custom tags to set on the secret managed at the destination.
ExternalId	*string	Extra protection that must match the trust policy granting access to the AWS IAM role ARN.
Granularity	*string	Determines what level of information is synced as a distinct resource at the destination. Can be 'secret-path' or 'secret-key'.
Id	*string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/secrets_sync_aws_destination#id SecretsSyncAwsDestination#id}.
Namespace	*string	Target namespace. (requires Enterprise).
Region	*string	Region where to manage the secrets manager entries.
RoleArn	*string	Specifies a role to assume when connecting to AWS.
SecretAccessKey	*string	Secret access key to authenticate against the AWS secrets manager.
SecretNameTemplate	*string	Template describing how to generate external secret names.

---

Connection^Optional

Connection interface{}

• Type: interface{}

---

Count^Optional

Count interface{}

• Type: interface{}

---

DependsOn^Optional

DependsOn *[]ITerraformDependable

• Type: *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable

---

ForEach^Optional

ForEach ITerraformIterator

• Type: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator

---

Lifecycle^Optional

Lifecycle TerraformResourceLifecycle

• Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle

---

Provider^Optional

Provider TerraformProvider

• Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

---

Provisioners^Optional

Provisioners *[]interface{}

• Type: *[]interface{}

---

Name^Required

Name *string

• Type: *string

Unique name of the AWS destination.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/secrets_sync_aws_destination#name SecretsSyncAwsDestination#name}

---

AccessKeyId^Optional

AccessKeyId *string

• Type: *string

Access key id to authenticate against the AWS secrets manager.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/secrets_sync_aws_destination#access_key_id SecretsSyncAwsDestination#access_key_id}

---

CustomTags^Optional

CustomTags *map[string]*string

• Type: *map[string]*string

Custom tags to set on the secret managed at the destination.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/secrets_sync_aws_destination#custom_tags SecretsSyncAwsDestination#custom_tags}

---

ExternalId^Optional

ExternalId *string

• Type: *string

Extra protection that must match the trust policy granting access to the AWS IAM role ARN.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/secrets_sync_aws_destination#external_id SecretsSyncAwsDestination#external_id}

---

Granularity^Optional

Granularity *string

• Type: *string

Determines what level of information is synced as a distinct resource at the destination. Can be 'secret-path' or 'secret-key'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/secrets_sync_aws_destination#granularity SecretsSyncAwsDestination#granularity}

---

Id^Optional

Id *string

• Type: *string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/secrets_sync_aws_destination#id SecretsSyncAwsDestination#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.

---

Namespace^Optional

Namespace *string

• Type: *string

Target namespace. (requires Enterprise).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/secrets_sync_aws_destination#namespace SecretsSyncAwsDestination#namespace}

---

Region^Optional

Region *string

• Type: *string

Region where to manage the secrets manager entries.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/secrets_sync_aws_destination#region SecretsSyncAwsDestination#region}

---

RoleArn^Optional

RoleArn *string

• Type: *string

Specifies a role to assume when connecting to AWS.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/secrets_sync_aws_destination#role_arn SecretsSyncAwsDestination#role_arn}

---

SecretAccessKey^Optional

SecretAccessKey *string

• Type: *string

Secret access key to authenticate against the AWS secrets manager.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/secrets_sync_aws_destination#secret_access_key SecretsSyncAwsDestination#secret_access_key}

---

SecretNameTemplate^Optional

SecretNameTemplate *string

• Type: *string

Template describing how to generate external secret names.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/secrets_sync_aws_destination#secret_name_template SecretsSyncAwsDestination#secret_name_template}

---