amazonka-ram-2.0: Amazon Resource Access Manager SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.RAM.CreateResourceShare

Description

Creates a resource share. You can provide a list of the Amazon Resource Names (ARNs) for the resources that you want to share, a list of principals you want to share the resources with, and the permissions to grant those principals.

Sharing a resource makes it available for use by principals outside of the Amazon Web Services account that created the resource. Sharing doesn't change any permissions or quotas that apply to the resource in the account that created it.

Synopsis

Creating a Request

data CreateResourceShare Source #

See: newCreateResourceShare smart constructor.

Constructors

CreateResourceShare' 

Fields

  • allowExternalPrincipals :: Maybe Bool

    Specifies whether principals outside your organization in Organizations can be associated with a resource share. A value of true lets you share with individual Amazon Web Services accounts that are not in your organization. A value of false only has meaning if your account is a member of an Amazon Web Services Organization. The default value is true.

  • clientToken :: Maybe Text

    Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

    If you don't provide this value, then Amazon Web Services generates a random one for you.

  • permissionArns :: Maybe [Text]

    Specifies the Amazon Resource Names (ARNs) of the RAM permission to associate with the resource share. If you do not specify an ARN for the permission, RAM automatically attaches the default version of the permission for each resource type. You can associate only one permission with each resource type included in the resource share.

  • principals :: Maybe [Text]

    Specifies a list of one or more principals to associate with the resource share.

    You can include the following values:

    • An Amazon Web Services account ID, for example: 123456789012
    • An Amazon Resoure Name (ARN) of an organization in Organizations, for example: organizations::123456789012:organization/o-exampleorgid
    • An ARN of an organizational unit (OU) in Organizations, for example: organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123
    • An ARN of an IAM role, for example: iam::123456789012:role/rolename
    • An ARN of an IAM user, for example: iam::123456789012user/username

    Not all resource types can be shared with IAM roles and users. For more information, see Sharing with IAM roles and users in the Resource Access Manager User Guide.

  • resourceArns :: Maybe [Text]

    Specifies a list of one or more ARNs of the resources to associate with the resource share.

  • tags :: Maybe [Tag]

    Specifies one or more tags to attach to the resource share itself. It doesn't attach the tags to the resources associated with the resource share.

  • name :: Text

    Specifies the name of the resource share.

Instances

Instances details
ToJSON CreateResourceShare Source # 
Instance details

Defined in Amazonka.RAM.CreateResourceShare

ToHeaders CreateResourceShare Source # 
Instance details

Defined in Amazonka.RAM.CreateResourceShare

ToPath CreateResourceShare Source # 
Instance details

Defined in Amazonka.RAM.CreateResourceShare

ToQuery CreateResourceShare Source # 
Instance details

Defined in Amazonka.RAM.CreateResourceShare

AWSRequest CreateResourceShare Source # 
Instance details

Defined in Amazonka.RAM.CreateResourceShare

Associated Types

type AWSResponse CreateResourceShare #

Generic CreateResourceShare Source # 
Instance details

Defined in Amazonka.RAM.CreateResourceShare

Associated Types

type Rep CreateResourceShare :: Type -> Type #

Read CreateResourceShare Source # 
Instance details

Defined in Amazonka.RAM.CreateResourceShare

Show CreateResourceShare Source # 
Instance details

Defined in Amazonka.RAM.CreateResourceShare

NFData CreateResourceShare Source # 
Instance details

Defined in Amazonka.RAM.CreateResourceShare

Methods

rnf :: CreateResourceShare -> () #

Eq CreateResourceShare Source # 
Instance details

Defined in Amazonka.RAM.CreateResourceShare

Hashable CreateResourceShare Source # 
Instance details

Defined in Amazonka.RAM.CreateResourceShare

type AWSResponse CreateResourceShare Source # 
Instance details

Defined in Amazonka.RAM.CreateResourceShare

type Rep CreateResourceShare Source # 
Instance details

Defined in Amazonka.RAM.CreateResourceShare

