mirror of
https://github.com/open-metadata/OpenMetadata.git
synced 2025-12-14 09:05:58 +00:00
95 lines
4.8 KiB
Markdown
95 lines
4.8 KiB
Markdown
|
|
{% codeInfo srNumber=221 %}
|
||
|
|
|
||
|
|
- **awsAccessKeyId** & **awsSecretAccessKey**: When you interact with AWS, you specify your AWS security credentials to verify who you are and whether you have
|
||
|
|
permission to access the resources that you are requesting. AWS uses the security credentials to authenticate and
|
||
|
|
authorize your requests ([docs](https://docs.aws.amazon.com/IAM/latest/UserGuide/security-creds.html)).
|
||
|
|
|
||
|
|
Access keys consist of two parts: An **access key ID** (for example, `AKIAIOSFODNN7EXAMPLE`), and a **secret access key** (for example, `wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY`).
|
||
|
|
|
||
|
|
You must use both the access key ID and secret access key together to authenticate your requests.
|
||
|
|
|
||
|
|
You can find further information on how to manage your access keys [here](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html).
|
||
|
|
|
||
|
|
{% /codeInfo %}
|
||
|
|
|
||
|
|
{% codeInfo srNumber=222 %}
|
||
|
|
**awsSessionToken**: If you are using temporary credentials to access your services, you will need to inform the AWS Access Key ID
|
||
|
|
and AWS Secrets Access Key. Also, these will include an AWS Session Token.
|
||
|
|
|
||
|
|
{% /codeInfo %}
|
||
|
|
|
||
|
|
{% codeInfo srNumber=223 %}
|
||
|
|
|
||
|
|
**awsRegion**: Each AWS Region is a separate geographic area in which AWS clusters data centers ([docs](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html)).
|
||
|
|
|
||
|
|
As AWS can have instances in multiple regions, we need to know the region the service you want reach belongs to.
|
||
|
|
|
||
|
|
Note that the AWS Region is the only required parameter when configuring a connection. When connecting to the
|
||
|
|
services programmatically, there are different ways in which we can extract and use the rest of AWS configurations.
|
||
|
|
|
||
|
|
You can find further information about configuring your credentials [here](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html#configuring-credentials).
|
||
|
|
|
||
|
|
{% /codeInfo %}
|
||
|
|
|
||
|
|
{% codeInfo srNumber=224 %}
|
||
|
|
|
||
|
|
**endPointURL**: To connect programmatically to an AWS service, you use an endpoint. An *endpoint* is the URL of the
|
||
|
|
entry point for an AWS web service. The AWS SDKs and the AWS Command Line Interface (AWS CLI) automatically use the
|
||
|
|
default endpoint for each service in an AWS Region. But you can specify an alternate endpoint for your API requests.
|
||
|
|
|
||
|
|
Find more information on [AWS service endpoints](https://docs.aws.amazon.com/general/latest/gr/rande.html).
|
||
|
|
|
||
|
|
{% /codeInfo %}
|
||
|
|
|
||
|
|
{% codeInfo srNumber=225 %}
|
||
|
|
|
||
|
|
**profileName**: A named profile is a collection of settings and credentials that you can apply to a AWS CLI command.
|
||
|
|
When you specify a profile to run a command, the settings and credentials are used to run that command.
|
||
|
|
Multiple named profiles can be stored in the config and credentials files.
|
||
|
|
|
||
|
|
You can inform this field if you'd like to use a profile other than `default`.
|
||
|
|
|
||
|
|
Find here more information about [Named profiles for the AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html).
|
||
|
|
|
||
|
|
{% /codeInfo %}
|
||
|
|
|
||
|
|
{% codeInfo srNumber=226 %}
|
||
|
|
|
||
|
|
**assumeRoleArn**: Typically, you use `AssumeRole` within your account or for cross-account access. In this field you'll set the
|
||
|
|
`ARN` (Amazon Resource Name) of the policy of the other account.
|
||
|
|
|
||
|
|
A user who wants to access a role in a different account must also have permissions that are delegated from the account
|
||
|
|
administrator. The administrator must attach a policy that allows the user to call `AssumeRole` for the `ARN` of the role in the other account.
|
||
|
|
|
||
|
|
This is a required field if you'd like to `AssumeRole`.
|
||
|
|
|
||
|
|
Find more information on [AssumeRole](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html).
|
||
|
|
|
||
|
|
{%note%}
|
||
|
|
When using Assume Role authentication, ensure you provide the following details:
|
||
|
|
- **AWS Region**: Specify the AWS region for your deployment.
|
||
|
|
- **Assume Role ARN**: Provide the ARN of the role in your AWS account that OpenMetadata will assume.
|
||
|
|
{%/note%}
|
||
|
|
|
||
|
|
{% /codeInfo %}
|
||
|
|
|
||
|
|
{% codeInfo srNumber=227 %}
|
||
|
|
|
||
|
|
**assumeRoleSessionName**: An identifier for the assumed role session. Use the role session name to uniquely identify a session when the same role
|
||
|
|
is assumed by different principals or for different reasons.
|
||
|
|
|
||
|
|
By default, we'll use the name `OpenMetadataSession`.
|
||
|
|
|
||
|
|
Find more information about the [Role Session Name](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html#:~:text=An%20identifier%20for%20the%20assumed%20role%20session.).
|
||
|
|
|
||
|
|
{% /codeInfo %}
|
||
|
|
|
||
|
|
{% codeInfo srNumber=228 %}
|
||
|
|
|
||
|
|
**assumeRoleSourceIdentity**: The source identity specified by the principal that is calling the `AssumeRole` operation. You can use source identity
|
||
|
|
information in AWS CloudTrail logs to determine who took actions with a role.
|
||
|
|
|
||
|
|
Find more information about [Source Identity](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html#:~:text=Required%3A%20No-,SourceIdentity,-The%20source%20identity).
|
||
|
|
|
||
|
|
{% /codeInfo %}
|