Package software.amazon.awssdk.services.ram.model

Interface CreateResourceShareRequest.Builder

    • Method Detail

      • name

        CreateResourceShareRequest.Builder name​(String name)

        Specifies the name of the resource share.

        Parameters:
        name - Specifies the name of the resource share.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • resourceArns

        CreateResourceShareRequest.Builder resourceArns​(Collection<String> resourceArns)

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

        Parameters:
        resourceArns - Specifies a list of one or more ARNs of the resources to associate with the resource share.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • resourceArns

        CreateResourceShareRequest.Builder resourceArns​(String... resourceArns)

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

        Parameters:
        resourceArns - Specifies a list of one or more ARNs of the resources to associate with the resource share.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • principals

        CreateResourceShareRequest.Builder principals​(Collection<String> 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 Resource 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.

        Parameters:
        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 Resource 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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • principals

        CreateResourceShareRequest.Builder principals​(String... 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 Resource 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.

        Parameters:
        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 Resource 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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        CreateResourceShareRequest.Builder tags​(Collection<Tag> 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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        CreateResourceShareRequest.Builder tags​(Tag... 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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        CreateResourceShareRequest.Builder tags​(Consumer<Tag.Builder>... 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.

        This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

        Parameters:
        tags - a consumer that will call methods on Tag.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #tags(java.util.Collection)

      • allowExternalPrincipals

        CreateResourceShareRequest.Builder allowExternalPrincipals​(Boolean 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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • clientToken

        CreateResourceShareRequest.Builder clientToken​(String 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.

        If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.

        Parameters:
        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.

        If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • permissionArns

        CreateResourceShareRequest.Builder permissionArns​(Collection<String> 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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • permissionArns

        CreateResourceShareRequest.Builder permissionArns​(String... 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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sources

        CreateResourceShareRequest.Builder sources​(Collection<String> sources)

        Specifies from which source accounts the service principal has access to the resources in this resource share.

        Parameters:
        sources - Specifies from which source accounts the service principal has access to the resources in this resource share.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sources

        CreateResourceShareRequest.Builder sources​(String... sources)

        Specifies from which source accounts the service principal has access to the resources in this resource share.

        Parameters:
        sources - Specifies from which source accounts the service principal has access to the resources in this resource share.
        Returns:
        Returns a reference to this object so that method calls can be chained together.