snowflake.core.stage.AwsCredentials¶

class snowflake.core.stage.AwsCredentials(*, aws_key_id: SecretStr | None = None, aws_secret_key: SecretStr | None = None, aws_token: SecretStr | None = None, aws_role: Annotated[str, Strict(strict=True)] | None = None)¶

Bases: Credentials

A model object representing the AwsCredentials resource.

Constructs an object of type AwsCredentials with the provided properties.

Parameters:

• aws_key_id (str, optional) – Scoped credentials generated by AWS Security Token Service (STS).

• aws_secret_key (str, optional) – Scoped credentials generated by AWS Security Token Service (STS).

• aws_token (str, optional) – Scoped credentials generated by AWS Security Token Service (STS).

• aws_role (str, optional) – Omit the security credentials and access keys and, instead, identify the role using AWS_ROLE and specify the AWS role ARN (Amazon Resource Name).

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Methods

classmethod from_dict(obj: dict) → AwsCredentials¶

Create an instance of AwsCredentials from a dict.

classmethod from_json(json_str: str) → AwsCredentials¶

Create an instance of AwsCredentials from a JSON string.

to_dict(hide_readonly_properties: bool = False) → Dict[str, Any]¶

Returns the dictionary representation of the model using alias.

to_dict_without_readonly_properties() → Dict[str, Any]¶

Return the dictionary representation of the model without readonly properties.

to_json() → str¶

Returns the JSON representation of the model using alias.

to_str() → str¶

Returns the string representation of the model using alias.