mongodbatlassecretrole

README

vault_mongodbatlas_secret_role

Refer to the Terraform Registory for docs: vault_mongodbatlas_secret_role.

Documentation

Index

• func MongodbatlasSecretRole_IsConstruct(x interface{}) *bool
• func MongodbatlasSecretRole_IsTerraformElement(x interface{}) *bool
• func MongodbatlasSecretRole_IsTerraformResource(x interface{}) *bool
• func MongodbatlasSecretRole_TfResourceType() *string
• func NewMongodbatlasSecretRole_Override(m MongodbatlasSecretRole, scope constructs.Construct, id *string, ...)
• type MongodbatlasSecretRole
  • func NewMongodbatlasSecretRole(scope constructs.Construct, id *string, config *MongodbatlasSecretRoleConfig) MongodbatlasSecretRole
• type MongodbatlasSecretRoleConfig

Functions

func MongodbatlasSecretRole_IsConstruct

func MongodbatlasSecretRole_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 MongodbatlasSecretRole_IsTerraformElement

func MongodbatlasSecretRole_IsTerraformElement(x interface{}) *bool

Experimental.

func MongodbatlasSecretRole_IsTerraformResource

func MongodbatlasSecretRole_IsTerraformResource(x interface{}) *bool

Experimental.

func MongodbatlasSecretRole_TfResourceType

func MongodbatlasSecretRole_TfResourceType() *string

func NewMongodbatlasSecretRole_Override

func NewMongodbatlasSecretRole_Override(m MongodbatlasSecretRole, scope constructs.Construct, id *string, config *MongodbatlasSecretRoleConfig)

