Class: Aws::AmplifyBackend::Types::GetBackendAPIRequest

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

{
  app_id: "__string", # required
  backend_environment_name: "__string", # required
  resource_config: {
    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",
  },
  resource_name: "__string", # required
}

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#app_id ⇒ String

Returns:

  • (String) 

2508
2509
2510
2511
2512
2513
2514
2515
 
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 2508

class GetBackendAPIRequest < Struct.new(
  :app_id,
  :backend_environment_name,
  :resource_config,
  :resource_name)
  SENSITIVE = []
  include Aws::Structure
end

#backend_environment_name ⇒ String

Returns:

  • (String) 

2508
2509
2510
2511
2512
2513
2514
2515
 
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 2508

class GetBackendAPIRequest < Struct.new(
  :app_id,
  :backend_environment_name,
  :resource_config,
  :resource_name)
  SENSITIVE = []
  include Aws::Structure
end

#resource_config ⇒ Types::BackendAPIResourceConfig

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

Returns:


2508
2509
2510
2511
2512
2513
2514
2515
 
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 2508

class GetBackendAPIRequest < Struct.new(
  :app_id,
  :backend_environment_name,
  :resource_config,
  :resource_name)
  SENSITIVE = []
  include Aws::Structure
end

#resource_name ⇒ String

Returns:

  • (String) 

2508
2509
2510
2511
2512
2513
2514
2515
 
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 2508

class GetBackendAPIRequest < Struct.new(
  :app_id,
  :backend_environment_name,
  :resource_config,
  :resource_name)
  SENSITIVE = []
  include Aws::Structure
end