Class: Aws::AmplifyBackend::Types::BackendAPIResourceConfig

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

Overview

Note:

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

{
  additional_auth_types: [
    {
      mode: "API_KEY", # accepts API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT
      settings: {
        cognito_user_pool_id: "__string",
        description: "__string",
        expiration_time: 1.0,
        open_id_auth_ttl: "__string",
        open_id_client_id: "__string",
        open_id_iat_ttl: "__string",
        open_id_issue_url: "__string",
        open_id_provider_name: "__string",
      },
    },
  ],
  api_name: "__string",
  conflict_resolution: {
    resolution_strategy: "OPTIMISTIC_CONCURRENCY", # accepts OPTIMISTIC_CONCURRENCY, LAMBDA, AUTOMERGE, NONE
  },
  default_auth_type: {
    mode: "API_KEY", # accepts API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT
    settings: {
      cognito_user_pool_id: "__string",
      description: "__string",
      expiration_time: 1.0,
      open_id_auth_ttl: "__string",
      open_id_client_id: "__string",
      open_id_iat_ttl: "__string",
      open_id_issue_url: "__string",
      open_id_provider_name: "__string",
    },
  },
  service: "__string",
  transform_schema: "__string",
}

The resource config for the data model, configured as a part of the Amplify project.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#additional_auth_types ⇒ Array<Types::BackendAPIAuthType>

Additional authentication methods used to interact with your data models.

Returns:



288
289
290
291
292
293
294
295
296
297
 
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 288

class BackendAPIResourceConfig < Struct.new(
  :additional_auth_types,
  :api_name,
  :conflict_resolution,
  :default_auth_type,
  :service,
  :transform_schema)
  SENSITIVE = []
  include Aws::Structure
end

#api_name ⇒ String

The API name used to interact with the data model, configured as a part of your Amplify project.

Returns:

  • (String) 


288
289
290
291
292
293
294
295
296
297
 
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 288

class BackendAPIResourceConfig < Struct.new(
  :additional_auth_types,
  :api_name,
  :conflict_resolution,
  :default_auth_type,
  :service,
  :transform_schema)
  SENSITIVE = []
  include Aws::Structure
end

#conflict_resolution ⇒ Types::BackendAPIConflictResolution

The conflict resolution strategy for your data stored in the data models.

Returns:



288
289
290
291
292
293
294
295
296
297
 
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 288

class BackendAPIResourceConfig < Struct.new(
  :additional_auth_types,
  :api_name,
  :conflict_resolution,
  :default_auth_type,
  :service,
  :transform_schema)
  SENSITIVE = []
  include Aws::Structure
end

#default_auth_type ⇒ Types::BackendAPIAuthType

The default authentication type for interacting with the configured data models in your Amplify project.

Returns:



288
289
290
291
292
293
294
295
296
297
 
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 288

class BackendAPIResourceConfig < Struct.new(
  :additional_auth_types,
  :api_name,
  :conflict_resolution,
  :default_auth_type,
  :service,
  :transform_schema)
  SENSITIVE = []
  include Aws::Structure
end

#service ⇒ String

The service used to provision and interact with the data model.

Returns:

  • (String) 


288
289
290
291
292
293
294
295
296
297
 
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 288

class BackendAPIResourceConfig < Struct.new(
  :additional_auth_types,
  :api_name,
  :conflict_resolution,
  :default_auth_type,
  :service,
  :transform_schema)
  SENSITIVE = []
  include Aws::Structure
end

#transform_schema ⇒ String

The definition of the data model in the annotated transform of the GraphQL schema.

Returns:

  • (String) 


288
289
290
291
292
293
294
295
296
297
 
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 288

class BackendAPIResourceConfig < Struct.new(
  :additional_auth_types,
  :api_name,
  :conflict_resolution,
  :default_auth_type,
  :service,
  :transform_schema)
  SENSITIVE = []
  include Aws::Structure
end