Package software.amazon.awscdk.services.ram

Interface CfnResourceShareProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnResourceShareProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:34.894Z") @Stability(Stable) public interface CfnResourceShareProps extends software.amazon.jsii.JsiiSerializable
Properties for defining a CfnResourceShare.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ram.*;
 CfnResourceShareProps cfnResourceShareProps = CfnResourceShareProps.builder()
         .name("name")
         // the properties below are optional
         .allowExternalPrincipals(false)
         .permissionArns(List.of("permissionArns"))
         .principals(List.of("principals"))
         .resourceArns(List.of("resourceArns"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

  • Method Details

    • getName

      @Stability(Stable) @NotNull String getName()
      Specifies the name of the resource share.

    • getAllowExternalPrincipals

      @Stability(Stable) @Nullable default Object getAllowExternalPrincipals()
      Specifies whether principals outside your organization in AWS Organizations can be associated with a resource share.

      A value of true lets you share with individual AWS accounts that are not in your organization. A value of false only has meaning if your account is a member of an AWS Organization. The default value is true .

    • getPermissionArns

      @Stability(Stable) @Nullable default List<String> getPermissionArns()
      Specifies the Amazon Resource Names (ARNs) of the AWS RAM permission to associate with the resource share. If you do not specify an ARN for the permission, AWS 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.

    • getPrincipals

      @Stability(Stable) @Nullable default List<String> getPrincipals()
      Specifies the principals to associate with the resource share. The possible values are:.

      • An AWS account ID
      • An Amazon Resource Name (ARN) of an organization in AWS Organizations
      • An ARN of an organizational unit (OU) in AWS Organizations
      • An ARN of an IAM role
      • An ARN of an IAM user

      Not all resource types can be shared with IAM roles and users. For more information, see the column Can share with IAM roles and users in the tables on Shareable AWS resources in the AWS Resource Access Manager User Guide .

    • getResourceArns

      @Stability(Stable) @Nullable default List<String> getResourceArns()
      Specifies a list of one or more ARNs of the resources to associate with the resource share.

    • getTags

      @Stability(Stable) @Nullable default List<CfnTag> getTags()
      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.

    • builder

      @Stability(Stable) static CfnResourceShareProps.Builder builder()
      Returns:
      a CfnResourceShareProps.Builder of CfnResourceShareProps