ibmcloud.ansible_collection.ibm_database (1.2.2) — module

Configure IBM Cloud 'ibm_database' resource

| "added in version" 2.8 of ibmcloud.ansible_collection"

Authors: Jay Carman (@jaywcarman)

preview | supported by community

Install collection

Install with ansible-galaxy collection install ibmcloud.ansible_collection:==1.2.2


Add to requirements.yml

  collections:
    - name: ibmcloud.ansible_collection
      version: 1.2.2

Description

Create, update or destroy an IBM Cloud 'ibm_database' resource


Requirements

Inputs

    
id:
    description:
    - (Required when updating or destroying existing resource) IBM Cloud Resource ID.
    required: false
    type: str

name:
    description:
    - (Required for new resource) Resource instance name for example, my Database instance
    required: false
    type: str

plan:
    description:
    - (Required for new resource) The plan type of the Database instance
    required: false
    type: str

tags:
    description:
    - None
    elements: str
    required: false
    type: list

state:
    choices:
    - available
    - absent
    default: available
    description:
    - State of resource
    required: false

users:
    description:
    - None
    elements: dict
    required: false
    type: list

groups:
    description:
    - None
    elements: dict
    required: false
    type: list

status:
    description:
    - The resource instance status
    required: false
    type: str

service:
    description:
    - (Required for new resource) The name of the Cloud Internet database service
    required: false
    type: str

version:
    description:
    - The database version to provision if specified
    required: false
    type: str

location:
    description:
    - (Required for new resource) The location or the region in which Database instance
      exists
    required: false
    type: str

adminuser:
    description:
    - The admin user id for the instance
    required: false
    type: str

backup_id:
    description:
    - The CRN of backup source database
    required: false
    type: str

whitelist:
    description:
    - None
    elements: dict
    required: false
    type: list

resource_crn:
    description:
    - "The\_crn\_of\_the\_resource"
    required: false
    type: str

adminpassword:
    description:
    - The admin user password for the instance
    required: false
    type: str

resource_name:
    description:
    - "The\_name\_of\_the\_resource"
    required: false
    type: str

ibmcloud_region:
    default: us-south
    description:
    - Denotes which IBM Cloud region to connect to
    required: false

key_protect_key:
    description:
    - The CRN of Key protect key
    required: false
    type: str

resource_status:
    description:
    - "The\_status\_of\_the\_resource"
    required: false
    type: str

ibmcloud_api_key:
    description:
    - The API Key used for authentification. This can also be provided via the environment
      variable 'IC_API_KEY'.
    required: true

remote_leader_id:
    description:
    - The CRN of leader database
    required: false
    type: str

connectionstrings:
    description:
    - None
    elements: dict
    required: false
    type: list

resource_group_id:
    description:
    - The id of the resource group in which the Database instance is present
    required: false
    type: str

service_endpoints:
    default: public
    description:
    - Types of the service endpoints. Possible values are 'public', 'private', 'public-and-private'.
    required: false
    type: str

resource_group_name:
    description:
    - "The\_resource\_group\_name\_in\_which\_resource\_is\_provisioned"
    required: false
    type: str

key_protect_instance:
    description:
    - The CRN of Key protect instance
    required: false
    type: str

resource_controller_url:
    description:
    - The URL of the IBM Cloud dashboard that can be used to explore and view details
      about the resource
    required: false
    type: str

members_disk_allocation_mb:
    description:
    - Disk allocation required for cluster
    required: false
    type: int

members_cpu_allocation_count:
    description:
    - CPU allocation required for cluster
    required: false
    type: int

members_memory_allocation_mb:
    description:
    - Memory allocation required for cluster
    required: false
    type: int