Package software.amazon.awssdk.services.servicecatalog.model

Class CreatePortfolioShareRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.servicecatalog.model.ServiceCatalogRequest

software.amazon.awssdk.services.servicecatalog.model.CreatePortfolioShareRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreatePortfolioShareRequest.Builder,CreatePortfolioShareRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreatePortfolioShareRequest
extends ServiceCatalogRequest
implements ToCopyableBuilder<CreatePortfolioShareRequest.Builder,CreatePortfolioShareRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreatePortfolioShareRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	acceptLanguage()	The language code.
String	accountId()	The Amazon Web Services account ID.
static CreatePortfolioShareRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
OrganizationNode	organizationNode()	The organization node to whom you are going to share.
String	portfolioId()	The portfolio identifier.
List<SdkField<?>>	sdkFields()
static Class<? extends CreatePortfolioShareRequest.Builder>	serializableBuilderClass()
Boolean	sharePrincipals()	This parameter is only supported for portfolios with an OrganizationalNode Type of ORGANIZATION or ORGANIZATIONAL_UNIT.
Boolean	shareTagOptions()	Enables or disables TagOptions sharing when creating the portfolio share.
CreatePortfolioShareRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

acceptLanguage

public final String acceptLanguage()

The language code.

• jp - Japanese

• zh - Chinese

Returns:

The language code.

• jp - Japanese

• zh - Chinese

portfolioId

public final String portfolioId()

The portfolio identifier.

Returns:

The portfolio identifier.

accountId

public final String accountId()

The Amazon Web Services account ID. For example, 123456789012.

Returns:

The Amazon Web Services account ID. For example, 123456789012.

organizationNode

public final OrganizationNode organizationNode()

The organization node to whom you are going to share. When you pass OrganizationNode, it creates PortfolioShare for all of the Amazon Web Services accounts that are associated to the OrganizationNode. The output returns a PortfolioShareToken, which enables the administrator to monitor the status of the PortfolioShare creation process.

Returns:

The organization node to whom you are going to share. When you pass OrganizationNode, it creates PortfolioShare for all of the Amazon Web Services accounts that are associated to the OrganizationNode. The output returns a PortfolioShareToken, which enables the administrator to monitor the status of the PortfolioShare creation process.

shareTagOptions

public final Boolean shareTagOptions()

Enables or disables TagOptions sharing when creating the portfolio share. If this flag is not provided, TagOptions sharing is disabled.

Returns:

Enables or disables TagOptions sharing when creating the portfolio share. If this flag is not provided, TagOptions sharing is disabled.

sharePrincipals

public final Boolean sharePrincipals()

This parameter is only supported for portfolios with an OrganizationalNode Type of ORGANIZATION or ORGANIZATIONAL_UNIT.

Enables or disables Principal sharing when creating the portfolio share. If you do not provide this flag, principal sharing is disabled.

When you enable Principal Name Sharing for a portfolio share, the share recipient account end users with a principal that matches any of the associated IAM patterns can provision products from the portfolio. Once shared, the share recipient can view associations of PrincipalType: IAM_PATTERN on their portfolio. You can create the principals in the recipient account before or after creating the share.

Returns:

This parameter is only supported for portfolios with an OrganizationalNode Type of ORGANIZATION or ORGANIZATIONAL_UNIT.

Enables or disables Principal sharing when creating the portfolio share. If you do not provide this flag, principal sharing is disabled.

When you enable Principal Name Sharing for a portfolio share, the share recipient account end users with a principal that matches any of the associated IAM patterns can provision products from the portfolio. Once shared, the share recipient can view associations of PrincipalType: IAM_PATTERN on their portfolio. You can create the principals in the recipient account before or after creating the share.

toBuilder

public CreatePortfolioShareRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreatePortfolioShareRequest.Builder,CreatePortfolioShareRequest>

Specified by:

toBuilder in class ServiceCatalogRequest

builder

public static CreatePortfolioShareRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreatePortfolioShareRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo