software.amazon.awssdk.services.servicecatalog.model

Interface CreatePortfolioShareRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreatePortfolioShareRequest.Builder,CreatePortfolioShareRequest>, SdkBuilder<CreatePortfolioShareRequest.Builder,CreatePortfolioShareRequest>, SdkPojo, SdkRequest.Builder, ServiceCatalogRequest.Builder

Enclosing class:

CreatePortfolioShareRequest

public static interface CreatePortfolioShareRequest.Builder
extends ServiceCatalogRequest.Builder, SdkPojo, CopyableBuilder<CreatePortfolioShareRequest.Builder,CreatePortfolioShareRequest>

Method Summary

Modifier and Type	Method and Description
CreatePortfolioShareRequest.Builder	acceptLanguage(String acceptLanguage) The language code.
CreatePortfolioShareRequest.Builder	accountId(String accountId) The Amazon Web Services account ID.
default CreatePortfolioShareRequest.Builder	organizationNode(Consumer<OrganizationNode.Builder> organizationNode) The organization node to whom you are going to share.
CreatePortfolioShareRequest.Builder	organizationNode(OrganizationNode organizationNode) The organization node to whom you are going to share.
CreatePortfolioShareRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreatePortfolioShareRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreatePortfolioShareRequest.Builder	portfolioId(String portfolioId) The portfolio identifier.
CreatePortfolioShareRequest.Builder	sharePrincipals(Boolean sharePrincipals) Enables or disables Principal sharing when creating the portfolio share.
CreatePortfolioShareRequest.Builder	shareTagOptions(Boolean shareTagOptions) Enables or disables TagOptions sharing when creating the portfolio share.

Methods inherited from interface software.amazon.awssdk.services.servicecatalog.model.ServiceCatalogRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

acceptLanguage

CreatePortfolioShareRequest.Builder acceptLanguage(String acceptLanguage)

The language code.

• jp - Japanese

• zh - Chinese

Parameters:

acceptLanguage - The language code.

• jp - Japanese

• zh - Chinese

Returns:

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

portfolioId

CreatePortfolioShareRequest.Builder portfolioId(String portfolioId)

The portfolio identifier.

Parameters:

portfolioId - The portfolio identifier.

Returns:

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

accountId

CreatePortfolioShareRequest.Builder accountId(String accountId)

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

Parameters:

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

Returns:

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

organizationNode

CreatePortfolioShareRequest.Builder organizationNode(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.

Parameters:

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:

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

organizationNode

default CreatePortfolioShareRequest.Builder organizationNode(Consumer<OrganizationNode.Builder> 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.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to organizationNode(OrganizationNode).

Parameters:

organizationNode - a consumer that will call methods on OrganizationNode.Builder

Returns:

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

See Also:

organizationNode(OrganizationNode)

shareTagOptions

CreatePortfolioShareRequest.Builder shareTagOptions(Boolean shareTagOptions)

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

Parameters:

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

Returns:

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

sharePrincipals

CreatePortfolioShareRequest.Builder sharePrincipals(Boolean sharePrincipals)

Enables or disables Principal sharing when creating the portfolio share. If this flag is not provided, 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.

Parameters:

sharePrincipals - Enables or disables Principal sharing when creating the portfolio share. If this flag is not provided, 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:

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

overrideConfiguration

CreatePortfolioShareRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

CreatePortfolioShareRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder