Class: Aws::CognitoIdentity::Types::SetPrincipalTagAttributeMapInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/types.rb

Overview

Note:

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

{
  identity_pool_id: "IdentityPoolId", # required
  identity_provider_name: "IdentityProviderName", # required
  use_defaults: false,
  principal_tags: {
    "PrincipalTagID" => "PrincipalTagValue",
  },
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#identity_pool_idString

The ID of the Identity Pool you want to set attribute mappings for.

Returns:

  • (String)


1466
1467
1468
1469
1470
1471
1472
1473
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/types.rb', line 1466

class SetPrincipalTagAttributeMapInput < Struct.new(
  :identity_pool_id,
  :identity_provider_name,
  :use_defaults,
  :principal_tags)
  SENSITIVE = []
  include Aws::Structure
end

#identity_provider_nameString

The provider name you want to use for attribute mappings.

Returns:

  • (String)


1466
1467
1468
1469
1470
1471
1472
1473
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/types.rb', line 1466

class SetPrincipalTagAttributeMapInput < Struct.new(
  :identity_pool_id,
  :identity_provider_name,
  :use_defaults,
  :principal_tags)
  SENSITIVE = []
  include Aws::Structure
end

#principal_tagsHash<String,String>

You can use this operation to add principal tags.

Returns:

  • (Hash<String,String>)


1466
1467
1468
1469
1470
1471
1472
1473
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/types.rb', line 1466

class SetPrincipalTagAttributeMapInput < Struct.new(
  :identity_pool_id,
  :identity_provider_name,
  :use_defaults,
  :principal_tags)
  SENSITIVE = []
  include Aws::Structure
end

#use_defaultsBoolean

You can use this operation to use default (username and clientID) attribute mappings.

Returns:

  • (Boolean)


1466
1467
1468
1469
1470
1471
1472
1473
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/types.rb', line 1466

class SetPrincipalTagAttributeMapInput < Struct.new(
  :identity_pool_id,
  :identity_provider_name,
  :use_defaults,
  :principal_tags)
  SENSITIVE = []
  include Aws::Structure
end