Class: Aws::ServiceCatalog::Types::CreatePortfolioShareInput

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 CreatePortfolioShareInput data as a hash:

{
  accept_language: "AcceptLanguage",
  portfolio_id: "Id", # required
  account_id: "AccountId",
  organization_node: {
    type: "ORGANIZATION", # accepts ORGANIZATION, ORGANIZATIONAL_UNIT, ACCOUNT
    value: "OrganizationNodeValue",
  },
  share_tag_options: false,
  share_principals: false,
}

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#accept_language ⇒ String

The language code.

  • ‘en` - English (default)

  • ‘jp` - Japanese

  • ‘zh` - Chinese

Returns:

  • (String) 


963
964
965
966
967
968
969
970
971
972
 
# File 'lib/aws-sdk-servicecatalog/types.rb', line 963

class CreatePortfolioShareInput < Struct.new(
  :accept_language,
  :portfolio_id,
  :account_id,
  :organization_node,
  :share_tag_options,
  :share_principals)
  SENSITIVE = []
  include Aws::Structure
end

#account_id ⇒ String

The Amazon Web Services account ID. For example, ‘123456789012`.

Returns:

  • (String) 


963
964
965
966
967
968
969
970
971
972
 
# File 'lib/aws-sdk-servicecatalog/types.rb', line 963

class CreatePortfolioShareInput < Struct.new(
  :accept_language,
  :portfolio_id,
  :account_id,
  :organization_node,
  :share_tag_options,
  :share_principals)
  SENSITIVE = []
  include Aws::Structure
end

#organization_node ⇒ Types::OrganizationNode

The organization node to whom you are going to share. When you pass ‘OrganizationNode`, it creates `PortfolioShare` for all of the Amazon Web Services accounts that are associated to the `OrganizationNode`. The output returns a `PortfolioShareToken`, which enables the administrator to monitor the status of the `PortfolioShare` creation process.

Returns:



963
964
965
966
967
968
969
970
971
972
 
# File 'lib/aws-sdk-servicecatalog/types.rb', line 963

class CreatePortfolioShareInput < Struct.new(
  :accept_language,
  :portfolio_id,
  :account_id,
  :organization_node,
  :share_tag_options,
  :share_principals)
  SENSITIVE = []
  include Aws::Structure
end

#portfolio_id ⇒ String

The portfolio identifier.

Returns:

  • (String) 


963
964
965
966
967
968
969
970
971
972
 
# File 'lib/aws-sdk-servicecatalog/types.rb', line 963

class CreatePortfolioShareInput < Struct.new(
  :accept_language,
  :portfolio_id,
  :account_id,
  :organization_node,
  :share_tag_options,
  :share_principals)
  SENSITIVE = []
  include Aws::Structure
end

#share_principals ⇒ Boolean

Enables or disables ‘Principal` sharing when creating the portfolio share. If this flag is not provided, principal sharing is disabled.

When you enable Principal Name Sharing for a portfolio share, the share recipient account end users with a principal that matches any of the associated IAM patterns can provision products from the portfolio. Once shared, the share recipient can view associations of ‘PrincipalType`: `IAM_PATTERN` on their portfolio. You can create the principals in the recipient account before or after creating the share.

Returns:

  • (Boolean) 


963
964
965
966
967
968
969
970
971
972
 
# File 'lib/aws-sdk-servicecatalog/types.rb', line 963

class CreatePortfolioShareInput < Struct.new(
  :accept_language,
  :portfolio_id,
  :account_id,
  :organization_node,
  :share_tag_options,
  :share_principals)
  SENSITIVE = []
  include Aws::Structure
end

#share_tag_options ⇒ Boolean

Enables or disables ‘TagOptions ` sharing when creating the portfolio share. If this flag is not provided, TagOptions sharing is disabled.

Returns:

  • (Boolean) 


963
964
965
966
967
968
969
970
971
972
 
# File 'lib/aws-sdk-servicecatalog/types.rb', line 963

class CreatePortfolioShareInput < Struct.new(
  :accept_language,
  :portfolio_id,
  :account_id,
  :organization_node,
  :share_tag_options,
  :share_principals)
  SENSITIVE = []
  include Aws::Structure
end