Create a new {@link https://registry.terraform.io/providers/hashicorp/vault/3.19.0/docs/resources/mongodbatlas_secret_role vault_mongodbatlas_secret_role} Resource.

Types

type MongodbatlasSecretRole

type MongodbatlasSecretRole interface {
	cdktf.TerraformResource
	// Experimental.
	CdktfStack() cdktf.TerraformStack
	CidrBlocks() *[]*string
	SetCidrBlocks(val *[]*string)
	CidrBlocksInput() *[]*string
	// Experimental.
	Connection() interface{}
	// Experimental.
	SetConnection(val interface{})
	// Experimental.
	ConstructNodeMetadata() *map[string]interface{}
	// Experimental.
	Count() interface{}
	// Experimental.
	SetCount(val interface{})
	// 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
	IpAddresses() *[]*string
	SetIpAddresses(val *[]*string)
	IpAddressesInput() *[]*string
	// Experimental.
	Lifecycle() *cdktf.TerraformResourceLifecycle
	// Experimental.
	SetLifecycle(val *cdktf.TerraformResourceLifecycle)
	MaxTtl() *string
	SetMaxTtl(val *string)
	MaxTtlInput() *string
	Mount() *string
	SetMount(val *string)
	MountInput() *string
	Name() *string
	SetName(val *string)
	NameInput() *string
	Namespace() *string
	SetNamespace(val *string)
	NamespaceInput() *string
	// The tree node.
	Node() constructs.Node
	OrganizationId() *string
	SetOrganizationId(val *string)
	OrganizationIdInput() *string
	ProjectId() *string
	SetProjectId(val *string)
	ProjectIdInput() *string
	ProjectRoles() *[]*string
	SetProjectRoles(val *[]*string)
	ProjectRolesInput() *[]*string
	// Experimental.
	Provider() cdktf.TerraformProvider
	// Experimental.
	SetProvider(val cdktf.TerraformProvider)
	// Experimental.
	Provisioners() *[]interface{}
	// Experimental.
	SetProvisioners(val *[]interface{})
	// Experimental.
	RawOverrides() interface{}
	Roles() *[]*string
	SetRoles(val *[]*string)
	RolesInput() *[]*string
	// Experimental.
	TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata
	// Experimental.
	TerraformMetaArguments() *map[string]interface{}
	// Experimental.
	TerraformResourceType() *string
	Ttl() *string
	SetTtl(val *string)
	TtlInput() *string
	// 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)
	ResetCidrBlocks()
	ResetId()
	ResetIpAddresses()
	ResetMaxTtl()
	ResetNamespace()
	ResetOrganizationId()
	// Resets a previously passed logical Id to use the auto-generated logical id again.
	// Experimental.
	ResetOverrideLogicalId()
	ResetProjectId()
	ResetProjectRoles()
	ResetTtl()
	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/vault/3.19.0/docs/resources/mongodbatlas_secret_role vault_mongodbatlas_secret_role}.

func NewMongodbatlasSecretRole

func NewMongodbatlasSecretRole(scope constructs.Construct, id *string, config *MongodbatlasSecretRoleConfig) MongodbatlasSecretRole

Create a new {@link https://registry.terraform.io/providers/hashicorp/vault/3.19.0/docs/resources/mongodbatlas_secret_role vault_mongodbatlas_secret_role} Resource.

type MongodbatlasSecretRoleConfig

type MongodbatlasSecretRoleConfig 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"`
	// Path where MongoDB Atlas secret backend is mounted.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/3.19.0/docs/resources/mongodbatlas_secret_role#mount MongodbatlasSecretRole#mount}
	Mount *string `field:"required" json:"mount" yaml:"mount"`
	// Name of the role.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/3.19.0/docs/resources/mongodbatlas_secret_role#name MongodbatlasSecretRole#name}
	Name *string `field:"required" json:"name" yaml:"name"`
	// List of roles that the API Key needs to have.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/3.19.0/docs/resources/mongodbatlas_secret_role#roles MongodbatlasSecretRole#roles}
	Roles *[]*string `field:"required" json:"roles" yaml:"roles"`
	// Whitelist entry in CIDR notation to be added for the API key.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/3.19.0/docs/resources/mongodbatlas_secret_role#cidr_blocks MongodbatlasSecretRole#cidr_blocks}
	CidrBlocks *[]*string `field:"optional" json:"cidrBlocks" yaml:"cidrBlocks"`
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/3.19.0/docs/resources/mongodbatlas_secret_role#id MongodbatlasSecretRole#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"`
	// IP address to be added to the whitelist for the API key.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/3.19.0/docs/resources/mongodbatlas_secret_role#ip_addresses MongodbatlasSecretRole#ip_addresses}
	IpAddresses *[]*string `field:"optional" json:"ipAddresses" yaml:"ipAddresses"`
	// The maximum allowed lifetime of credentials issued using this role.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/3.19.0/docs/resources/mongodbatlas_secret_role#max_ttl MongodbatlasSecretRole#max_ttl}
	MaxTtl *string `field:"optional" json:"maxTtl" yaml:"maxTtl"`
	// Target namespace. (requires Enterprise).
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/3.19.0/docs/resources/mongodbatlas_secret_role#namespace MongodbatlasSecretRole#namespace}
	Namespace *string `field:"optional" json:"namespace" yaml:"namespace"`
	// ID for the organization to which the target API Key belongs.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/3.19.0/docs/resources/mongodbatlas_secret_role#organization_id MongodbatlasSecretRole#organization_id}
	OrganizationId *string `field:"optional" json:"organizationId" yaml:"organizationId"`
	// ID for the project to which the target API Key belongs.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/3.19.0/docs/resources/mongodbatlas_secret_role#project_id MongodbatlasSecretRole#project_id}
	ProjectId *string `field:"optional" json:"projectId" yaml:"projectId"`
	// Roles assigned when an org API key is assigned to a project API key.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/3.19.0/docs/resources/mongodbatlas_secret_role#project_roles MongodbatlasSecretRole#project_roles}
	ProjectRoles *[]*string `field:"optional" json:"projectRoles" yaml:"projectRoles"`
	// Duration in seconds after which the issued credential should expire.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/3.19.0/docs/resources/mongodbatlas_secret_role#ttl MongodbatlasSecretRole#ttl}
	Ttl *string `field:"optional" json:"ttl" yaml:"ttl"`
}