type Rep CreateResourceShare = D1 ('MetaData "CreateResourceShare" "Amazonka.RAM.CreateResourceShare" "amazonka-ram-2.0-2ZD9k8USaHb58ZVl9MaFYL" 'False) (C1 ('MetaCons "CreateResourceShare'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "allowExternalPrincipals") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "permissionArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :*: ((S1 ('MetaSel ('Just "principals") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "resourceArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateResourceShare Source #

Create a value of CreateResourceShare 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:

CreateResourceShare, createResourceShare_allowExternalPrincipals - Specifies whether principals outside your organization in Organizations can be associated with a resource share. A value of true lets you share with individual Amazon Web Services accounts that are not in your organization. A value of false only has meaning if your account is a member of an Amazon Web Services Organization. The default value is true.

CreateResourceShare, createResourceShare_clientToken - Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

If you don't provide this value, then Amazon Web Services generates a random one for you.

$sel:permissionArns:CreateResourceShare', createResourceShare_permissionArns - Specifies the Amazon Resource Names (ARNs) of the RAM permission to associate with the resource share. If you do not specify an ARN for the permission, RAM automatically attaches the default version of the permission for each resource type. You can associate only one permission with each resource type included in the resource share.

$sel:principals:CreateResourceShare', createResourceShare_principals - Specifies a list of one or more principals to associate with the resource share.

You can include the following values:

  • An Amazon Web Services account ID, for example: 123456789012
  • An Amazon Resoure Name (ARN) of an organization in Organizations, for example: organizations::123456789012:organization/o-exampleorgid
  • An ARN of an organizational unit (OU) in Organizations, for example: organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123
  • An ARN of an IAM role, for example: iam::123456789012:role/rolename
  • An ARN of an IAM user, for example: iam::123456789012user/username

Not all resource types can be shared with IAM roles and users. For more information, see Sharing with IAM roles and users in the Resource Access Manager User Guide.

$sel:resourceArns:CreateResourceShare', createResourceShare_resourceArns - Specifies a list of one or more ARNs of the resources to associate with the resource share.

CreateResourceShare, createResourceShare_tags - Specifies one or more tags to attach to the resource share itself. It doesn't attach the tags to the resources associated with the resource share.

CreateResourceShare, createResourceShare_name - Specifies the name of the resource share.

Request Lenses

createResourceShare_allowExternalPrincipals :: Lens' CreateResourceShare (Maybe Bool) Source #

Specifies whether principals outside your organization in Organizations can be associated with a resource share. A value of true lets you share with individual Amazon Web Services accounts that are not in your organization. A value of false only has meaning if your account is a member of an Amazon Web Services Organization. The default value is true.

createResourceShare_clientToken :: Lens' CreateResourceShare (Maybe Text) Source #

Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

If you don't provide this value, then Amazon Web Services generates a random one for you.

createResourceShare_permissionArns :: Lens' CreateResourceShare (Maybe [Text]) Source #

Specifies the Amazon Resource Names (ARNs) of the RAM permission to associate with the resource share. If you do not specify an ARN for the permission, RAM automatically attaches the default version of the permission for each resource type. You can associate only one permission with each resource type included in the resource share.

createResourceShare_principals :: Lens' CreateResourceShare (Maybe [Text]) Source #

Specifies a list of one or more principals to associate with the resource share.

You can include the following values:

  • An Amazon Web Services account ID, for example: 123456789012
  • An Amazon Resoure Name (ARN) of an organization in Organizations, for example: organizations::123456789012:organization/o-exampleorgid
  • An ARN of an organizational unit (OU) in Organizations, for example: organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123
  • An ARN of an IAM role, for example: iam::123456789012:role/rolename
  • An ARN of an IAM user, for example: iam::123456789012user/username

Not all resource types can be shared with IAM roles and users. For more information, see Sharing with IAM roles and users in the Resource Access Manager User Guide.

createResourceShare_resourceArns :: Lens' CreateResourceShare (Maybe [Text]) Source #

Specifies a list of one or more ARNs of the resources to associate with the resource share.

createResourceShare_tags :: Lens' CreateResourceShare (Maybe [Tag]) Source #

Specifies one or more tags to attach to the resource share itself. It doesn't attach the tags to the resources associated with the resource share.

createResourceShare_name :: Lens' CreateResourceShare Text Source #

Specifies the name of the resource share.

Destructuring the Response

data CreateResourceShareResponse Source #

See: newCreateResourceShareResponse smart constructor.

Constructors

CreateResourceShareResponse' 

Fields

  • clientToken :: Maybe Text

    The idempotency identifier associated with this request. If you want to repeat the same operation in an idempotent manner then you must include this value in the clientToken request parameter of that later call. All other parameters must also have the same values that you used in the first call.

  • resourceShare :: Maybe ResourceShare

    An object with information about the new resource share.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic CreateResourceShareResponse Source # 
Instance details

Defined in Amazonka.RAM.CreateResourceShare

Associated Types

type Rep CreateResourceShareResponse :: Type -> Type #

Read CreateResourceShareResponse Source # 
Instance details

Defined in Amazonka.RAM.CreateResourceShare

Show CreateResourceShareResponse Source # 
Instance details

Defined in Amazonka.RAM.CreateResourceShare

NFData CreateResourceShareResponse Source # 
Instance details

Defined in Amazonka.RAM.CreateResourceShare

Eq CreateResourceShareResponse Source # 
Instance details

Defined in Amazonka.RAM.CreateResourceShare

type Rep CreateResourceShareResponse Source # 
Instance details

Defined in Amazonka.RAM.CreateResourceShare

type Rep CreateResourceShareResponse = D1 ('MetaData "CreateResourceShareResponse" "Amazonka.RAM.CreateResourceShare" "amazonka-ram-2.0-2ZD9k8USaHb58ZVl9MaFYL" 'False) (C1 ('MetaCons "CreateResourceShareResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "resourceShare") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResourceShare)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateResourceShareResponse Source #

Create a value of CreateResourceShareResponse 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:

CreateResourceShare, createResourceShareResponse_clientToken - The idempotency identifier associated with this request. If you want to repeat the same operation in an idempotent manner then you must include this value in the clientToken request parameter of that later call. All other parameters must also have the same values that you used in the first call.

$sel:resourceShare:CreateResourceShareResponse', createResourceShareResponse_resourceShare - An object with information about the new resource share.

$sel:httpStatus:CreateResourceShareResponse', createResourceShareResponse_httpStatus - The response's http status code.

Response Lenses

createResourceShareResponse_clientToken :: Lens' CreateResourceShareResponse (Maybe Text) Source #

The idempotency identifier associated with this request. If you want to repeat the same operation in an idempotent manner then you must include this value in the clientToken request parameter of that later call. All other parameters must also have the same values that you used in the first call.

createResourceShareResponse_resourceShare :: Lens' CreateResourceShareResponse (Maybe ResourceShare) Source #

An object with information about the new resource share.