db_proxy#

Exec module for managing Rds Db Proxys.

async idem_aws.exec.aws.rds.db_proxy.get(hub, ctx, resource_id: str, filters: List[Filter] = None, name: str = None) → Dict[str, Any][source]#

Returns information about DB proxies.

Parameters:

  • resource_id (str) – Db_proxy unique ID. The name of the DB proxy.

  • filters (List[dict[str, Any]], Optional) –

    This parameter is not currently supported. Defaults to None.

    • Name (str): The name of the filter. Filter names are case-sensitive.

    • Values (List[str]): One or more filter values. Filter values are case-sensitive.

  • name (str, Optional) – Idem name of the resource. Defaults to None.

Returns:

Dict[str, Any]

Examples

Resource State:

unmanaged_resource:
  exec.run:
    - path: aws.rds.db_proxy.get
    - kwargs:
      resource_id: value

Exec call from the CLI:

idem exec aws.rds.db_proxy.get resource_id=value
async idem_aws.exec.aws.rds.db_proxy.list_(hub, ctx, resource_id: str = None, filters: List[Filter] = None, name: str = None) → Dict[str, Any][source]#

Returns information about DB proxies.

Parameters:

  • resource_id (str, Optional) – The name of the DB proxy. If you omit this parameter, the output includes information about all DB proxies owned by your Amazon Web Services account ID. Defaults to None.

  • filters (List[dict[str, Any]], Optional) –

    This parameter is not currently supported. Defaults to None.

    • Name (str): The name of the filter. Filter names are case-sensitive.

    • Values (List[str]): One or more filter values. Filter values are case-sensitive.

  • name (str, Optional) – Idem name of the resource. Defaults to None.

Returns:

Dict[str, Any]

Examples

Resource State:

unmanaged_resources:
  exec.run:
    - path: aws.rds.db_proxy.list
    - kwargs:

Exec call from the CLI:

idem exec aws.rds.db_proxy.list

Describe call from the CLI:

$ idem describe aws.rds.db_proxy
async idem_aws.exec.aws.rds.db_proxy.create(hub, ctx, db_proxy_name: str, engine_family: str, auth: ~typing.List[~types.UserAuthConfig], role_arn: str, vpc_subnet_ids: ~typing.List[str], vpc_security_group_ids: ~typing.List[str] = None, require_tls: bool = None, idle_client_timeout: int = None, debug_logging: bool = None, tags: ~typing.Dict[str, str] = None, name: str = None, timeout: ~types.Timeout configuration.Timeout = None) → Dict[str, Any][source]#

Creates a new DB proxy.

Parameters:

  • db_proxy_name (str) – The identifier for the proxy. This name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can’t end with a hyphen or contain two consecutive hyphens.

  • engine_family (str) – The kinds of databases that the proxy can connect to. This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database. For Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases, specify MYSQL. For Aurora PostgreSQL and RDS for PostgreSQL databases, specify POSTGRESQL. For RDS for Microsoft SQL Server, specify SQLSERVER.

  • auth (List[dict[str, Any]]) –

    The authorization mechanism that the proxy uses.

    • Description (str, Optional): A user-specified description about the authentication used by a proxy to log in as a specific

    database user.

    • UserName (str, Optional): The name of the database user to which the proxy connects.

    • AuthScheme (str, Optional): The type of authentication that the proxy uses for connections from the proxy to the underlying

    database.

    • SecretArn (str, Optional): The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to

    the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.

    • IAMAuth (str, Optional): Whether to require or disallow Amazon Web Services Identity and Access Management (IAM)

    authentication for connections to the proxy. The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.

    • ClientPasswordAuthType (str, Optional): The type of authentication the proxy uses for connections from clients.

  • role_arn (str) – The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in Amazon Web Services Secrets Manager.

  • vpc_subnet_ids (List[str]) – One or more VPC subnet IDs to associate with the new proxy.

  • vpc_security_group_ids (List[str], Optional) – One or more VPC security group IDs to associate with the new proxy. Defaults to None.

  • require_tls (bool, Optional) – A Boolean parameter that specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy. By enabling this setting, you can enforce encrypted TLS connections to the proxy. Defaults to None.

  • idle_client_timeout (int, Optional) – The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it. You can set this value higher or lower than the connection timeout limit for the associated database. Defaults to None.

  • debug_logging (bool, Optional) – Whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs. Defaults to None.

  • tags (Dict[str, str], Optional) – The tags to apply to the resource.

  • name (str, Optional) – Idem name of the resource. Defaults to None.

  • timeout (dict, Optional) –

    Timeout configuration for create/update of AWS DB Cluster.

    • create (dict, Optional):

      Timeout configuration for creating DB Cluster.

      • delay(int, Optional):

        The amount of time in seconds to wait between attempts.

      • max_attempts(int, Optional):

        Customized timeout configuration containing delay and max attempts.

    • update(dict, Optional):

      Timeout configuration for updating DB Cluster

      • delay(int, Optional):

        The amount of time in seconds to wait between attempts.

      • max_attempts(int, Optional):

        Customized timeout configuration containing delay and max attempts.

