Route53Profiles
This page documents function available when using the Route53Profiles module, created with @service Route53Profiles.
Index
Main.Route53Profiles.associate_profileMain.Route53Profiles.associate_resource_to_profileMain.Route53Profiles.create_profileMain.Route53Profiles.delete_profileMain.Route53Profiles.disassociate_profileMain.Route53Profiles.disassociate_resource_from_profileMain.Route53Profiles.get_profileMain.Route53Profiles.get_profile_associationMain.Route53Profiles.get_profile_resource_associationMain.Route53Profiles.list_profile_associationsMain.Route53Profiles.list_profile_resource_associationsMain.Route53Profiles.list_profilesMain.Route53Profiles.list_tags_for_resourceMain.Route53Profiles.tag_resourceMain.Route53Profiles.untag_resourceMain.Route53Profiles.update_profile_resource_association
Documentation
Main.Route53Profiles.associate_profile — Methodassociate_profile(name, profile_id, resource_id)
associate_profile(name, profile_id, resource_id, params::Dict{String,<:Any})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 https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DNSLimitations.html#limits-api-ent ities.
Arguments
name: A name for the association.profile_id: ID of the Profile.resource_id: The ID of the VPC.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"Tags": A list of the tag keys and values that you want to identify the Profile association.
Main.Route53Profiles.associate_resource_to_profile — Methodassociate_resource_to_profile(name, profile_id, resource_arn)
associate_resource_to_profile(name, profile_id, resource_arn, params::Dict{String,<:Any})Associates a DNS reource configuration to a Route 53 Profile.
Arguments
name: Name for the resource association.profile_id: ID of the Profile.resource_arn: Amazon resource number, ARN, of the DNS resource.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"ResourceProperties": If you are adding a DNS Firewall rule group, include also a priority. The priority indicates the processing order for the rule groups, starting with the priority assinged the lowest value. The allowed values for priority are between 100 and 9900.
Main.Route53Profiles.create_profile — Methodcreate_profile(client_token, name)
create_profile(client_token, name, params::Dict{String,<:Any})Creates an empty Route 53 Profile.
Arguments
client_token: ClientToken is an idempotency token that ensures a call to CreateProfile completes only once. You choose the value to pass. For example, an issue might prevent you from getting a response from CreateProfile. In this case, safely retry your call to CreateProfile by using the same CreateProfile parameter value.name: A name for the Profile.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"Tags": A list of the tag keys and values that you want to associate with the Route 53 Profile.
Main.Route53Profiles.delete_profile — Methoddelete_profile(profile_id)
delete_profile(profile_id, params::Dict{String,<:Any})Deletes the specified Route 53 Profile. Before you can delete a profile, you must first disassociate it from all VPCs.
Arguments
profile_id: The ID of the Profile that you want to delete.
Main.Route53Profiles.disassociate_profile — Methoddisassociate_profile(profile_id, resource_id)
disassociate_profile(profile_id, resource_id, params::Dict{String,<:Any})Dissociates a specified Route 53 Profile from the specified VPC.
Arguments
profile_id: ID of the Profile.resource_id: The ID of the VPC.
Main.Route53Profiles.disassociate_resource_from_profile — Methoddisassociate_resource_from_profile(profile_id, resource_arn)
disassociate_resource_from_profile(profile_id, resource_arn, params::Dict{String,<:Any})Dissoaciated a specified resource, from the Route 53 Profile.
Arguments
profile_id: The ID of the Profile.resource_arn: The Amazon Resource Name (ARN) of the resource.
Main.Route53Profiles.get_profile — Methodget_profile(profile_id)
get_profile(profile_id, params::Dict{String,<:Any})Returns information about a specified Route 53 Profile, such as whether whether the Profile is shared, and the current status of the Profile.
Arguments
profile_id: ID of the Profile.
Main.Route53Profiles.get_profile_association — Methodget_profile_association(profile_association_id)
get_profile_association(profile_association_id, params::Dict{String,<:Any})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.
Arguments
profile_association_id: The identifier of the association you want to get information about.
Main.Route53Profiles.get_profile_resource_association — Methodget_profile_resource_association(profile_resource_association_id)
get_profile_resource_association(profile_resource_association_id, params::Dict{String,<:Any})Returns information about a specified Route 53 Profile resource association.
Arguments
profile_resource_association_id: The ID of the profile resource association that you want to get information about.
Main.Route53Profiles.list_profile_associations — Methodlist_profile_associations()
list_profile_associations(params::Dict{String,<:Any})Lists all the VPCs that the specified Route 53 Profile is associated with.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"maxResults": The maximum number of objects that you want to return for this request. If more objects are available, in the response, a NextToken value, which you can use in a subsequent call to get the next batch of objects, is provided. If you don't specify a value for MaxResults, up to 100 objects are returned."nextToken": For the first call to this list request, omit this value. When you request a list of objects, at most the number of objects specified by MaxResults is returned. If more objects are available for retrieval, a NextToken value is returned in the response. To retrieve the next batch of objects, use the token that was returned for the prior request in your next request."profileId": ID of the Profile."resourceId": ID of the VPC.
Main.Route53Profiles.list_profile_resource_associations — Methodlist_profile_resource_associations(profile_id)
list_profile_resource_associations(profile_id, params::Dict{String,<:Any})Lists all the resource associations for the specified Route 53 Profile.
Arguments
profile_id: The ID of the Profile.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"maxResults": The maximum number of objects that you want to return for this request. If more objects are available, in the response, a NextToken value, which you can use in a subsequent call to get the next batch of objects, is provided. If you don't specify a value for MaxResults, up to 100 objects are returned."nextToken": For the first call to this list request, omit this value. When you request a list of objects, at most the number of objects specified by MaxResults is returned. If more objects are available for retrieval, a NextToken value is returned in the response. To retrieve the next batch of objects, use the token that was returned for the prior request in your next request."resourceType": ID of a resource if you want information on only one type.
Main.Route53Profiles.list_profiles — Methodlist_profiles()
list_profiles(params::Dict{String,<:Any})Lists all the Route 53 Profiles associated with your Amazon Web Services account.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"maxResults": The maximum number of objects that you want to return for this request. If more objects are available, in the response, a NextToken value, which you can use in a subsequent call to get the next batch of objects, is provided. If you don't specify a value for MaxResults, up to 100 objects are returned."nextToken": For the first call to this list request, omit this value. When you request a list of objects, at most the number of objects specified by MaxResults is returned. If more objects are available for retrieval, a NextToken value is returned in the response. To retrieve the next batch of objects, use the token that was returned for the prior request in your next request.
Main.Route53Profiles.list_tags_for_resource — Methodlist_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})Lists the tags that you associated with the specified resource.
Arguments
resource_arn: The Amazon Resource Name (ARN) for the resource that you want to list the tags for.
Main.Route53Profiles.tag_resource — Methodtag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})Adds one or more tags to a specified resource.
Arguments
resource_arn: The Amazon Resource Name (ARN) for the resource that you want to add tags to.tags: The tags that you want to add to the specified resource.
Main.Route53Profiles.untag_resource — Methoduntag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})Removes one or more tags from a specified resource.
Arguments
resource_arn: The Amazon Resource Name (ARN) for the resource that you want to remove tags from.tag_keys: The tags that you want to remove to the specified resource.
Main.Route53Profiles.update_profile_resource_association — Methodupdate_profile_resource_association(profile_resource_association_id)
update_profile_resource_association(profile_resource_association_id, params::Dict{String,<:Any})Updates the specified Route 53 Profile resourse association.
Arguments
profile_resource_association_id: ID of the resource association.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"Name": Name of the resource association."ResourceProperties": If you are adding a DNS Firewall rule group, include also a priority. The priority indicates the processing order for the rule groups, starting with the priority assinged the lowest value. The allowed values for priority are between 100 and 9900.