Class AssociatePrincipalWithPortfolioRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<AssociatePrincipalWithPortfolioRequest.Builder,
AssociatePrincipalWithPortfolioRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The language code.builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final String
The portfolio identifier.final String
The ARN of the principal (user, role, or group).final PrincipalType
The principal type.final String
The principal type.static Class
<? extends AssociatePrincipalWithPortfolioRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
acceptLanguage
The language code.
-
jp
- Japanese -
zh
- Chinese
- Returns:
- The language code.
-
jp
- Japanese -
zh
- Chinese
-
-
-
portfolioId
The portfolio identifier.
- Returns:
- The portfolio identifier.
-
principalARN
The ARN of the principal (user, role, or group). If the
PrincipalType
isIAM
, the supported value is a fully defined IAM Amazon Resource Name (ARN). If thePrincipalType
isIAM_PATTERN
, the supported value is anIAM
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_PATTERN
s 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
isIAM
, the supported value is a fully defined IAM Amazon Resource Name (ARN). If thePrincipalType
isIAM_PATTERN
, the supported value is anIAM
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_PATTERN
s 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
The principal type. The supported value is
IAM
if you use a fully defined Amazon Resource Name (ARN), orIAM_PATTERN
if you use an ARN with noaccountID
, with or without wildcard characters.If the service returns an enum value that is not available in the current SDK version,
principalType
will returnPrincipalType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromprincipalTypeAsString()
.- Returns:
- The principal type. The supported value is
IAM
if you use a fully defined Amazon Resource Name (ARN), orIAM_PATTERN
if you use an ARN with noaccountID
, with or without wildcard characters. - See Also:
-
principalTypeAsString
The principal type. The supported value is
IAM
if you use a fully defined Amazon Resource Name (ARN), orIAM_PATTERN
if you use an ARN with noaccountID
, with or without wildcard characters.If the service returns an enum value that is not available in the current SDK version,
principalType
will returnPrincipalType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromprincipalTypeAsString()
.- Returns:
- The principal type. The supported value is
IAM
if you use a fully defined Amazon Resource Name (ARN), orIAM_PATTERN
if you use an ARN with noaccountID
, with or without wildcard characters. - See Also:
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<AssociatePrincipalWithPortfolioRequest.Builder,
AssociatePrincipalWithPortfolioRequest> - Specified by:
toBuilder
in classServiceCatalogRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends AssociatePrincipalWithPortfolioRequest.Builder> serializableBuilderClass() -
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-