software.amazon.awssdk.services.servicecatalog.model

Class AssociatePrincipalWithPortfolioRequest

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.AssociatePrincipalWithPortfolioRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<AssociatePrincipalWithPortfolioRequest.Builder,AssociatePrincipalWithPortfolioRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AssociatePrincipalWithPortfolioRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	acceptLanguage() The language code.
static AssociatePrincipalWithPortfolioRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	portfolioId() The portfolio identifier.
String	principalARN() The ARN of the principal (user, role, or group).
PrincipalType	principalType() The principal type.
String	principalTypeAsString() The principal type.
List<SdkField<?>>	sdkFields()
static Class<? extends AssociatePrincipalWithPortfolioRequest.Builder>	serializableBuilderClass()
AssociatePrincipalWithPortfolioRequest.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.

principalARN

public final String principalARN()

The ARN of the principal (user, role, or group). If the PrincipalType is IAM, the supported value is a fully defined IAM Amazon Resource Name (ARN). If the PrincipalType is IAM_PATTERN, the supported value is an IAM ARN without an AccountID in the following format:

arn:partition:iam:::resource-type/resource-id

The ARN resource-id can be either:

• A fully formed resource-id. For example, arn:aws:iam:::role/resource-name or arn:aws:iam:::role/resource-path/resource-name

• A wildcard ARN. The wildcard ARN accepts IAM_PATTERN values with a "*" or "?" in the resource-id segment of the ARN. For example arn:partition:service:::resource-type/resource-path/resource-name. The new symbols are exclusive to the resource-path and resource-name and cannot replace the resource-type or other ARN values.

  The ARN path and principal name allow unlimited wildcard characters.

Examples of an acceptable wildcard ARN:

• arn:aws:iam:::role/ResourceName_*

• arn:aws:iam:::role/*/ResourceName_?

Examples of an unacceptable wildcard ARN:

• arn:aws:iam:::*/ResourceName

You can associate multiple IAM_PATTERNs even if the account has no principal with that name.

The "?" wildcard character matches zero or one of any character. This is similar to ".?" in regular regex context. The "*" wildcard character matches any number of any characters. This is similar to ".*" in regular regex context.

In the IAM Principal ARN format (arn:partition:iam:::resource-type/resource-path/resource-name), valid resource-type values include user/, group/, or role/. The "?" and "*" characters are allowed only after the resource-type in the resource-id segment. You can use special characters anywhere within the resource-id.

The "*" character also matches the "/" character, allowing paths to be formed within the resource-id. For example, arn:aws:iam:::role/*/ResourceName_? matches both arn:aws:iam:::role/pathA/pathB/ResourceName_1 and arn:aws:iam:::role/pathA/ResourceName_1.

Returns:

The ARN of the principal (user, role, or group). If the PrincipalType is IAM, the supported value is a fully defined IAM Amazon Resource Name (ARN). If the PrincipalType is IAM_PATTERN, the supported value is an IAM ARN without an AccountID in the following format:

arn:partition:iam:::resource-type/resource-id

The ARN resource-id can be either:

• A fully formed resource-id. For example, arn:aws:iam:::role/resource-name or arn:aws:iam:::role/resource-path/resource-name

• A wildcard ARN. The wildcard ARN accepts IAM_PATTERN values with a "*" or "?" in the resource-id segment of the ARN. For example arn:partition:service:::resource-type/resource-path/resource-name. The new symbols are exclusive to the resource-path and resource-name and cannot replace the resource-type or other ARN values.

  The ARN path and principal name allow unlimited wildcard characters.

Examples of an acceptable wildcard ARN:

• arn:aws:iam:::role/ResourceName_*

• arn:aws:iam:::role/*/ResourceName_?

Examples of an unacceptable wildcard ARN:

• arn:aws:iam:::*/ResourceName

You can associate multiple IAM_PATTERNs even if the account has no principal with that name.

The "?" wildcard character matches zero or one of any character. This is similar to ".?" in regular regex context. The "*" wildcard character matches any number of any characters. This is similar to ".*" in regular regex context.

In the IAM Principal ARN format (arn:partition:iam:::resource-type/resource-path/resource-name), valid resource-type values include user/, group/, or role/. The "?" and "*" characters are allowed only after the resource-type in the resource-id segment. You can use special characters anywhere within the resource-id.

The "*" character also matches the "/" character, allowing paths to be formed within the resource-id. For example, arn:aws:iam:::role/*/ResourceName_? matches both arn:aws:iam:::role/pathA/pathB/ResourceName_1 and arn:aws:iam:::role/pathA/ResourceName_1.

principalType

public final PrincipalType principalType()

The principal type. The supported value is IAM if you use a fully defined Amazon Resource Name (ARN), or IAM_PATTERN if you use an ARN with no accountID, with or without wildcard characters.

If the service returns an enum value that is not available in the current SDK version, principalType will return PrincipalType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from principalTypeAsString().

Returns:

The principal type. The supported value is IAM if you use a fully defined Amazon Resource Name (ARN), or IAM_PATTERN if you use an ARN with no accountID, with or without wildcard characters.

See Also:

PrincipalType

principalTypeAsString

public final String principalTypeAsString()

The principal type. The supported value is IAM if you use a fully defined Amazon Resource Name (ARN), or IAM_PATTERN if you use an ARN with no accountID, with or without wildcard characters.

If the service returns an enum value that is not available in the current SDK version, principalType will return PrincipalType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from principalTypeAsString().

Returns:

The principal type. The supported value is IAM if you use a fully defined Amazon Resource Name (ARN), or IAM_PATTERN if you use an ARN with no accountID, with or without wildcard characters.

See Also:

PrincipalType

toBuilder

public AssociatePrincipalWithPortfolioRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AssociatePrincipalWithPortfolioRequest.Builder,AssociatePrincipalWithPortfolioRequest>

Specified by:

toBuilder in class ServiceCatalogRequest

builder

public static AssociatePrincipalWithPortfolioRequest.Builder builder()

serializableBuilderClass

public static Class<? extends AssociatePrincipalWithPortfolioRequest.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