ram: AWS Resource Access Manager

Description Usage Arguments Value Service syntax Operations Examples

View source: R/ram_service.R

Description

Use AWS Resource Access Manager to share AWS resources between AWS accounts. To share a resource, you create a resource share, associate the resource with the resource share, and specify the principals that can access the resources associated with the resource share. The following principals are supported: AWS accounts, organizational units (OU) from AWS Organizations, and organizations from AWS Organizations.

For more information, see the AWS Resource Access Manager User Guide.

Usage

1
ram(config = list())

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

Value

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
svc <- ram(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string"
    ),
    endpoint = "string",
    region = "string"
  )
)

Operations

accept_resource_share_invitation Accepts an invitation to a resource share from another AWS account
associate_resource_share Associates the specified resource share with the specified principals and resources
associate_resource_share_permission Associates a permission with a resource share
create_resource_share Creates a resource share
delete_resource_share Deletes the specified resource share
disassociate_resource_share Disassociates the specified principals or resources from the specified resource share
disassociate_resource_share_permission Disassociates an AWS RAM permission from a resource share
enable_sharing_with_aws_organization Enables resource sharing within your AWS Organization
get_permission Gets the contents of an AWS RAM permission in JSON format
get_resource_policies Gets the policies for the specified resources that you own and have shared
get_resource_share_associations Gets the resources or principals for the resource shares that you own
get_resource_share_invitations Gets the invitations for resource sharing that you've received
get_resource_shares Gets the resource shares that you own or the resource shares that are shared with you
list_pending_invitation_resources Lists the resources in a resource share that is shared with you but that the invitation is still pending for
list_permissions Lists the AWS RAM permissions
list_principals Lists the principals that you have shared resources with or that have shared resources with you
list_resources Lists the resources that you added to a resource shares or the resources that are shared with you
list_resource_share_permissions Lists the AWS RAM permissions that are associated with a resource share
list_resource_types Lists the shareable resource types supported by AWS RAM
promote_resource_share_created_from_policy Resource shares that were created by attaching a policy to a resource are visible only to the resource share owner, and the resource share cannot be modified in AWS RAM
reject_resource_share_invitation Rejects an invitation to a resource share from another AWS account
tag_resource Adds the specified tags to the specified resource share that you own
untag_resource Removes the specified tags from the specified resource share that you own
update_resource_share Updates the specified resource share that you own

Examples

1
2
3
4
5
6
7
## Not run: 
svc <- ram()
svc$accept_resource_share_invitation(
  Foo = 123
)

## End(Not run)

paws.security.identity documentation built on Aug. 23, 2021, 9:16 a.m.