Class: Jets::Resource::ApiGateway::RestApi::LogicalId::Message

Inherits:
Object
  • Object
show all
Defined in:
lib/jets/resource/api_gateway/rest_api/logical_id/message.rb

Instance Method Summary collapse

Instance Method Details

#auto_replace_disabledObject



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
# File 'lib/jets/resource/api_gateway/rest_api/logical_id/message.rb', line 32

def auto_replace_disabled
  <<~EOL
  It looks like `config.api.auto_replace = false`. IE:

  config/application.rb

      config.api.auto_replace = false

  The deploy will not continue. See:

  * https://rubyonjets.com/docs/app-config/reference/
  * https://rubyonjets.com/docs/routing/custom-domain/

  EOL
end

#custom_domainObject



10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
# File 'lib/jets/resource/api_gateway/rest_api/logical_id/message.rb', line 10

def custom_domain
  api = Jets::Resource::ApiGateway::DomainName.new
  domain_name = api.domain_name
  if domain_name
    <<~EOL
    It looks like you have already set up a custom domain.
    The domain name: #{domain_name}

    So you should be good to go as the custom domain will be updated with the new API Gateway endpoint.
    To avoid this prompt in the future, you can configure:

    config/application.rb

        config.api.auto_replace = true

    More info: custom domain docs: https://rubyonjets.com/docs/routing/custom-domain/
    EOL
  else
    "Please set up a custom domain https://rubyonjets.com/docs/routing/custom-domain/"
  end
end

#routes_changedObject



3
4
5
6
7
8
# File 'lib/jets/resource/api_gateway/rest_api/logical_id/message.rb', line 3

def routes_changed
  <<~EOL
  Routes Change Detection: Jets has detected that a new brand API Gateway is required to be deployed.
  IMPORTANT: This will result in the API Gateway endpoint changing.
  EOL
end