| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.LakeFormation.RegisterResource
Description
Registers the resource as managed by the Data Catalog.
To add or update data, Lake Formation needs read/write access to the chosen Amazon S3 path. Choose a role that you know has permission to do this, or choose the AWSServiceRoleForLakeFormationDataAccess service-linked role. When you register the first Amazon S3 path, the service-linked role and a new inline policy are created on your behalf. Lake Formation adds the first path to the inline policy and attaches it to the service-linked role. When you register subsequent paths, Lake Formation adds the path to the existing policy.
The following request registers a new location and gives AWS Lake Formation permission to use the service-linked role to access that location.
ResourceArn = arn:aws:s3:::my-bucket UseServiceLinkedRole = true
If UseServiceLinkedRole is not set to true, you must provide or set
the RoleArn:
arn:aws:iam::12345:role/my-data-access-role
Synopsis
- data RegisterResource = RegisterResource' {}
- newRegisterResource :: Text -> RegisterResource
- registerResource_useServiceLinkedRole :: Lens' RegisterResource (Maybe Bool)
- registerResource_roleArn :: Lens' RegisterResource (Maybe Text)
- registerResource_resourceArn :: Lens' RegisterResource Text
- data RegisterResourceResponse = RegisterResourceResponse' {
- httpStatus :: Int
- newRegisterResourceResponse :: Int -> RegisterResourceResponse
- registerResourceResponse_httpStatus :: Lens' RegisterResourceResponse Int
Creating a Request
data RegisterResource Source #
See: newRegisterResource smart constructor.
Constructors
| RegisterResource' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> RegisterResource |
Create a value of RegisterResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:useServiceLinkedRole:RegisterResource', registerResource_useServiceLinkedRole - Designates an AWS Identity and Access Management (IAM) service-linked
role by registering this role with the Data Catalog. A service-linked
role is a unique type of IAM role that is linked directly to Lake
Formation.
For more information, see Using Service-Linked Roles for Lake Formation.
$sel:roleArn:RegisterResource', registerResource_roleArn - The identifier for the role that registers the resource.
$sel:resourceArn:RegisterResource', registerResource_resourceArn - The Amazon Resource Name (ARN) of the resource that you want to
register.
Request Lenses
registerResource_useServiceLinkedRole :: Lens' RegisterResource (Maybe Bool) Source #
Designates an AWS Identity and Access Management (IAM) service-linked role by registering this role with the Data Catalog. A service-linked role is a unique type of IAM role that is linked directly to Lake Formation.
For more information, see Using Service-Linked Roles for Lake Formation.
registerResource_roleArn :: Lens' RegisterResource (Maybe Text) Source #
The identifier for the role that registers the resource.
registerResource_resourceArn :: Lens' RegisterResource Text Source #
The Amazon Resource Name (ARN) of the resource that you want to register.
Destructuring the Response
data RegisterResourceResponse Source #
See: newRegisterResourceResponse smart constructor.
Constructors
| RegisterResourceResponse' | |
Fields
| |
Instances
newRegisterResourceResponse Source #
Create a value of RegisterResourceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:RegisterResourceResponse', registerResourceResponse_httpStatus - The response's http status code.
Response Lenses
registerResourceResponse_httpStatus :: Lens' RegisterResourceResponse Int Source #
The response's http status code.