Package software.amazon.awscdk.services.servicecatalogappregistry.alpha

Interface ShareOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ShareOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:16.068Z")
@Stability(Experimental)
public interface ShareOptions
extends software.amazon.jsii.JsiiSerializable

(experimental) The options that are passed into a share of an Application or Attribute Group.

Example:

 import software.amazon.awscdk.services.iam.*;
 Application application;
 IRole myRole;
 IUser myUser;
 application.shareApplication("MyShareId", ShareOptions.builder()
         .name("MyShare")
         .accounts(List.of("123456789012"))
         .organizationArns(List.of("arn:aws:organizations::123456789012:organization/o-my-org-id"))
         .roles(List.of(myRole))
         .users(List.of(myUser))
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	ShareOptions.Builder	A builder for ShareOptions
static final class	ShareOptions.Jsii$Proxy	An implementation for ShareOptions

Method Summary

Modifier and Type	Method	Description
static ShareOptions.Builder	builder()
default List<String>	getAccounts()	(experimental) A list of AWS accounts that the application will be shared with.
String	getName()	(experimental) Name of the share.
default List<String>	getOrganizationArns()	(experimental) A list of AWS Organization or Organizational Units (OUs) ARNs that the application will be shared with.
default List<IRole>	getRoles()	(experimental) A list of AWS IAM roles that the application will be shared with.
default Object	getSharePermission()	(experimental) An option to manage access to the application or attribute group.
default List<IUser>	getUsers()	(experimental) A list of AWS IAM users that the application will be shared with.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Experimental)
@NotNull
String getName()

(experimental) Name of the share.

getAccounts

@Stability(Experimental)
@Nullable
default List<String> getAccounts()

(experimental) A list of AWS accounts that the application will be shared with.

Default: - No accounts specified for share

getOrganizationArns

@Stability(Experimental)
@Nullable
default List<String> getOrganizationArns()

(experimental) A list of AWS Organization or Organizational Units (OUs) ARNs that the application will be shared with.

Default: - No AWS Organizations or OUs specified for share

getRoles

@Stability(Experimental)
@Nullable
default List<IRole> getRoles()

(experimental) A list of AWS IAM roles that the application will be shared with.

Default: - No IAM roles specified for share

getSharePermission

@Stability(Experimental)
@Nullable
default Object getSharePermission()

(experimental) An option to manage access to the application or attribute group.

Default: - Principals will be assigned read only permissions on the application or attribute group.

getUsers

@Stability(Experimental)
@Nullable
default List<IUser> getUsers()

(experimental) A list of AWS IAM users that the application will be shared with.

Default: - No IAM Users specified for share

builder

@Stability(Experimental)
static ShareOptions.Builder builder()

Returns:

a ShareOptions.Builder of ShareOptions