antimatter.builders.root_encryption_key#

Module Contents#

Classes#

OverrideKeyInfosKeyInformation

KeyInfosKeyInformation

Functions#

aws_service_account_key_info(→ antimatter_api.KeyInfos)

Create a KeyInfos object with AWS service account key information

antimatter_delegated_aws_key_info(...)

Create a KeyInfos object with Antimatter delegated AWS key information

gcp_service_account_key_info(→ antimatter_api.KeyInfos)

Create a KeyInfos object with GCP service account key information
class antimatter.builders.root_encryption_key.OverrideKeyInfosKeyInformation(*args, **kwargs)#

Bases: antimatter_api.KeyInfosKeyInformation

KeyInfosKeyInformation

one_of_schemas: List[str] = ['AWSServiceAccountKeyInfo', 'AntimatterDelegatedAWSKeyInfo', 'GCPServiceAccountKeyInfo']#
antimatter.builders.root_encryption_key.aws_service_account_key_info(access_key_id: str, secret_access_key: str, key_arn: str = '') → antimatter_api.KeyInfos#

Create a KeyInfos object with AWS service account key information

Example usage:

key_info = aws_service_account_key_info(
    access_key_id="access_key_id", secret_access_key="secret_access_key", key_arn="key_arn"
)
Parameters:

  • access_key_id – The access key ID

  • secret_access_key – The secret access key

  • key_arn – The key ARN

Returns:

A KeyInfos object with the specified key information

antimatter.builders.root_encryption_key.antimatter_delegated_aws_key_info(key_arn: str) → antimatter_api.KeyInfos#

Create a KeyInfos object with Antimatter delegated AWS key information

Example usage:

key_info = antimatter_delegated_aws_key_info(key_arn="key_arn")
Parameters:

key_arn – The key ARN

Returns:

A KeyInfos object with the specified key information

antimatter.builders.root_encryption_key.gcp_service_account_key_info(project_id: str, location: str, key_ring_id: str = '', key_id: str = '', service_account_credentials: str = '', service_account_credentials_path: str = '') → antimatter_api.KeyInfos#

Create a KeyInfos object with GCP service account key information

Example usage:

key_info = gcp_service_account_key_info(
    project_id="project_id",
    location="location",
    key_ring_id="key_ring_id",
    key_id="key_id",
    service_account_credentials="<service_account_credentials_as_json_string>",
    service_account_credentials_path="/path/to/service_account_credentials.json"
)

Either service_account_credentials or service_account_credentials_path should be provided.

Parameters:

  • project_id – The project ID

  • location – The location

  • key_ring_id – The key ring ID

  • key_id – The key ID

  • service_account_credentials – The service account credentials as JSON string

  • service_account_credentials_path – The path to the service account credentials

Returns:

A KeyInfos object with the specified key information