Interface AssociatePrincipalWithPortfolioRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<AssociatePrincipalWithPortfolioRequest.Builder,AssociatePrincipalWithPortfolioRequest>, SdkBuilder<AssociatePrincipalWithPortfolioRequest.Builder,AssociatePrincipalWithPortfolioRequest>, SdkPojo, SdkRequest.Builder, ServiceCatalogRequest.Builder
Enclosing class:
AssociatePrincipalWithPortfolioRequest
public static interface AssociatePrincipalWithPortfolioRequest.Builder extends ServiceCatalogRequest.Builder, SdkPojo, CopyableBuilder<AssociatePrincipalWithPortfolioRequest.Builder,AssociatePrincipalWithPortfolioRequest>

  • Method Details

    • acceptLanguage

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

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

    • principalARN

      AssociatePrincipalWithPortfolioRequest.Builder principalARN(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.

    • principalType

      AssociatePrincipalWithPortfolioRequest.Builder principalType(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

      AssociatePrincipalWithPortfolioRequest.Builder principalType(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:

    • overrideConfiguration

      AssociatePrincipalWithPortfolioRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      AssociatePrincipalWithPortfolioRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.