odb / Client / create_autonomous_database_wallet

create_autonomous_database_wallet

odb.Client.create_autonomous_database_wallet(**kwargs)

Creates a new wallet for the specified Autonomous Database.

See also: AWS API Documentation

Request Syntax

response = client.create_autonomous_database_wallet(
    autonomousDatabaseId='string',
    walletType='REGIONAL'|'INSTANCE',
    password='string',
    passwordSource='CUSTOMER_MANAGED_AWS_SECRET'|'API_REQUEST_PARAMETER',
    passwordSourceConfiguration={
        'customerManagedAwsSecret': {
            'secretId': 'string',
            'iamRoleArn': 'string',
            'externalIdType': 'database_ocid'|'compartment_ocid'|'tenant_ocid'
        }
    },
    clientToken='string'
)
Parameters:

  • autonomousDatabaseId (string) –

    [REQUIRED]

    The unique identifier of the Autonomous Database to create a wallet for.

  • walletType (string) – The type of wallet to create, either a regional wallet or an instance wallet.

  • password (string) – The password to encrypt the keys inside the wallet.

  • passwordSource (string) – The source of the password for encrypting the wallet. When set to CUSTOMER_MANAGED_AWS_SECRET, the password is retrieved from an Amazon Web Services Secrets Manager secret.

  • passwordSourceConfiguration (dict) –

    The configuration of the password source for the Autonomous Database wallet.

    Note

    This is a Tagged Union structure. Only one of the following top level keys can be set: customerManagedAwsSecret.

    • customerManagedAwsSecret (dict) –

      The configuration for using a customer-managed Amazon Web Services Secrets Manager secret as the wallet password source.

      • secretId (string) –

        The identifier or ARN of the Amazon Web Services Secrets Manager secret that contains the password.

      • iamRoleArn (string) –

        The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that OCI assumes to retrieve the secret value.

      • externalIdType (string) –

        The type of Oracle Cloud Identifier (OCID) used as the external ID when assuming the IAM role.

  • clientToken (string) –

    A client-provided token to ensure the idempotency of the request.

    This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'autonomousDatabaseWalletFile': b'bytes'
}

Response Structure

  • (dict) –

    • autonomousDatabaseWalletFile (bytes) –

      The generated wallet file for the Autonomous Database, returned as a compressed archive.

Exceptions