AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing SetIdentityPoolConfigurationRequest as input to an Aws::Client method, you can use a vanilla 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.

Returns:

#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)

    A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito.

#push_syncTypes::PushSync

Options to apply to this identity pool for push synchronization.

Returns:

  • (Types::PushSync)

    Options to apply to this identity pool for push synchronization.