You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::CognitoSync::Types::SetIdentityPoolConfigurationRequest

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

Overview

Note:

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

{
  identity_pool_id: "IdentityPoolId", # required
  push_sync: {
    application_arns: ["ApplicationArn"],
    role_arn: "AssumeRoleArn",
  },
  cognito_streams: {
    stream_name: "StreamName",
    role_arn: "AssumeRoleArn",
    streaming_status: "ENABLED", # accepts ENABLED, DISABLED
  },
}

The input for the SetIdentityPoolConfiguration operation.

Instance Attribute Summary collapse

Instance Attribute Details

#cognito_streamsTypes::CognitoStreams

Options to apply to this identity pool for Amazon Cognito streams.



1001
1002
1003
1004
1005
1006
# File 'gems/aws-sdk-cognitosync/lib/aws-sdk-cognitosync/types.rb', line 1001

class SetIdentityPoolConfigurationRequest < Struct.new(
  :identity_pool_id,
  :push_sync,
  :cognito_streams)
  include Aws::Structure
end

#identity_pool_idString

A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. This is the ID of the pool to modify.

Returns:

  • (String)


1001
1002
1003
1004
1005
1006
# File 'gems/aws-sdk-cognitosync/lib/aws-sdk-cognitosync/types.rb', line 1001

class SetIdentityPoolConfigurationRequest < Struct.new(
  :identity_pool_id,
  :push_sync,
  :cognito_streams)
  include Aws::Structure
end

#push_syncTypes::PushSync

Options to apply to this identity pool for push synchronization.

Returns:



1001
1002
1003
1004
1005
1006
# File 'gems/aws-sdk-cognitosync/lib/aws-sdk-cognitosync/types.rb', line 1001

class SetIdentityPoolConfigurationRequest < Struct.new(
  :identity_pool_id,
  :push_sync,
  :cognito_streams)
  include Aws::Structure
end