Skip to content

GetCredentialsRequest

Source code in docs_src/capo_redshift_serverless/types/get_credentials_request.py
class GetCredentialsRequest(TypedDict, closed=True):
    db_name: NotRequired["capo_redshift_serverless.types.db_name.DbName"]
    """<p>The name of the database to get temporary authorization to log on to.</p> <p>Constraints:</p> <ul> <li> <p>Must be 1 to 64 alphanumeric characters or hyphens.</p> </li> <li> <p>Must contain only uppercase or lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.</p> </li> <li> <p>The first character must be a letter.</p> </li> <li> <p>Must not contain a colon ( : ) or slash ( / ).</p> </li> <li> <p>Cannot be a reserved word. A list of reserved words can be found in <a href="https://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html">Reserved Words </a> in the Amazon Redshift Database Developer Guide</p> </li> </ul>"""
    duration_seconds: NotRequired["int"]
    """<p>The number of seconds until the returned temporary password expires. The minimum is 900 seconds, and the maximum is 3600 seconds.</p>"""
    workgroup_name: NotRequired[
        "capo_redshift_serverless.types.workgroup_name.WorkgroupName"
    ]
    """<p>The name of the workgroup associated with the database.</p>"""
    custom_domain_name: NotRequired[
        "capo_redshift_serverless.types.custom_domain_name.CustomDomainName"
    ]
    """<p>The custom domain name associated with the workgroup. The custom domain name or the workgroup name must be included in the request.</p>"""

custom_domain_name instance-attribute

custom_domain_name: NotRequired[CustomDomainName]

The custom domain name associated with the workgroup. The custom domain name or the workgroup name must be included in the request.

db_name instance-attribute

db_name: NotRequired[DbName]

The name of the database to get temporary authorization to log on to.

Constraints:

  • Must be 1 to 64 alphanumeric characters or hyphens.

  • Must contain only uppercase or lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.

  • The first character must be a letter.

  • Must not contain a colon ( : ) or slash ( / ).

  • Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide

duration_seconds instance-attribute

duration_seconds: NotRequired[int]

The number of seconds until the returned temporary password expires. The minimum is 900 seconds, and the maximum is 3600 seconds.

workgroup_name instance-attribute

workgroup_name: NotRequired[WorkgroupName]

The name of the workgroup associated with the database.