com.amazonaws.services.servicecatalog.model

Class AssociatePrincipalWithPortfolioRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.servicecatalog.model.AssociatePrincipalWithPortfolioRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AssociatePrincipalWithPortfolioRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
AssociatePrincipalWithPortfolioRequest()

Method Summary

Modifier and Type	Method and Description
AssociatePrincipalWithPortfolioRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getAcceptLanguage() The language code.
String	getPortfolioId() The portfolio identifier.
String	getPrincipalARN() The ARN of the principal (user, role, or group).
String	getPrincipalType() The principal type.
int	hashCode()
void	setAcceptLanguage(String acceptLanguage) The language code.
void	setPortfolioId(String portfolioId) The portfolio identifier.
void	setPrincipalARN(String principalARN) The ARN of the principal (user, role, or group).
void	setPrincipalType(PrincipalType principalType) The principal type.
void	setPrincipalType(String principalType) The principal type.
String	toString() Returns a string representation of this object.
AssociatePrincipalWithPortfolioRequest	withAcceptLanguage(String acceptLanguage) The language code.
AssociatePrincipalWithPortfolioRequest	withPortfolioId(String portfolioId) The portfolio identifier.
AssociatePrincipalWithPortfolioRequest	withPrincipalARN(String principalARN) The ARN of the principal (user, role, or group).
AssociatePrincipalWithPortfolioRequest	withPrincipalType(PrincipalType principalType) The principal type.
AssociatePrincipalWithPortfolioRequest	withPrincipalType(String principalType) The principal type.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AssociatePrincipalWithPortfolioRequest

public AssociatePrincipalWithPortfolioRequest()

Method Detail

setAcceptLanguage

public void setAcceptLanguage(String acceptLanguage)

The language code.

• jp - Japanese

• zh - Chinese

Parameters:

acceptLanguage - The language code.

• jp - Japanese

• zh - Chinese

getAcceptLanguage

public String getAcceptLanguage()

The language code.

• jp - Japanese

• zh - Chinese

Returns:

The language code.

• jp - Japanese

• zh - Chinese

withAcceptLanguage

public AssociatePrincipalWithPortfolioRequest withAcceptLanguage(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.

setPortfolioId

public void setPortfolioId(String portfolioId)

The portfolio identifier.

Parameters:

portfolioId - The portfolio identifier.

getPortfolioId

public String getPortfolioId()

The portfolio identifier.

Returns:

The portfolio identifier.

withPortfolioId

public AssociatePrincipalWithPortfolioRequest withPortfolioId(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.

setPrincipalARN

public void setPrincipalARN(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.

Parameters:

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.

getPrincipalARN

public String getPrincipalARN()

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.

withPrincipalARN

public AssociatePrincipalWithPortfolioRequest withPrincipalARN(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.

Parameters:

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:

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

setPrincipalType

public void setPrincipalType(String 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.

Parameters:

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.

See Also:

PrincipalType

getPrincipalType

public String getPrincipalType()

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.

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

withPrincipalType

public AssociatePrincipalWithPortfolioRequest withPrincipalType(String 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.

Parameters:

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.

Returns:

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

See Also:

PrincipalType

setPrincipalType

public void setPrincipalType(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.

Parameters:

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.

See Also:

PrincipalType

withPrincipalType

public AssociatePrincipalWithPortfolioRequest withPrincipalType(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.

Parameters:

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.

Returns:

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

See Also:

PrincipalType

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public AssociatePrincipalWithPortfolioRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()