Class: Aws::Route53Profiles::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::Route53Profiles::Client
- Includes:
- ClientStubs
- Defined in:
- lib/aws-sdk-route53profiles/client.rb
Overview
An API client for Route53Profiles. To construct a client, you need to configure a ‘:region` and `:credentials`.
client = Aws::Route53Profiles::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
See #initialize for a full list of supported configuration options.
Class Attribute Summary collapse
- .identifier ⇒ Object readonly private
API Operations collapse
-
#associate_profile(params = {}) ⇒ Types::AssociateProfileResponse
Associates a Route 53 Profiles profile with a VPC.
-
#associate_resource_to_profile(params = {}) ⇒ Types::AssociateResourceToProfileResponse
Associates a DNS reource configuration to a Route 53 Profile.
-
#create_profile(params = {}) ⇒ Types::CreateProfileResponse
Creates an empty Route 53 Profile.
-
#delete_profile(params = {}) ⇒ Types::DeleteProfileResponse
Deletes the specified Route 53 Profile.
-
#disassociate_profile(params = {}) ⇒ Types::DisassociateProfileResponse
Dissociates a specified Route 53 Profile from the specified VPC.
-
#disassociate_resource_from_profile(params = {}) ⇒ Types::DisassociateResourceFromProfileResponse
Dissoaciated a specified resource, from the Route 53 Profile.
-
#get_profile(params = {}) ⇒ Types::GetProfileResponse
Returns information about a specified Route 53 Profile, such as whether whether the Profile is shared, and the current status of the Profile.
-
#get_profile_association(params = {}) ⇒ Types::GetProfileAssociationResponse
Retrieves a Route 53 Profile association for a VPC.
-
#get_profile_resource_association(params = {}) ⇒ Types::GetProfileResourceAssociationResponse
Returns information about a specified Route 53 Profile resource association.
-
#list_profile_associations(params = {}) ⇒ Types::ListProfileAssociationsResponse
Lists all the VPCs that the specified Route 53 Profile is associated with.
-
#list_profile_resource_associations(params = {}) ⇒ Types::ListProfileResourceAssociationsResponse
Lists all the resource associations for the specified Route 53 Profile.
-
#list_profiles(params = {}) ⇒ Types::ListProfilesResponse
Lists all the Route 53 Profiles associated with your Amazon Web Services account.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags that you associated with the specified resource.
-
#tag_resource(params = {}) ⇒ Struct
Adds one or more tags to a specified resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes one or more tags from a specified resource.
-
#update_profile_resource_association(params = {}) ⇒ Types::UpdateProfileResourceAssociationResponse
Updates the specified Route 53 Profile resourse association.
Class Method Summary collapse
- .errors_module ⇒ Object private
Instance Method Summary collapse
- #build_request(operation_name, params = {}) ⇒ Object private
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
- #waiter_names ⇒ Object deprecated private Deprecated.
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
444 445 446 |
# File 'lib/aws-sdk-route53profiles/client.rb', line 444 def initialize(*args) super end |
Class Attribute Details
.identifier ⇒ Object (readonly)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1215 1216 1217 |
# File 'lib/aws-sdk-route53profiles/client.rb', line 1215 def identifier @identifier end |
Class Method Details
.errors_module ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1218 1219 1220 |
# File 'lib/aws-sdk-route53profiles/client.rb', line 1218 def errors_module Errors end |
Instance Method Details
#associate_profile(params = {}) ⇒ Types::AssociateProfileResponse
Associates a Route 53 Profiles profile with a VPC. A VPC can have only one Profile associated with it, but a Profile can be associated with 1000 of VPCs (and you can request a higher quota). For more information, see [docs.aws.amazon.com/Route53/latest/DeveloperGuide/DNSLimitations.html#limits-api-entities][1].
[1]: docs.aws.amazon.com/Route53/latest/DeveloperGuide/DNSLimitations.html#limits-api-entities
507 508 509 510 |
# File 'lib/aws-sdk-route53profiles/client.rb', line 507 def associate_profile(params = {}, = {}) req = build_request(:associate_profile, params) req.send_request() end |
#associate_resource_to_profile(params = {}) ⇒ Types::AssociateResourceToProfileResponse
Associates a DNS reource configuration to a Route 53 Profile.
561 562 563 564 |
# File 'lib/aws-sdk-route53profiles/client.rb', line 561 def associate_resource_to_profile(params = {}, = {}) req = build_request(:associate_resource_to_profile, params) req.send_request() end |
#build_request(operation_name, params = {}) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 |
# File 'lib/aws-sdk-route53profiles/client.rb', line 1188 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) tracer = config.telemetry_provider.tracer_provider.tracer( Aws::Telemetry.module_to_tracer_name('Aws::Route53Profiles') ) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config, tracer: tracer ) context[:gem_name] = 'aws-sdk-route53profiles' context[:gem_version] = '1.14.0' Seahorse::Client::Request.new(handlers, context) end |
#create_profile(params = {}) ⇒ Types::CreateProfileResponse
Creates an empty Route 53 Profile.
619 620 621 622 |
# File 'lib/aws-sdk-route53profiles/client.rb', line 619 def create_profile(params = {}, = {}) req = build_request(:create_profile, params) req.send_request() end |
#delete_profile(params = {}) ⇒ Types::DeleteProfileResponse
Deletes the specified Route 53 Profile. Before you can delete a profile, you must first disassociate it from all VPCs.
657 658 659 660 |
# File 'lib/aws-sdk-route53profiles/client.rb', line 657 def delete_profile(params = {}, = {}) req = build_request(:delete_profile, params) req.send_request() end |
#disassociate_profile(params = {}) ⇒ Types::DisassociateProfileResponse
Dissociates a specified Route 53 Profile from the specified VPC.
697 698 699 700 |
# File 'lib/aws-sdk-route53profiles/client.rb', line 697 def disassociate_profile(params = {}, = {}) req = build_request(:disassociate_profile, params) req.send_request() end |
#disassociate_resource_from_profile(params = {}) ⇒ Types::DisassociateResourceFromProfileResponse
Dissoaciated a specified resource, from the Route 53 Profile.
739 740 741 742 |
# File 'lib/aws-sdk-route53profiles/client.rb', line 739 def disassociate_resource_from_profile(params = {}, = {}) req = build_request(:disassociate_resource_from_profile, params) req.send_request() end |
#get_profile(params = {}) ⇒ Types::GetProfileResponse
Returns information about a specified Route 53 Profile, such as whether whether the Profile is shared, and the current status of the Profile.
778 779 780 781 |
# File 'lib/aws-sdk-route53profiles/client.rb', line 778 def get_profile(params = {}, = {}) req = build_request(:get_profile, params) req.send_request() end |
#get_profile_association(params = {}) ⇒ Types::GetProfileAssociationResponse
Retrieves a Route 53 Profile association for a VPC. A VPC can have only one Profile association, but a Profile can be associated with up to 5000 VPCs.
816 817 818 819 |
# File 'lib/aws-sdk-route53profiles/client.rb', line 816 def get_profile_association(params = {}, = {}) req = build_request(:get_profile_association, params) req.send_request() end |
#get_profile_resource_association(params = {}) ⇒ Types::GetProfileResourceAssociationResponse
Returns information about a specified Route 53 Profile resource association.
856 857 858 859 |
# File 'lib/aws-sdk-route53profiles/client.rb', line 856 def get_profile_resource_association(params = {}, = {}) req = build_request(:get_profile_resource_association, params) req.send_request() end |
#list_profile_associations(params = {}) ⇒ Types::ListProfileAssociationsResponse
Lists all the VPCs that the specified Route 53 Profile is associated with.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
922 923 924 925 |
# File 'lib/aws-sdk-route53profiles/client.rb', line 922 def list_profile_associations(params = {}, = {}) req = build_request(:list_profile_associations, params) req.send_request() end |
#list_profile_resource_associations(params = {}) ⇒ Types::ListProfileResourceAssociationsResponse
Lists all the resource associations for the specified Route 53 Profile.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
990 991 992 993 |
# File 'lib/aws-sdk-route53profiles/client.rb', line 990 def list_profile_resource_associations(params = {}, = {}) req = build_request(:list_profile_resource_associations, params) req.send_request() end |
#list_profiles(params = {}) ⇒ Types::ListProfilesResponse
Lists all the Route 53 Profiles associated with your Amazon Web Services account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1043 1044 1045 1046 |
# File 'lib/aws-sdk-route53profiles/client.rb', line 1043 def list_profiles(params = {}, = {}) req = build_request(:list_profiles, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags that you associated with the specified resource.
1073 1074 1075 1076 |
# File 'lib/aws-sdk-route53profiles/client.rb', line 1073 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds one or more tags to a specified resource.
1102 1103 1104 1105 |
# File 'lib/aws-sdk-route53profiles/client.rb', line 1102 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes one or more tags from a specified resource.
1129 1130 1131 1132 |
# File 'lib/aws-sdk-route53profiles/client.rb', line 1129 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_profile_resource_association(params = {}) ⇒ Types::UpdateProfileResourceAssociationResponse
Updates the specified Route 53 Profile resourse association.
1179 1180 1181 1182 |
# File 'lib/aws-sdk-route53profiles/client.rb', line 1179 def update_profile_resource_association(params = {}, = {}) req = build_request(:update_profile_resource_association, params) req.send_request() end |
#waiter_names ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1208 1209 1210 |
# File 'lib/aws-sdk-route53profiles/client.rb', line 1208 def waiter_names [] end |