Class: Aws::ServiceCatalog::Types::AssociatePrincipalWithPortfolioInput

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-servicecatalog/types.rb

Overview

Note:

When making an API call, you may pass AssociatePrincipalWithPortfolioInput data as a hash:

{
  accept_language: "AcceptLanguage",
  portfolio_id: "Id", # required
  principal_arn: "PrincipalARN", # required
  principal_type: "IAM", # required, accepts IAM, IAM_PATTERN
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#accept_languageString

The language code.

  • ‘en` - English (default)

  • ‘jp` - Japanese

  • ‘zh` - Chinese

Returns:

  • (String)


173
174
175
176
177
178
179
180
# File 'lib/aws-sdk-servicecatalog/types.rb', line 173

class AssociatePrincipalWithPortfolioInput < Struct.new(
  :accept_language,
  :portfolio_id,
  :principal_arn,
  :principal_type)
  SENSITIVE = []
  include Aws::Structure
end

#portfolio_idString

The portfolio identifier.

Returns:

  • (String)


173
174
175
176
177
178
179
180
# File 'lib/aws-sdk-servicecatalog/types.rb', line 173

class AssociatePrincipalWithPortfolioInput < Struct.new(
  :accept_language,
  :portfolio_id,
  :principal_arn,
  :principal_type)
  SENSITIVE = []
  include Aws::Structure
end

#principal_arnString

The ARN of the principal (IAM user, role, or group). This field allows an ARN with no ‘accountID` if `PrincipalType` is `IAM_PATTERN`.

You can associate multiple ‘IAM` patterns even if the account has no principal with that name. This is useful in Principal Name Sharing if you want to share a principal without creating it in the account that owns the portfolio.

Returns:

  • (String)


173
174
175
176
177
178
179
180
# File 'lib/aws-sdk-servicecatalog/types.rb', line 173

class AssociatePrincipalWithPortfolioInput < Struct.new(
  :accept_language,
  :portfolio_id,
  :principal_arn,
  :principal_type)
  SENSITIVE = []
  include Aws::Structure
end

#principal_typeString

The principal type. The supported value is ‘IAM` if you use a fully defined ARN, or `IAM_PATTERN` if you use an ARN with no `accountID`.

Returns:

  • (String)


173
174
175
176
177
178
179
180
# File 'lib/aws-sdk-servicecatalog/types.rb', line 173

class AssociatePrincipalWithPortfolioInput < Struct.new(
  :accept_language,
  :portfolio_id,
  :principal_arn,
  :principal_type)
  SENSITIVE = []
  include Aws::Structure
end