Skip to content

vitess_branch_password.md

Latest commit

 

History

History
91 lines (71 loc) · 3.45 KB

vitess_branch_password.md

File metadata and controls

91 lines (71 loc) · 3.45 KB
page_title planetscale_vitess_branch_password Data Source - terraform-provider-planetscale
subcategory
description VitessBranchPassword DataSource

planetscale_vitess_branch_password (Data Source)

VitessBranchPassword DataSource

Example Usage

data "planetscale_vitess_branch_password" "my_vitessbranchpassword" {
  branch       = "...my_branch..."
  database     = "...my_database..."
  id           = "...my_id..."
  organization = "...my_organization..."
}

Schema

Required

  • branch (String) The name of the branch the password belongs to
  • database (String) The name of the database the password belongs to
  • id (String) The ID for the password
  • organization (String) The name of the organization the password belongs to

Read-Only

  • access_host_regional_url (String) The regional host URL
  • access_host_regional_urls (List of String) The read-only replica host URLs
  • access_host_url (String) The host URL for the password
  • actor (Attributes) (see below for nested schema)
  • cidrs (List of String) List of IP addresses or CIDR ranges that can use this password
  • created_at (String) When the password was created
  • database_branch (Attributes) (see below for nested schema)
  • deleted_at (String) When the password was deleted
  • direct_vtgate (Boolean) True if the credentials connect directly to a vtgate, bypassing load balancers
  • direct_vtgate_addresses (List of String) The list of hosts in each availability zone providing direct access to a vtgate
  • expired (Boolean) True if the credentials are expired
  • expires_at (String) When the password will expire
  • last_used_at (String) When the password was last used to execute a query
  • name (String) The display name for the password
  • region (Attributes) (see below for nested schema)
  • renewable (Boolean) Whether or not the password can be renewed
  • replica (Boolean) Whether or not the password is for a read replica
  • role (String) The role for the password
  • ttl_seconds (Number) Time to live (in seconds) for the password. The password will be invalid when TTL has passed
  • username (String) The username for the password

Nested Schema for actor

Read-Only:

  • avatar_url (String) The URL of the actor's avatar
  • display_name (String) The name of the actor
  • id (String) The ID of the actor

Nested Schema for database_branch

Read-Only:

  • id (String) The ID for the branch
  • mysql_edge_address (String) The address of the MySQL provider for the branch
  • name (String) The name for the branch
  • private_edge_connectivity (Boolean) True if private connectivity is enabled
  • production (Boolean) Whether or not the branch is a production branch

Nested Schema for region

Read-Only:

  • current_default (Boolean) True if the region is the default for new branch creation
  • display_name (String) Name of the region
  • enabled (Boolean) Whether or not the region is currently active
  • id (String) The ID of the region
  • location (String) Location of the region
  • provider (String) Provider for the region (ex. AWS)
  • public_ip_addresses (List of String) Public IP addresses for the region
  • slug (String) The slug of the region