Returns:

Dict[str, Any]

Examples

Using in a state:

resource_is_present:
  aws.rds.db_proxy.present:
    - db_proxy_name: value
    - engine_family: value
    - auth: value
    - role_arn: value
    - vpc_subnet_ids: value

Exec call from the CLI:

idem exec aws.rds.db_proxy.create db_proxy_name=value, engine_family=value, auth=value, role_arn=value, vpc_subnet_ids=value
async idem_aws.exec.aws.rds.db_proxy.update(hub, ctx, resource_id: str, new_db_proxy_name: str = None, auth: ~typing.List[~types.UserAuthConfig] = None, require_tls: bool = None, idle_client_timeout: int = None, debug_logging: bool = None, role_arn: str = None, security_groups: ~typing.List[str] = None, name: str = None, tags: ~typing.Dict[str, str] = None, timeout: ~types.Timeout configuration.Timeout = None) → Dict[str, Any][source]#

Changes the settings for an existing DB proxy.

Parameters:

  • resource_id (str) – Db_proxy unique ID.

  • new_db_proxy_name (str, Optional) – The new identifier for the DBProxy. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can’t end with a hyphen or contain two consecutive hyphens. Defaults to None.

  • auth (List[dict[str, Any]], Optional) –

    The new authentication settings for the DBProxy. Defaults to None.

    • Description (str, Optional): A user-specified description about the authentication used by a proxy to log in as a specific

    database user.

    • UserName (str, Optional): The name of the database user to which the proxy connects.

    • AuthScheme (str, Optional): The type of authentication that the proxy uses for connections from the proxy to the underlying

    database.

    • SecretArn (str, Optional): The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to

    the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.

    • IAMAuth (str, Optional): Whether to require or disallow Amazon Web Services Identity and Access Management (IAM)

    authentication for connections to the proxy. The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.

    • ClientPasswordAuthType (str, Optional): The type of authentication the proxy uses for connections from clients.

  • require_tls (bool, Optional) – Whether Transport Layer Security (TLS) encryption is required for connections to the proxy. By enabling this setting, you can enforce encrypted TLS connections to the proxy, even if the associated database doesn’t use TLS. Defaults to None.

  • idle_client_timeout (int, Optional) – The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it. You can set this value higher or lower than the connection timeout limit for the associated database. Defaults to None.

  • debug_logging (bool, Optional) – Whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs. Defaults to None.

  • role_arn (str, Optional) – The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in Amazon Web Services Secrets Manager. Defaults to None.

  • security_groups (List[str], Optional) – The new list of security groups for the DBProxy. Defaults to None.

  • name (str, Optional) – Idem name of the resource. Defaults to None.

  • tags (Dict[str, str], Optional) – The tags to apply to the resource.

  • timeout (dict, Optional) –

    Timeout configuration for create/update of AWS DB Cluster.

    • create (dict, Optional):

      Timeout configuration for creating DB Cluster.

      • delay(int, Optional):

        The amount of time in seconds to wait between attempts.

      • max_attempts(int, Optional):

        Customized timeout configuration containing delay and max attempts.

    • update(dict, Optional):

      Timeout configuration for updating DB Cluster

      • delay(int, Optional):

        The amount of time in seconds to wait between attempts.

      • max_attempts(int, Optional):

        Customized timeout configuration containing delay and max attempts.

Returns:

Dict[str, Any]

Examples

Using in a state:

resource_is_present:
  aws.rds.db_proxy.present:
    - db_proxy_name: value
    - tags: value
    - resource_id: value

Exec call from the CLI:

idem exec aws.rds.db_proxy.update db_proxy_name=value, tags=value, resource_id=value
async idem_aws.exec.aws.rds.db_proxy.delete(hub, ctx, resource_id: str, name: str = None, timeout: ~types.Timeout configuration.Timeout = None) → Dict[str, Any][source]#

Deletes an existing DB proxy.

Parameters:

  • resource_id (str) – Db_proxy unique ID.

  • name (str, Optional) – Idem name of the resource. Defaults to None.

  • timeout (dict, Optional) –

    Timeout configuration for delete of AWS RDS DB Proxy.

    • delete (dict, Optional):

      Timeout configuration for deleting DB Cluster.

      • delay(int, Optional):

        The amount of time in seconds to wait between attempts.

      • max_attempts(int, Optional):

        Customized timeout configuration containing delay and max attempts.

Returns:

Dict[str, Any]

Examples

Resource State:

resource_is_absent:
  aws.rds.db_proxy.absent:
    - db_proxy_name: value
    - resource_id: value

Exec call from the CLI:

idem exec aws.rds.db_proxy.delete db_proxy_name=value, resource_id=value