Title: | 'Amazon Web Services' Networking & Content Delivery Services |
Version: | 0.9.0 |
Description: | Interface to 'Amazon Web Services' networking and content delivery services, including 'Route 53' Domain Name System service, 'CloudFront' content delivery, load balancing, and more https://aws.amazon.com/. |
License: | Apache License (≥ 2.0) |
URL: | https://github.com/paws-r/paws, https://paws-r.r-universe.dev/paws.networking |
BugReports: | https://github.com/paws-r/paws/issues |
Imports: | paws.common (≥ 0.8.0) |
Suggests: | testthat |
Encoding: | UTF-8 |
RoxygenNote: | 7.3.2 |
Collate: | 'apigateway_service.R' 'apigateway_interfaces.R' 'apigateway_operations.R' 'apigatewaymanagementapi_service.R' 'apigatewaymanagementapi_interfaces.R' 'apigatewaymanagementapi_operations.R' 'apigatewayv2_service.R' 'apigatewayv2_interfaces.R' 'apigatewayv2_operations.R' 'appfabric_service.R' 'appfabric_interfaces.R' 'appfabric_operations.R' 'appmesh_service.R' 'appmesh_interfaces.R' 'appmesh_operations.R' 'arczonalshift_service.R' 'arczonalshift_interfaces.R' 'arczonalshift_operations.R' 'backupgateway_service.R' 'backupgateway_interfaces.R' 'backupgateway_operations.R' 'cloudfront_service.R' 'cloudfront_interfaces.R' 'cloudfront_operations.R' 'cloudfrontkeyvaluestore_service.R' 'cloudfrontkeyvaluestore_interfaces.R' 'cloudfrontkeyvaluestore_operations.R' 'directconnect_service.R' 'directconnect_interfaces.R' 'directconnect_operations.R' 'elb_service.R' 'elb_interfaces.R' 'elb_operations.R' 'elbv2_service.R' 'elbv2_interfaces.R' 'elbv2_operations.R' 'globalaccelerator_service.R' 'globalaccelerator_interfaces.R' 'globalaccelerator_operations.R' 'networkfirewall_service.R' 'networkfirewall_interfaces.R' 'networkfirewall_operations.R' 'networkmanager_service.R' 'networkmanager_interfaces.R' 'networkmanager_operations.R' 'reexports_paws.common.R' 'route53_service.R' 'route53_interfaces.R' 'route53_operations.R' 'route53domains_service.R' 'route53domains_interfaces.R' 'route53domains_operations.R' 'route53profiles_service.R' 'route53profiles_interfaces.R' 'route53profiles_operations.R' 'route53recoverycluster_service.R' 'route53recoverycluster_interfaces.R' 'route53recoverycluster_operations.R' 'route53recoverycontrolconfig_service.R' 'route53recoverycontrolconfig_interfaces.R' 'route53recoverycontrolconfig_operations.R' 'route53recoveryreadiness_service.R' 'route53recoveryreadiness_interfaces.R' 'route53recoveryreadiness_operations.R' 'route53resolver_service.R' 'route53resolver_interfaces.R' 'route53resolver_operations.R' 'servicediscovery_service.R' 'servicediscovery_interfaces.R' 'servicediscovery_operations.R' 'telconetworkbuilder_service.R' 'telconetworkbuilder_interfaces.R' 'telconetworkbuilder_operations.R' 'vpclattice_service.R' 'vpclattice_interfaces.R' 'vpclattice_operations.R' |
NeedsCompilation: | no |
Packaged: | 2025-03-14 09:23:24 UTC; dyfanjones |
Author: | David Kretch [aut], Adam Banker [aut], Dyfan Jones [cre], Amazon.com, Inc. [cph] |
Maintainer: | Dyfan Jones <dyfan.r.jones@gmail.com> |
Repository: | CRAN |
Date/Publication: | 2025-03-14 16:30:02 UTC |
Amazon API Gateway
Description
Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.
Usage
apigateway(
config = list(),
credentials = list(),
endpoint = NULL,
region = NULL
)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...)
, where svc
is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- apigateway( config = list( credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string", close_connection = "logical", timeout = "numeric", s3_force_path_style = "logical", sts_regional_endpoint = "string" ), credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string" )
Operations
create_api_key | Create an ApiKey resource |
create_authorizer | Adds a new Authorizer resource to an existing RestApi resource |
create_base_path_mapping | Creates a new BasePathMapping resource |
create_deployment | Creates a Deployment resource, which makes a specified RestApi callable over the internet |
create_documentation_part | Creates a documentation part |
create_documentation_version | Creates a documentation version |
create_domain_name | Creates a new domain name |
create_domain_name_access_association | Creates a domain name access association resource between an access association source and a private custom domain name |
create_model | Adds a new Model resource to an existing RestApi resource |
create_request_validator | Creates a RequestValidator of a given RestApi |
create_resource | Creates a Resource resource |
create_rest_api | Creates a new RestApi resource |
create_stage | Creates a new Stage resource that references a pre-existing Deployment for the API |
create_usage_plan | Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload |
create_usage_plan_key | Creates a usage plan key for adding an existing API key to a usage plan |
create_vpc_link | Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that typically takes 2-4 minutes to complete and become operational |
delete_api_key | Deletes the ApiKey resource |
delete_authorizer | Deletes an existing Authorizer resource |
delete_base_path_mapping | Deletes the BasePathMapping resource |
delete_client_certificate | Deletes the ClientCertificate resource |
delete_deployment | Deletes a Deployment resource |
delete_documentation_part | Deletes a documentation part |
delete_documentation_version | Deletes a documentation version |
delete_domain_name | Deletes the DomainName resource |
delete_domain_name_access_association | Deletes the DomainNameAccessAssociation resource |
delete_gateway_response | Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings |
delete_integration | Represents a delete integration |
delete_integration_response | Represents a delete integration response |
delete_method | Deletes an existing Method resource |
delete_method_response | Deletes an existing MethodResponse resource |
delete_model | Deletes a model |
delete_request_validator | Deletes a RequestValidator of a given RestApi |
delete_resource | Deletes a Resource resource |
delete_rest_api | Deletes the specified API |
delete_stage | Deletes a Stage resource |
delete_usage_plan | Deletes a usage plan of a given plan Id |
delete_usage_plan_key | Deletes a usage plan key and remove the underlying API key from the associated usage plan |
delete_vpc_link | Deletes an existing VpcLink of a specified identifier |
flush_stage_authorizers_cache | Flushes all authorizer cache entries on a stage |
flush_stage_cache | Flushes a stage's cache |
generate_client_certificate | Generates a ClientCertificate resource |
get_account | Gets information about the current Account resource |
get_api_key | Gets information about the current ApiKey resource |
get_api_keys | Gets information about the current ApiKeys resource |
get_authorizer | Describe an existing Authorizer resource |
get_authorizers | Describe an existing Authorizers resource |
get_base_path_mapping | Describe a BasePathMapping resource |
get_base_path_mappings | Represents a collection of BasePathMapping resources |
get_client_certificate | Gets information about the current ClientCertificate resource |
get_client_certificates | Gets a collection of ClientCertificate resources |
get_deployment | Gets information about a Deployment resource |
get_deployments | Gets information about a Deployments collection |
get_documentation_part | Gets a documentation part |
get_documentation_parts | Gets documentation parts |
get_documentation_version | Gets a documentation version |
get_documentation_versions | Gets documentation versions |
get_domain_name | Represents a domain name that is contained in a simpler, more intuitive URL that can be called |
get_domain_name_access_associations | Represents a collection on DomainNameAccessAssociations resources |
get_domain_names | Represents a collection of DomainName resources |
get_export | Exports a deployed version of a RestApi in a specified format |
get_gateway_response | Gets a GatewayResponse of a specified response type on the given RestApi |
get_gateway_responses | Gets the GatewayResponses collection on the given RestApi |
get_integration | Get the integration settings |
get_integration_response | Represents a get integration response |
get_method | Describe an existing Method resource |
get_method_response | Describes a MethodResponse resource |
get_model | Describes an existing model defined for a RestApi resource |
get_models | Describes existing Models defined for a RestApi resource |
get_model_template | Generates a sample mapping template that can be used to transform a payload into the structure of a model |
get_request_validator | Gets a RequestValidator of a given RestApi |
get_request_validators | Gets the RequestValidators collection of a given RestApi |
get_resource | Lists information about a resource |
get_resources | Lists information about a collection of Resource resources |
get_rest_api | Lists the RestApi resource in the collection |
get_rest_apis | Lists the RestApis resources for your collection |
get_sdk | Generates a client SDK for a RestApi and Stage |
get_sdk_type | Gets an SDK type |
get_sdk_types | Gets SDK types |
get_stage | Gets information about a Stage resource |
get_stages | Gets information about one or more Stage resources |
get_tags | Gets the Tags collection for a given resource |
get_usage | Gets the usage data of a usage plan in a specified time interval |
get_usage_plan | Gets a usage plan of a given plan identifier |
get_usage_plan_key | Gets a usage plan key of a given key identifier |
get_usage_plan_keys | Gets all the usage plan keys representing the API keys added to a specified usage plan |
get_usage_plans | Gets all the usage plans of the caller's account |
get_vpc_link | Gets a specified VPC link under the caller's account in a region |
get_vpc_links | Gets the VpcLinks collection under the caller's account in a selected region |
import_api_keys | Import API keys from an external source, such as a CSV-formatted file |
import_documentation_parts | Imports documentation parts |
import_rest_api | A feature of the API Gateway control service for creating a new API from an external API definition file |
put_gateway_response | Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi |
put_integration | Sets up a method's integration |
put_integration_response | Represents a put integration |
put_method | Add a method to an existing Resource resource |
put_method_response | Adds a MethodResponse to an existing Method resource |
put_rest_api | A feature of the API Gateway control service for updating an existing API with an input of external API definitions |
reject_domain_name_access_association | Rejects a domain name access association with a private custom domain name |
tag_resource | Adds or updates a tag on a given resource |
test_invoke_authorizer | Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body |
test_invoke_method | Simulate the invocation of a Method in your RestApi with headers, parameters, and an incoming request body |
untag_resource | Removes a tag from a given resource |
update_account | Changes information about the current Account resource |
update_api_key | Changes information about an ApiKey resource |
update_authorizer | Updates an existing Authorizer resource |
update_base_path_mapping | Changes information about the BasePathMapping resource |
update_client_certificate | Changes information about an ClientCertificate resource |
update_deployment | Changes information about a Deployment resource |
update_documentation_part | Updates a documentation part |
update_documentation_version | Updates a documentation version |
update_domain_name | Changes information about the DomainName resource |
update_gateway_response | Updates a GatewayResponse of a specified response type on the given RestApi |
update_integration | Represents an update integration |
update_integration_response | Represents an update integration response |
update_method | Updates an existing Method resource |
update_method_response | Updates an existing MethodResponse resource |
update_model | Changes information about a model |
update_request_validator | Updates a RequestValidator of a given RestApi |
update_resource | Changes information about a Resource resource |
update_rest_api | Changes information about the specified API |
update_stage | Changes information about a Stage resource |
update_usage | Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key |
update_usage_plan | Updates a usage plan of a given plan Id |
update_vpc_link | Updates an existing VpcLink of a specified identifier |
Examples
## Not run:
svc <- apigateway()
svc$create_api_key(
Foo = 123
)
## End(Not run)
Create an ApiKey resource
Description
Create an ApiKey resource.
See https://www.paws-r-sdk.com/docs/apigateway_create_api_key/ for full documentation.
Usage
apigateway_create_api_key(
name = NULL,
description = NULL,
enabled = NULL,
generateDistinctId = NULL,
value = NULL,
stageKeys = NULL,
customerId = NULL,
tags = NULL
)
Arguments
name |
The name of the ApiKey. |
description |
The description of the ApiKey. |
enabled |
Specifies whether the ApiKey can be used by callers. |
generateDistinctId |
Specifies whether ( |
value |
Specifies a value of the API key. |
stageKeys |
DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key. |
customerId |
An Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace. |
tags |
The key-value map of strings. The valid character set is
[a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not
start with |
Adds a new Authorizer resource to an existing RestApi resource
Description
Adds a new Authorizer resource to an existing RestApi resource.
See https://www.paws-r-sdk.com/docs/apigateway_create_authorizer/ for full documentation.
Usage
apigateway_create_authorizer(
restApiId,
name,
type,
providerARNs = NULL,
authType = NULL,
authorizerUri = NULL,
authorizerCredentials = NULL,
identitySource = NULL,
identityValidationExpression = NULL,
authorizerResultTtlInSeconds = NULL
)
Arguments
restApiId |
[required] The string identifier of the associated RestApi. |
name |
[required] The name of the authorizer. |
type |
[required] The authorizer type. Valid values are |
providerARNs |
A list of the Amazon Cognito user pool ARNs for the |
authType |
Optional customer-defined field, used in OpenAPI imports and exports without functional impact. |
authorizerUri |
Specifies the authorizer's Uniform Resource Identifier (URI). For
|
authorizerCredentials |
Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null. |
identitySource |
The identity source for which authorization is requested. For a |
identityValidationExpression |
A validation expression for the incoming identity token. For |
authorizerResultTtlInSeconds |
The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour. |
Creates a new BasePathMapping resource
Description
Creates a new BasePathMapping resource.
See https://www.paws-r-sdk.com/docs/apigateway_create_base_path_mapping/ for full documentation.
Usage
apigateway_create_base_path_mapping(
domainName,
domainNameId = NULL,
basePath = NULL,
restApiId,
stage = NULL
)
Arguments
domainName |
[required] The domain name of the BasePathMapping resource to create. |
domainNameId |
The identifier for the domain name resource. Required for private custom domain names. |
basePath |
The base path name that callers of the API must provide as part of the URL after the domain name. This value must be unique for all of the mappings across a single API. Specify '(none)' if you do not want callers to specify a base path name after the domain name. |
restApiId |
[required] The string identifier of the associated RestApi. |
stage |
The name of the API's stage that you want to use for this mapping. Specify '(none)' if you want callers to explicitly specify the stage name after any base path name. |
Creates a Deployment resource, which makes a specified RestApi callable over the internet
Description
Creates a Deployment resource, which makes a specified RestApi callable over the internet.
See https://www.paws-r-sdk.com/docs/apigateway_create_deployment/ for full documentation.
Usage
apigateway_create_deployment(
restApiId,
stageName = NULL,
stageDescription = NULL,
description = NULL,
cacheClusterEnabled = NULL,
cacheClusterSize = NULL,
variables = NULL,
canarySettings = NULL,
tracingEnabled = NULL
)
Arguments
restApiId |
[required] The string identifier of the associated RestApi. |
stageName |
The name of the Stage resource for the Deployment resource to create. |
stageDescription |
The description of the Stage resource for the Deployment resource to create. |
description |
The description for the Deployment resource to create. |
cacheClusterEnabled |
Enables a cache cluster for the Stage resource specified in the input. |
cacheClusterSize |
The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness. |
variables |
A map that defines the stage variables for the Stage resource that is
associated with the new deployment. Variable names can have alphanumeric
and underscore characters, and the values must match
|
canarySettings |
The input configuration for the canary deployment when the deployment is a canary release deployment. |
tracingEnabled |
Specifies whether active tracing with X-ray is enabled for the Stage. |
Creates a documentation part
Description
Creates a documentation part.
See https://www.paws-r-sdk.com/docs/apigateway_create_documentation_part/ for full documentation.
Usage
apigateway_create_documentation_part(restApiId, location, properties)
Arguments
restApiId |
[required] The string identifier of the associated RestApi. |
location |
[required] The location of the targeted API entity of the to-be-created documentation part. |
properties |
[required] The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published. |
Creates a documentation version
Description
Creates a documentation version
See https://www.paws-r-sdk.com/docs/apigateway_create_documentation_version/ for full documentation.
Usage
apigateway_create_documentation_version(
restApiId,
documentationVersion,
stageName = NULL,
description = NULL
)
Arguments
restApiId |
[required] The string identifier of the associated RestApi. |
documentationVersion |
[required] The version identifier of the new snapshot. |
stageName |
The stage name to be associated with the new documentation snapshot. |
description |
A description about the new documentation snapshot. |
Creates a new domain name
Description
Creates a new domain name.
See https://www.paws-r-sdk.com/docs/apigateway_create_domain_name/ for full documentation.
Usage
apigateway_create_domain_name(
domainName,
certificateName = NULL,
certificateBody = NULL,
certificatePrivateKey = NULL,
certificateChain = NULL,
certificateArn = NULL,
regionalCertificateName = NULL,
regionalCertificateArn = NULL,
endpointConfiguration = NULL,
tags = NULL,
securityPolicy = NULL,
mutualTlsAuthentication = NULL,
ownershipVerificationCertificateArn = NULL,
policy = NULL
)
Arguments
domainName |
[required] The name of the DomainName resource. |
certificateName |
The user-friendly name of the certificate that will be used by edge-optimized endpoint or private endpoint for this domain name. |
certificateBody |
[Deprecated] The body of the server certificate that will be used by edge-optimized endpoint or private endpoint for this domain name provided by your certificate authority. |
certificatePrivateKey |
[Deprecated] Your edge-optimized endpoint's domain name certificate's private key. |
certificateChain |
[Deprecated] The intermediate certificates and optionally the root certificate, one after the other without any blank lines, used by an edge-optimized endpoint for this domain name. If you include the root certificate, your certificate chain must start with intermediate certificates and end with the root certificate. Use the intermediate certificates that were provided by your certificate authority. Do not include any intermediaries that are not in the chain of trust path. |
certificateArn |
The reference to an Amazon Web Services-managed certificate that will be used by edge-optimized endpoint or private endpoint for this domain name. Certificate Manager is the only supported source. |
regionalCertificateName |
The user-friendly name of the certificate that will be used by regional endpoint for this domain name. |
regionalCertificateArn |
The reference to an Amazon Web Services-managed certificate that will be used by regional endpoint for this domain name. Certificate Manager is the only supported source. |
endpointConfiguration |
The endpoint configuration of this DomainName showing the endpoint types of the domain name. |
tags |
The key-value map of strings. The valid character set is
[a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not
start with |
securityPolicy |
The Transport Layer Security (TLS) version + cipher suite for this
DomainName. The valid values are |
mutualTlsAuthentication |
|
ownershipVerificationCertificateArn |
The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the regionalCertificateArn. |
policy |
A stringified JSON policy document that applies to the |
Creates a domain name access association resource between an access association source and a private custom domain name
Description
Creates a domain name access association resource between an access association source and a private custom domain name.
See https://www.paws-r-sdk.com/docs/apigateway_create_domain_name_access_association/ for full documentation.
Usage
apigateway_create_domain_name_access_association(
domainNameArn,
accessAssociationSourceType,
accessAssociationSource,
tags = NULL
)
Arguments
domainNameArn |
[required] The ARN of the domain name. |
accessAssociationSourceType |
[required] The type of the domain name access association source. |
accessAssociationSource |
[required] The identifier of the domain name access association source. For a VPCE, the value is the VPC endpoint ID. |
tags |
The key-value map of strings. The valid character set is
[a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not
start with |
Adds a new Model resource to an existing RestApi resource
Description
Adds a new Model resource to an existing RestApi resource.
See https://www.paws-r-sdk.com/docs/apigateway_create_model/ for full documentation.
Usage
apigateway_create_model(
restApiId,
name,
description = NULL,
schema = NULL,
contentType
)
Arguments
restApiId |
[required] The RestApi identifier under which the Model will be created. |
name |
[required] The name of the model. Must be alphanumeric. |
description |
The description of the model. |
schema |
The schema for the model. For |
contentType |
[required] The content-type for the model. |
Creates a RequestValidator of a given RestApi
Description
Creates a RequestValidator of a given RestApi.
See https://www.paws-r-sdk.com/docs/apigateway_create_request_validator/ for full documentation.
Usage
apigateway_create_request_validator(
restApiId,
name = NULL,
validateRequestBody = NULL,
validateRequestParameters = NULL
)
Arguments
restApiId |
[required] The string identifier of the associated RestApi. |
name |
The name of the to-be-created RequestValidator. |
validateRequestBody |
A Boolean flag to indicate whether to validate request body according to
the configured model schema for the method ( |
validateRequestParameters |
A Boolean flag to indicate whether to validate request parameters,
|
Creates a Resource resource
Description
Creates a Resource resource.
See https://www.paws-r-sdk.com/docs/apigateway_create_resource/ for full documentation.
Usage
apigateway_create_resource(restApiId, parentId, pathPart)
Arguments
restApiId |
[required] The string identifier of the associated RestApi. |
parentId |
[required] The parent resource's identifier. |
pathPart |
[required] The last path segment for this resource. |
Creates a new RestApi resource
Description
Creates a new RestApi resource.
See https://www.paws-r-sdk.com/docs/apigateway_create_rest_api/ for full documentation.
Usage
apigateway_create_rest_api(
name,
description = NULL,
version = NULL,
cloneFrom = NULL,
binaryMediaTypes = NULL,
minimumCompressionSize = NULL,
apiKeySource = NULL,
endpointConfiguration = NULL,
policy = NULL,
tags = NULL,
disableExecuteApiEndpoint = NULL
)
Arguments
name |
[required] The name of the RestApi. |
description |
The description of the RestApi. |
version |
A version identifier for the API. |
cloneFrom |
The ID of the RestApi that you want to clone from. |
binaryMediaTypes |
The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads. |
minimumCompressionSize |
A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size. |
apiKeySource |
The source of the API key for metering requests according to a usage
plan. Valid values are: |
endpointConfiguration |
The endpoint configuration of this RestApi showing the endpoint types of the API. |
policy |
A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration. |
tags |
The key-value map of strings. The valid character set is
[a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not
start with |
disableExecuteApiEndpoint |
Specifies whether clients can invoke your API by using the default
|
Creates a new Stage resource that references a pre-existing Deployment for the API
Description
Creates a new Stage resource that references a pre-existing Deployment for the API.
See https://www.paws-r-sdk.com/docs/apigateway_create_stage/ for full documentation.
Usage
apigateway_create_stage(
restApiId,
stageName,
deploymentId,
description = NULL,
cacheClusterEnabled = NULL,
cacheClusterSize = NULL,
variables = NULL,
documentationVersion = NULL,
canarySettings = NULL,
tracingEnabled = NULL,
tags = NULL
)
Arguments
restApiId |
[required] The string identifier of the associated RestApi. |
stageName |
[required] The name for the Stage resource. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters. |
deploymentId |
[required] The identifier of the Deployment resource for the Stage resource. |
description |
The description of the Stage resource. |
cacheClusterEnabled |
Whether cache clustering is enabled for the stage. |
cacheClusterSize |
The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness. |
variables |
A map that defines the stage variables for the new Stage resource.
Variable names can have alphanumeric and underscore characters, and the
values must match |
documentationVersion |
The version of the associated API documentation. |
canarySettings |
The canary deployment settings of this stage. |
tracingEnabled |
Specifies whether active tracing with X-ray is enabled for the Stage. |
tags |
The key-value map of strings. The valid character set is
[a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not
start with |
Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload
Description
Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload.
See https://www.paws-r-sdk.com/docs/apigateway_create_usage_plan/ for full documentation.
Usage
apigateway_create_usage_plan(
name,
description = NULL,
apiStages = NULL,
throttle = NULL,
quota = NULL,
tags = NULL
)
Arguments
name |
[required] The name of the usage plan. |
description |
The description of the usage plan. |
apiStages |
The associated API stages of the usage plan. |
throttle |
The throttling limits of the usage plan. |
quota |
The quota of the usage plan. |
tags |
The key-value map of strings. The valid character set is
[a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not
start with |
Creates a usage plan key for adding an existing API key to a usage plan
Description
Creates a usage plan key for adding an existing API key to a usage plan.
See https://www.paws-r-sdk.com/docs/apigateway_create_usage_plan_key/ for full documentation.
Usage
apigateway_create_usage_plan_key(usagePlanId, keyId, keyType)
Arguments
usagePlanId |
[required] The Id of the UsagePlan resource representing the usage plan containing the to-be-created UsagePlanKey resource representing a plan customer. |
keyId |
[required] The identifier of a UsagePlanKey resource for a plan customer. |
keyType |
[required] The type of a UsagePlanKey resource for a plan customer. |
Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that typically takes 2-4 minutes to complete and become operational
Description
Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that typically takes 2-4 minutes to complete and become operational. The caller must have permissions to create and update VPC Endpoint services.
See https://www.paws-r-sdk.com/docs/apigateway_create_vpc_link/ for full documentation.
Usage
apigateway_create_vpc_link(name, description = NULL, targetArns, tags = NULL)
Arguments
name |
[required] The name used to label and identify the VPC link. |
description |
The description of the VPC link. |
targetArns |
[required] The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same Amazon Web Services account of the API owner. |
tags |
The key-value map of strings. The valid character set is
[a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not
start with |
Deletes the ApiKey resource
Description
Deletes the ApiKey resource.
See https://www.paws-r-sdk.com/docs/apigateway_delete_api_key/ for full documentation.
Usage
apigateway_delete_api_key(apiKey)
Arguments
apiKey |
[required] The identifier of the ApiKey resource to be deleted. |
Deletes an existing Authorizer resource
Description
Deletes an existing Authorizer resource.
See https://www.paws-r-sdk.com/docs/apigateway_delete_authorizer/ for full documentation.
Usage
apigateway_delete_authorizer(restApiId, authorizerId)
Arguments
restApiId |
[required] The string identifier of the associated RestApi. |
authorizerId |
[required] The identifier of the Authorizer resource. |
Deletes the BasePathMapping resource
Description
Deletes the BasePathMapping resource.
See https://www.paws-r-sdk.com/docs/apigateway_delete_base_path_mapping/ for full documentation.
Usage
apigateway_delete_base_path_mapping(domainName, domainNameId = NULL, basePath)
Arguments
domainName |
[required] The domain name of the BasePathMapping resource to delete. |
domainNameId |
The identifier for the domain name resource. Supported only for private custom domain names. |
basePath |
[required] The base path name of the BasePathMapping resource to delete. To specify an empty base path, set this parameter to |
Deletes the ClientCertificate resource
Description
Deletes the ClientCertificate resource.
See https://www.paws-r-sdk.com/docs/apigateway_delete_client_certificate/ for full documentation.
Usage
apigateway_delete_client_certificate(clientCertificateId)
Arguments
clientCertificateId |
[required] The identifier of the ClientCertificate resource to be deleted. |
Deletes a Deployment resource
Description
Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it.
See https://www.paws-r-sdk.com/docs/apigateway_delete_deployment/ for full documentation.
Usage
apigateway_delete_deployment(restApiId, deploymentId)
Arguments
restApiId |
[required] The string identifier of the associated RestApi. |
deploymentId |
[required] The identifier of the Deployment resource to delete. |
Deletes a documentation part
Description
Deletes a documentation part
See https://www.paws-r-sdk.com/docs/apigateway_delete_documentation_part/ for full documentation.
Usage
apigateway_delete_documentation_part(restApiId, documentationPartId)
Arguments
restApiId |
[required] The string identifier of the associated RestApi. |
documentationPartId |
[required] The identifier of the to-be-deleted documentation part. |
Deletes a documentation version
Description
Deletes a documentation version.
See https://www.paws-r-sdk.com/docs/apigateway_delete_documentation_version/ for full documentation.
Usage
apigateway_delete_documentation_version(restApiId, documentationVersion)
Arguments
restApiId |
[required] The string identifier of the associated RestApi. |
documentationVersion |
[required] The version identifier of a to-be-deleted documentation snapshot. |
Deletes the DomainName resource
Description
Deletes the DomainName resource.
See https://www.paws-r-sdk.com/docs/apigateway_delete_domain_name/ for full documentation.
Usage
apigateway_delete_domain_name(domainName, domainNameId = NULL)
Arguments
domainName |
[required] The name of the DomainName resource to be deleted. |
domainNameId |
The identifier for the domain name resource. Supported only for private custom domain names. |
Deletes the DomainNameAccessAssociation resource
Description
Deletes the DomainNameAccessAssociation resource.
See https://www.paws-r-sdk.com/docs/apigateway_delete_domain_name_access_association/ for full documentation.
Usage
apigateway_delete_domain_name_access_association(
domainNameAccessAssociationArn
)
Arguments
domainNameAccessAssociationArn |
[required] The ARN of the domain name access association resource. |
Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings
Description
Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.
See https://www.paws-r-sdk.com/docs/apigateway_delete_gateway_response/ for full documentation.
Usage
apigateway_delete_gateway_response(restApiId, responseType)
Arguments
restApiId |
[required] The string identifier of the associated RestApi. |
responseType |
[required] The response type of the associated GatewayResponse. |
Represents a delete integration
Description
Represents a delete integration.
See https://www.paws-r-sdk.com/docs/apigateway_delete_integration/ for full documentation.
Usage
apigateway_delete_integration(restApiId, resourceId, httpMethod)
Arguments
restApiId |
[required] The string identifier of the associated RestApi. |
resourceId |
[required] Specifies a delete integration request's resource identifier. |
httpMethod |
[required] Specifies a delete integration request's HTTP method. |
Represents a delete integration response
Description
Represents a delete integration response.
See https://www.paws-r-sdk.com/docs/apigateway_delete_integration_response/ for full documentation.
Usage
apigateway_delete_integration_response(
restApiId,
resourceId,
httpMethod,
statusCode
)
Arguments
restApiId |
[required] The string identifier of the associated RestApi. |
resourceId |
[required] Specifies a delete integration response request's resource identifier. |
httpMethod |
[required] Specifies a delete integration response request's HTTP method. |
statusCode |
[required] Specifies a delete integration response request's status code. |
Deletes an existing Method resource
Description
Deletes an existing Method resource.
See https://www.paws-r-sdk.com/docs/apigateway_delete_method/ for full documentation.
Usage
apigateway_delete_method(restApiId, resourceId, httpMethod)
Arguments
restApiId |
[required] The string identifier of the associated RestApi. |
resourceId |
[required] The Resource identifier for the Method resource. |
httpMethod |
[required] The HTTP verb of the Method resource. |
Deletes an existing MethodResponse resource
Description
Deletes an existing MethodResponse resource.
See https://www.paws-r-sdk.com/docs/apigateway_delete_method_response/ for full documentation.
Usage
apigateway_delete_method_response(
restApiId,
resourceId,
httpMethod,
statusCode
)
Arguments
restApiId |
[required] The string identifier of the associated RestApi. |
resourceId |
[required] The Resource identifier for the MethodResponse resource. |
httpMethod |
[required] The HTTP verb of the Method resource. |
statusCode |
[required] The status code identifier for the MethodResponse resource. |
Deletes a model
Description
Deletes a model.
See https://www.paws-r-sdk.com/docs/apigateway_delete_model/ for full documentation.
Usage
apigateway_delete_model(restApiId, modelName)
Arguments
restApiId |
[required] The string identifier of the associated RestApi. |
modelName |
[required] The name of the model to delete. |
Deletes a RequestValidator of a given RestApi
Description
Deletes a RequestValidator of a given RestApi.
See https://www.paws-r-sdk.com/docs/apigateway_delete_request_validator/ for full documentation.
Usage
apigateway_delete_request_validator(restApiId, requestValidatorId)
Arguments
restApiId |
[required] The string identifier of the associated RestApi. |
requestValidatorId |
[required] The identifier of the RequestValidator to be deleted. |
Deletes a Resource resource
Description
Deletes a Resource resource.
See https://www.paws-r-sdk.com/docs/apigateway_delete_resource/ for full documentation.
Usage
apigateway_delete_resource(restApiId, resourceId)
Arguments
restApiId |
[required] The string identifier of the associated RestApi. |
resourceId |
[required] The identifier of the Resource resource. |
Deletes the specified API
Description
Deletes the specified API.
See https://www.paws-r-sdk.com/docs/apigateway_delete_rest_api/ for full documentation.
Usage
apigateway_delete_rest_api(restApiId)
Arguments
restApiId |
[required] The string identifier of the associated RestApi. |
Deletes a Stage resource
Description
Deletes a Stage resource.
See https://www.paws-r-sdk.com/docs/apigateway_delete_stage/ for full documentation.
Usage
apigateway_delete_stage(restApiId, stageName)
Arguments
restApiId |
[required] The string identifier of the associated RestApi. |
stageName |
[required] The name of the Stage resource to delete. |
Deletes a usage plan of a given plan Id
Description
Deletes a usage plan of a given plan Id.
See https://www.paws-r-sdk.com/docs/apigateway_delete_usage_plan/ for full documentation.
Usage
apigateway_delete_usage_plan(usagePlanId)
Arguments
usagePlanId |
[required] The Id of the to-be-deleted usage plan. |
Deletes a usage plan key and remove the underlying API key from the associated usage plan
Description
Deletes a usage plan key and remove the underlying API key from the associated usage plan.
See https://www.paws-r-sdk.com/docs/apigateway_delete_usage_plan_key/ for full documentation.
Usage
apigateway_delete_usage_plan_key(usagePlanId, keyId)
Arguments
usagePlanId |
[required] The Id of the UsagePlan resource representing the usage plan containing the to-be-deleted UsagePlanKey resource representing a plan customer. |
keyId |
[required] The Id of the UsagePlanKey resource to be deleted. |
Deletes an existing VpcLink of a specified identifier
Description
Deletes an existing VpcLink of a specified identifier.
See https://www.paws-r-sdk.com/docs/apigateway_delete_vpc_link/ for full documentation.
Usage
apigateway_delete_vpc_link(vpcLinkId)
Arguments
vpcLinkId |
[required] The identifier of the VpcLink. It is used in an Integration to reference this VpcLink. |
Flushes all authorizer cache entries on a stage
Description
Flushes all authorizer cache entries on a stage.
See https://www.paws-r-sdk.com/docs/apigateway_flush_stage_authorizers_cache/ for full documentation.
Usage
apigateway_flush_stage_authorizers_cache(restApiId, stageName)
Arguments
restApiId |
[required] The string identifier of the associated RestApi. |
stageName |
[required] The name of the stage to flush. |
Flushes a stage's cache
Description
Flushes a stage's cache.
See https://www.paws-r-sdk.com/docs/apigateway_flush_stage_cache/ for full documentation.
Usage
apigateway_flush_stage_cache(restApiId, stageName)
Arguments
restApiId |
[required] The string identifier of the associated RestApi. |
stageName |
[required] The name of the stage to flush its cache. |
Generates a ClientCertificate resource
Description
Generates a ClientCertificate resource.
See https://www.paws-r-sdk.com/docs/apigateway_generate_client_certificate/ for full documentation.
Usage
apigateway_generate_client_certificate(description = NULL, tags = NULL)
Arguments
description |
The description of the ClientCertificate. |
tags |
The key-value map of strings. The valid character set is
[a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not
start with |
Gets information about the current Account resource
Description
Gets information about the current Account resource.
See https://www.paws-r-sdk.com/docs/apigateway_get_account/ for full documentation.
Usage
apigateway_get_account()
Gets information about the current ApiKey resource
Description
Gets information about the current ApiKey resource.
See https://www.paws-r-sdk.com/docs/apigateway_get_api_key/ for full documentation.
Usage
apigateway_get_api_key(apiKey, includeValue = NULL)
Arguments
apiKey |
[required] The identifier of the ApiKey resource. |
includeValue |
A boolean flag to specify whether ( |
Gets information about the current ApiKeys resource
Description
Gets information about the current ApiKeys resource.
See https://www.paws-r-sdk.com/docs/apigateway_get_api_keys/ for full documentation.
Usage
apigateway_get_api_keys(
position = NULL,
limit = NULL,
nameQuery = NULL,
customerId = NULL,
includeValues = NULL
)
Arguments
position |
The current pagination position in the paged result set. |
limit |
The maximum number of returned results per page. The default value is 25 and the maximum value is 500. |
nameQuery |
The name of queried API keys. |
customerId |
The identifier of a customer in Amazon Web Services Marketplace or an external system, such as a developer portal. |
includeValues |
A boolean flag to specify whether ( |
Describe an existing Authorizer resource
Description
Describe an existing Authorizer resource.
See https://www.paws-r-sdk.com/docs/apigateway_get_authorizer/ for full documentation.
Usage
apigateway_get_authorizer(restApiId, authorizerId)
Arguments
restApiId |
[required] The string identifier of the associated RestApi. |
authorizerId |
[required] The identifier of the Authorizer resource. |
Describe an existing Authorizers resource
Description
Describe an existing Authorizers resource.
See https://www.paws-r-sdk.com/docs/apigateway_get_authorizers/ for full documentation.
Usage
apigateway_get_authorizers(restApiId, position = NULL, limit = NULL)
Arguments
restApiId |
[required] The string identifier of the associated RestApi. |
position |
The current pagination position in the paged result set. |
limit |
The maximum number of returned results per page. The default value is 25 and the maximum value is 500. |
Describe a BasePathMapping resource
Description
Describe a BasePathMapping resource.
See https://www.paws-r-sdk.com/docs/apigateway_get_base_path_mapping/ for full documentation.
Usage
apigateway_get_base_path_mapping(domainName, domainNameId = NULL, basePath)
Arguments
domainName |
[required] The domain name of the BasePathMapping resource to be described. |
domainNameId |
The identifier for the domain name resource. Supported only for private custom domain names. |
basePath |
[required] The base path name that callers of the API must provide as part of the URL after the domain name. This value must be unique for all of the mappings across a single API. Specify '(none)' if you do not want callers to specify any base path name after the domain name. |
Represents a collection of BasePathMapping resources
Description
Represents a collection of BasePathMapping resources.
See https://www.paws-r-sdk.com/docs/apigateway_get_base_path_mappings/ for full documentation.
Usage
apigateway_get_base_path_mappings(
domainName,
domainNameId = NULL,
position = NULL,
limit = NULL
)
Arguments
domainName |
[required] The domain name of a BasePathMapping resource. |
domainNameId |
The identifier for the domain name resource. Supported only for private custom domain names. |
position |
The current pagination position in the paged result set. |
limit |
The maximum number of returned results per page. The default value is 25 and the maximum value is 500. |
Gets information about the current ClientCertificate resource
Description
Gets information about the current ClientCertificate resource.
See https://www.paws-r-sdk.com/docs/apigateway_get_client_certificate/ for full documentation.
Usage
apigateway_get_client_certificate(clientCertificateId)
Arguments
clientCertificateId |
[required] The identifier of the ClientCertificate resource to be described. |
Gets a collection of ClientCertificate resources
Description
Gets a collection of ClientCertificate resources.
See https://www.paws-r-sdk.com/docs/apigateway_get_client_certificates/ for full documentation.
Usage
apigateway_get_client_certificates(position = NULL, limit = NULL)
Arguments
position |
The current pagination position in the paged result set. |
limit |
The maximum number of returned results per page. The default value is 25 and the maximum value is 500. |
Gets information about a Deployment resource
Description
Gets information about a Deployment resource.
See https://www.paws-r-sdk.com/docs/apigateway_get_deployment/ for full documentation.
Usage
apigateway_get_deployment(restApiId, deploymentId, embed = NULL)
Arguments
restApiId |
[required] The string identifier of the associated RestApi. |
deploymentId |
[required] The identifier of the Deployment resource to get information about. |
embed |
A query parameter to retrieve the specified embedded resources of the
returned Deployment resource in the response. In a REST API call, this
|
Gets information about a Deployments collection
Description
Gets information about a Deployments collection.
See https://www.paws-r-sdk.com/docs/apigateway_get_deployments/ for full documentation.
Usage
apigateway_get_deployments(restApiId, position = NULL, limit = NULL)
Arguments
restApiId |
[required] The string identifier of the associated RestApi. |
position |
The current pagination position in the paged result set. |
limit |
The maximum number of returned results per page. The default value is 25 and the maximum value is 500. |
Gets a documentation part
Description
Gets a documentation part.
See https://www.paws-r-sdk.com/docs/apigateway_get_documentation_part/ for full documentation.
Usage
apigateway_get_documentation_part(restApiId, documentationPartId)
Arguments
restApiId |
[required] The string identifier of the associated RestApi. |
documentationPartId |
[required] The string identifier of the associated RestApi. |
Gets documentation parts
Description
Gets documentation parts.
See https://www.paws-r-sdk.com/docs/apigateway_get_documentation_parts/ for full documentation.
Usage
apigateway_get_documentation_parts(
restApiId,
type = NULL,
nameQuery = NULL,
path = NULL,
position = NULL,
limit = NULL,
locationStatus = NULL
)
Arguments
restApiId |
[required] The string identifier of the associated RestApi. |
type |
The type of API entities of the to-be-retrieved documentation parts. |
nameQuery |
The name of API entities of the to-be-retrieved documentation parts. |
path |
The path of API entities of the to-be-retrieved documentation parts. |
position |
The current pagination position in the paged result set. |
limit |
The maximum number of returned results per page. The default value is 25 and the maximum value is 500. |
locationStatus |
The status of the API documentation parts to retrieve. Valid values are
|
Gets a documentation version
Description
Gets a documentation version.
See https://www.paws-r-sdk.com/docs/apigateway_get_documentation_version/ for full documentation.
Usage
apigateway_get_documentation_version(restApiId, documentationVersion)
Arguments
restApiId |
[required] The string identifier of the associated RestApi. |
documentationVersion |
[required] The version identifier of the to-be-retrieved documentation snapshot. |
Gets documentation versions
Description
Gets documentation versions.
See https://www.paws-r-sdk.com/docs/apigateway_get_documentation_versions/ for full documentation.
Usage
apigateway_get_documentation_versions(restApiId, position = NULL, limit = NULL)
Arguments
restApiId |
[required] The string identifier of the associated RestApi. |
position |
The current pagination position in the paged result set. |
limit |
The maximum number of returned results per page. The default value is 25 and the maximum value is 500. |
Represents a domain name that is contained in a simpler, more intuitive URL that can be called
Description
Represents a domain name that is contained in a simpler, more intuitive URL that can be called.
See https://www.paws-r-sdk.com/docs/apigateway_get_domain_name/ for full documentation.
Usage
apigateway_get_domain_name(domainName, domainNameId = NULL)
Arguments
domainName |
[required] The name of the DomainName resource. |
domainNameId |
The identifier for the domain name resource. Required for private custom domain names. |
Represents a collection on DomainNameAccessAssociations resources
Description
Represents a collection on DomainNameAccessAssociations resources.
See https://www.paws-r-sdk.com/docs/apigateway_get_domain_name_access_associations/ for full documentation.
Usage
apigateway_get_domain_name_access_associations(
position = NULL,
limit = NULL,
resourceOwner = NULL
)
Arguments
position |
The current pagination position in the paged result set. |
limit |
The maximum number of returned results per page. The default value is 25 and the maximum value is 500. |
resourceOwner |
The owner of the domain name access association. Use |
Represents a collection of DomainName resources
Description
Represents a collection of DomainName resources.
See https://www.paws-r-sdk.com/docs/apigateway_get_domain_names/ for full documentation.
Usage
apigateway_get_domain_names(
position = NULL,
limit = NULL,
resourceOwner = NULL
)
Arguments
position |
The current pagination position in the paged result set. |
limit |
The maximum number of returned results per page. The default value is 25 and the maximum value is 500. |
resourceOwner |
The owner of the domain name access association. |
Exports a deployed version of a RestApi in a specified format
Description
Exports a deployed version of a RestApi in a specified format.
See https://www.paws-r-sdk.com/docs/apigateway_get_export/ for full documentation.
Usage
apigateway_get_export(
restApiId,
stageName,
exportType,
parameters = NULL,
accepts = NULL
)
Arguments
restApiId |
[required] The string identifier of the associated RestApi. |
stageName |
[required] The name of the Stage that will be exported. |
exportType |
[required] The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and 'swagger' for Swagger/OpenAPI 2.0. |
parameters |
A key-value map of query string parameters that specify properties of
the export, depending on the requested |
accepts |
The content-type of the export, for example |
Gets a GatewayResponse of a specified response type on the given RestApi
Description
Gets a GatewayResponse of a specified response type on the given RestApi.
See https://www.paws-r-sdk.com/docs/apigateway_get_gateway_response/ for full documentation.
Usage
apigateway_get_gateway_response(restApiId, responseType)
Arguments
restApiId |
[required] The string identifier of the associated RestApi. |
responseType |
[required] The response type of the associated GatewayResponse. |
Gets the GatewayResponses collection on the given RestApi
Description
Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any definitions for gateway responses, the result will be the API Gateway-generated default GatewayResponses collection for the supported response types.
See https://www.paws-r-sdk.com/docs/apigateway_get_gateway_responses/ for full documentation.
Usage
apigateway_get_gateway_responses(restApiId, position = NULL, limit = NULL)
Arguments
restApiId |
[required] The string identifier of the associated RestApi. |
position |
The current pagination position in the paged result set. The GatewayResponse collection does not support pagination and the position does not apply here. |
limit |
The maximum number of returned results per page. The default value is 25 and the maximum value is 500. The GatewayResponses collection does not support pagination and the limit does not apply here. |
Get the integration settings
Description
Get the integration settings.
See https://www.paws-r-sdk.com/docs/apigateway_get_integration/ for full documentation.
Usage
apigateway_get_integration(restApiId, resourceId, httpMethod)
Arguments
restApiId |
[required] The string identifier of the associated RestApi. |
resourceId |
[required] Specifies a get integration request's resource identifier |
httpMethod |
[required] Specifies a get integration request's HTTP method. |
Represents a get integration response
Description
Represents a get integration response.
See https://www.paws-r-sdk.com/docs/apigateway_get_integration_response/ for full documentation.
Usage
apigateway_get_integration_response(
restApiId,
resourceId,
httpMethod,
statusCode
)
Arguments
restApiId |
[required] The string identifier of the associated RestApi. |
resourceId |
[required] Specifies a get integration response request's resource identifier. |
httpMethod |
[required] Specifies a get integration response request's HTTP method. |
statusCode |
[required] Specifies a get integration response request's status code. |
Describe an existing Method resource
Description
Describe an existing Method resource.
See https://www.paws-r-sdk.com/docs/apigateway_get_method/ for full documentation.
Usage
apigateway_get_method(restApiId, resourceId, httpMethod)
Arguments
restApiId |
[required] The string identifier of the associated RestApi. |
resourceId |
[required] The Resource identifier for the Method resource. |
httpMethod |
[required] Specifies the method request's HTTP method type. |
Describes a MethodResponse resource
Description
Describes a MethodResponse resource.
See https://www.paws-r-sdk.com/docs/apigateway_get_method_response/ for full documentation.
Usage
apigateway_get_method_response(restApiId, resourceId, httpMethod, statusCode)
Arguments
restApiId |
[required] The string identifier of the associated RestApi. |
resourceId |
[required] The Resource identifier for the MethodResponse resource. |
httpMethod |
[required] The HTTP verb of the Method resource. |
statusCode |
[required] The status code for the MethodResponse resource. |
Describes an existing model defined for a RestApi resource
Description
Describes an existing model defined for a RestApi resource.
See https://www.paws-r-sdk.com/docs/apigateway_get_model/ for full documentation.
Usage
apigateway_get_model(restApiId, modelName, flatten = NULL)
Arguments
restApiId |
[required] The RestApi identifier under which the Model exists. |
modelName |
[required] The name of the model as an identifier. |
flatten |
A query parameter of a Boolean value to resolve ( |
Generates a sample mapping template that can be used to transform a payload into the structure of a model
Description
Generates a sample mapping template that can be used to transform a payload into the structure of a model.
See https://www.paws-r-sdk.com/docs/apigateway_get_model_template/ for full documentation.
Usage
apigateway_get_model_template(restApiId, modelName)
Arguments
restApiId |
[required] The string identifier of the associated RestApi. |
modelName |
[required] The name of the model for which to generate a template. |
Describes existing Models defined for a RestApi resource
Description
Describes existing Models defined for a RestApi resource.
See https://www.paws-r-sdk.com/docs/apigateway_get_models/ for full documentation.
Usage
apigateway_get_models(restApiId, position = NULL, limit = NULL)
Arguments
restApiId |
[required] The string identifier of the associated RestApi. |
position |
The current pagination position in the paged result set. |
limit |
The maximum number of returned results per page. The default value is 25 and the maximum value is 500. |
Gets a RequestValidator of a given RestApi
Description
Gets a RequestValidator of a given RestApi.
See https://www.paws-r-sdk.com/docs/apigateway_get_request_validator/ for full documentation.
Usage
apigateway_get_request_validator(restApiId, requestValidatorId)
Arguments
restApiId |
[required] The string identifier of the associated RestApi. |
requestValidatorId |
[required] The identifier of the RequestValidator to be retrieved. |
Gets the RequestValidators collection of a given RestApi
Description
Gets the RequestValidators collection of a given RestApi.
See https://www.paws-r-sdk.com/docs/apigateway_get_request_validators/ for full documentation.
Usage
apigateway_get_request_validators(restApiId, position = NULL, limit = NULL)
Arguments
restApiId |
[required] The string identifier of the associated RestApi. |
position |
The current pagination position in the paged result set. |
limit |
The maximum number of returned results per page. The default value is 25 and the maximum value is 500. |
Lists information about a resource
Description
Lists information about a resource.
See https://www.paws-r-sdk.com/docs/apigateway_get_resource/ for full documentation.
Usage
apigateway_get_resource(restApiId, resourceId, embed = NULL)
Arguments
restApiId |
[required] The string identifier of the associated RestApi. |
resourceId |
[required] The identifier for the Resource resource. |
embed |
A query parameter to retrieve the specified resources embedded in the
returned Resource representation in the response. This |
Lists information about a collection of Resource resources
Description
Lists information about a collection of Resource resources.
See https://www.paws-r-sdk.com/docs/apigateway_get_resources/ for full documentation.
Usage
apigateway_get_resources(
restApiId,
position = NULL,
limit = NULL,
embed = NULL
)
Arguments
restApiId |
[required] The string identifier of the associated RestApi. |
position |
The current pagination position in the paged result set. |
limit |
The maximum number of returned results per page. The default value is 25 and the maximum value is 500. |
embed |
A query parameter used to retrieve the specified resources embedded in
the returned Resources resource in the response. This |
Lists the RestApi resource in the collection
Description
Lists the RestApi resource in the collection.
See https://www.paws-r-sdk.com/docs/apigateway_get_rest_api/ for full documentation.
Usage
apigateway_get_rest_api(restApiId)
Arguments
restApiId |
[required] The string identifier of the associated RestApi. |
Lists the RestApis resources for your collection
Description
Lists the RestApis resources for your collection.
See https://www.paws-r-sdk.com/docs/apigateway_get_rest_apis/ for full documentation.
Usage
apigateway_get_rest_apis(position = NULL, limit = NULL)
Arguments
position |
The current pagination position in the paged result set. |
limit |
The maximum number of returned results per page. The default value is 25 and the maximum value is 500. |
Generates a client SDK for a RestApi and Stage
Description
Generates a client SDK for a RestApi and Stage.
See https://www.paws-r-sdk.com/docs/apigateway_get_sdk/ for full documentation.
Usage
apigateway_get_sdk(restApiId, stageName, sdkType, parameters = NULL)
Arguments
restApiId |
[required] The string identifier of the associated RestApi. |
stageName |
[required] The name of the Stage that the SDK will use. |
sdkType |
[required] The language for the generated SDK. Currently |
parameters |
A string-to-string key-value map of query parameters |
Gets an SDK type
Description
Gets an SDK type.
See https://www.paws-r-sdk.com/docs/apigateway_get_sdk_type/ for full documentation.
Usage
apigateway_get_sdk_type(id)
Arguments
id |
[required] The identifier of the queried SdkType instance. |
Gets SDK types
Description
Gets SDK types
See https://www.paws-r-sdk.com/docs/apigateway_get_sdk_types/ for full documentation.
Usage
apigateway_get_sdk_types(position = NULL, limit = NULL)
Arguments
position |
The current pagination position in the paged result set. |
limit |
The maximum number of returned results per page. The default value is 25 and the maximum value is 500. |
Gets information about a Stage resource
Description
Gets information about a Stage resource.
See https://www.paws-r-sdk.com/docs/apigateway_get_stage/ for full documentation.
Usage
apigateway_get_stage(restApiId, stageName)
Arguments
restApiId |
[required] The string identifier of the associated RestApi. |
stageName |
[required] The name of the Stage resource to get information about. |
Gets information about one or more Stage resources
Description
Gets information about one or more Stage resources.
See https://www.paws-r-sdk.com/docs/apigateway_get_stages/ for full documentation.
Usage
apigateway_get_stages(restApiId, deploymentId = NULL)
Arguments
restApiId |
[required] The string identifier of the associated RestApi. |
deploymentId |
The stages' deployment identifiers. |
Gets the Tags collection for a given resource
Description
Gets the Tags collection for a given resource.
See https://www.paws-r-sdk.com/docs/apigateway_get_tags/ for full documentation.
Usage
apigateway_get_tags(resourceArn, position = NULL, limit = NULL)
Arguments
resourceArn |
[required] The ARN of a resource that can be tagged. |
position |
(Not currently supported) The current pagination position in the paged result set. |
limit |
(Not currently supported) The maximum number of returned results per page. The default value is 25 and the maximum value is 500. |
Gets the usage data of a usage plan in a specified time interval
Description
Gets the usage data of a usage plan in a specified time interval.
See https://www.paws-r-sdk.com/docs/apigateway_get_usage/ for full documentation.
Usage
apigateway_get_usage(
usagePlanId,
keyId = NULL,
startDate,
endDate,
position = NULL,
limit = NULL
)
Arguments
usagePlanId |
[required] The Id of the usage plan associated with the usage data. |
keyId |
The Id of the API key associated with the resultant usage data. |
startDate |
[required] The starting date (e.g., 2016-01-01) of the usage data. |
endDate |
[required] The ending date (e.g., 2016-12-31) of the usage data. |
position |
The current pagination position in the paged result set. |
limit |
The maximum number of returned results per page. The default value is 25 and the maximum value is 500. |
Gets a usage plan of a given plan identifier
Description
Gets a usage plan of a given plan identifier.
See https://www.paws-r-sdk.com/docs/apigateway_get_usage_plan/ for full documentation.
Usage
apigateway_get_usage_plan(usagePlanId)
Arguments
usagePlanId |
[required] The identifier of the UsagePlan resource to be retrieved. |
Gets a usage plan key of a given key identifier
Description
Gets a usage plan key of a given key identifier.
See https://www.paws-r-sdk.com/docs/apigateway_get_usage_plan_key/ for full documentation.
Usage
apigateway_get_usage_plan_key(usagePlanId, keyId)
Arguments
usagePlanId |
[required] The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer. |
keyId |
[required] The key Id of the to-be-retrieved UsagePlanKey resource representing a plan customer. |
Gets all the usage plan keys representing the API keys added to a specified usage plan
Description
Gets all the usage plan keys representing the API keys added to a specified usage plan.
See https://www.paws-r-sdk.com/docs/apigateway_get_usage_plan_keys/ for full documentation.
Usage
apigateway_get_usage_plan_keys(
usagePlanId,
position = NULL,
limit = NULL,
nameQuery = NULL
)
Arguments
usagePlanId |
[required] The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer. |
position |
The current pagination position in the paged result set. |
limit |
The maximum number of returned results per page. The default value is 25 and the maximum value is 500. |
nameQuery |
A query parameter specifying the name of the to-be-returned usage plan keys. |
Gets all the usage plans of the caller's account
Description
Gets all the usage plans of the caller's account.
See https://www.paws-r-sdk.com/docs/apigateway_get_usage_plans/ for full documentation.
Usage
apigateway_get_usage_plans(position = NULL, keyId = NULL, limit = NULL)
Arguments
position |
The current pagination position in the paged result set. |
keyId |
The identifier of the API key associated with the usage plans. |
limit |
The maximum number of returned results per page. The default value is 25 and the maximum value is 500. |
Gets a specified VPC link under the caller's account in a region
Description
Gets a specified VPC link under the caller's account in a region.
See https://www.paws-r-sdk.com/docs/apigateway_get_vpc_link/ for full documentation.
Usage
apigateway_get_vpc_link(vpcLinkId)
Arguments
vpcLinkId |
[required] The identifier of the VpcLink. It is used in an Integration to reference this VpcLink. |
Gets the VpcLinks collection under the caller's account in a selected region
Description
Gets the VpcLinks collection under the caller's account in a selected region.
See https://www.paws-r-sdk.com/docs/apigateway_get_vpc_links/ for full documentation.
Usage
apigateway_get_vpc_links(position = NULL, limit = NULL)
Arguments
position |
The current pagination position in the paged result set. |
limit |
The maximum number of returned results per page. The default value is 25 and the maximum value is 500. |
Import API keys from an external source, such as a CSV-formatted file
Description
Import API keys from an external source, such as a CSV-formatted file.
See https://www.paws-r-sdk.com/docs/apigateway_import_api_keys/ for full documentation.
Usage
apigateway_import_api_keys(body, format, failOnWarnings = NULL)
Arguments
body |
[required] The payload of the POST request to import API keys. For the payload format, see API Key File Format. |
format |
[required] A query parameter to specify the input format to imported API keys.
Currently, only the |
failOnWarnings |
A query parameter to indicate whether to rollback ApiKey importation
( |
Imports documentation parts
Description
Imports documentation parts
See https://www.paws-r-sdk.com/docs/apigateway_import_documentation_parts/ for full documentation.
Usage
apigateway_import_documentation_parts(
restApiId,
mode = NULL,
failOnWarnings = NULL,
body
)
Arguments
restApiId |
[required] The string identifier of the associated RestApi. |
mode |
A query parameter to indicate whether to overwrite ( |
failOnWarnings |
A query parameter to specify whether to rollback the documentation
importation ( |
body |
[required] Raw byte array representing the to-be-imported documentation parts. To import from an OpenAPI file, this is a JSON object. |
A feature of the API Gateway control service for creating a new API from an external API definition file
Description
A feature of the API Gateway control service for creating a new API from an external API definition file.
See https://www.paws-r-sdk.com/docs/apigateway_import_rest_api/ for full documentation.
Usage
apigateway_import_rest_api(failOnWarnings = NULL, parameters = NULL, body)
Arguments
failOnWarnings |
A query parameter to indicate whether to rollback the API creation
( |
parameters |
A key-value map of context-specific query string parameters specifying the behavior of different API importing operations. The following shows operation-specific parameters and their supported values. To exclude DocumentationParts from the import, set To configure the endpoint type, set To handle imported |
body |
[required] The POST request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 6MB. |
Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi
Description
Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.
See https://www.paws-r-sdk.com/docs/apigateway_put_gateway_response/ for full documentation.
Usage
apigateway_put_gateway_response(
restApiId,
responseType,
statusCode = NULL,
responseParameters = NULL,
responseTemplates = NULL
)
Arguments
restApiId |
[required] The string identifier of the associated RestApi. |
responseType |
[required] The response type of the associated GatewayResponse |
statusCode |
The HTTP status code of the GatewayResponse. |
responseParameters |
Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs. |
responseTemplates |
Response templates of the GatewayResponse as a string-to-string map of key-value pairs. |
Sets up a method's integration
Description
Sets up a method's integration.
See https://www.paws-r-sdk.com/docs/apigateway_put_integration/ for full documentation.
Usage
apigateway_put_integration(
restApiId,
resourceId,
httpMethod,
type,
integrationHttpMethod = NULL,
uri = NULL,
connectionType = NULL,
connectionId = NULL,
credentials = NULL,
requestParameters = NULL,
requestTemplates = NULL,
passthroughBehavior = NULL,
cacheNamespace = NULL,
cacheKeyParameters = NULL,
contentHandling = NULL,
timeoutInMillis = NULL,
tlsConfig = NULL
)
Arguments
restApiId |
[required] The string identifier of the associated RestApi. |
resourceId |
[required] Specifies a put integration request's resource ID. |
httpMethod |
[required] Specifies the HTTP method for the integration. |
type |
[required] Specifies a put integration input's type. |
integrationHttpMethod |
The HTTP method for the integration. |
uri |
Specifies Uniform Resource Identifier (URI) of the integration endpoint.
For HTTP or |
connectionType |
The type of the network connection to the integration endpoint. The
valid value is |
connectionId |
The ID of the VpcLink used for the integration. Specify this value only
if you specify |
credentials |
Specifies whether credentials are required for a put integration. |
requestParameters |
A key-value map specifying request parameters that are passed from the
method request to the back end. The key is an integration request
parameter name and the associated value is a method request parameter
value or static value that must be enclosed within single quotes and
pre-encoded as required by the back end. The method request parameter
value must match the pattern of |
requestTemplates |
Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. |
passthroughBehavior |
Specifies the pass-through behavior for incoming requests based on the
Content-Type header in the request, and the available mapping templates
specified as the |
cacheNamespace |
Specifies a group of related cached parameters. By default, API Gateway
uses the resource ID as the |
cacheKeyParameters |
A list of request parameters whose values API Gateway caches. To be
valid values for |
contentHandling |
Specifies how to handle request payload content type conversions.
Supported values are If this property is not defined, the request payload will be passed
through from the method request to integration request without
modification, provided that the |
timeoutInMillis |
Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds. |
tlsConfig |
Represents a put integration
Description
Represents a put integration.
See https://www.paws-r-sdk.com/docs/apigateway_put_integration_response/ for full documentation.
Usage
apigateway_put_integration_response(
restApiId,
resourceId,
httpMethod,
statusCode,
selectionPattern = NULL,
responseParameters = NULL,
responseTemplates = NULL,
contentHandling = NULL
)
Arguments
restApiId |
[required] The string identifier of the associated RestApi. |
resourceId |
[required] Specifies a put integration response request's resource identifier. |
httpMethod |
[required] Specifies a put integration response request's HTTP method. |
statusCode |
[required] Specifies the status code that is used to map the integration response to an existing MethodResponse. |
selectionPattern |
Specifies the selection pattern of a put integration response. |
responseParameters |
A key-value map specifying response parameters that are passed to the
method response from the back end. The key is a method response header
parameter name and the mapped value is an integration response header
value, a static value enclosed within a pair of single quotes, or a JSON
expression from the integration response body. The mapping key must
match the pattern of |
responseTemplates |
Specifies a put integration response's templates. |
contentHandling |
Specifies how to handle response payload content type conversions.
Supported values are If this property is not defined, the response payload will be passed through from the integration response to the method response without modification. |
Add a method to an existing Resource resource
Description
Add a method to an existing Resource resource.
See https://www.paws-r-sdk.com/docs/apigateway_put_method/ for full documentation.
Usage
apigateway_put_method(
restApiId,
resourceId,
httpMethod,
authorizationType,
authorizerId = NULL,
apiKeyRequired = NULL,
operationName = NULL,
requestParameters = NULL,
requestModels = NULL,
requestValidatorId = NULL,
authorizationScopes = NULL
)
Arguments
restApiId |
[required] The string identifier of the associated RestApi. |
resourceId |
[required] The Resource identifier for the new Method resource. |
httpMethod |
[required] Specifies the method request's HTTP method type. |
authorizationType |
[required] The method's authorization type. Valid values are |
authorizerId |
Specifies the identifier of an Authorizer to use on this Method, if the type is CUSTOM or COGNITO_USER_POOLS. The authorizer identifier is generated by API Gateway when you created the authorizer. |
apiKeyRequired |
Specifies whether the method required a valid ApiKey. |
operationName |
A human-friendly operation identifier for the method. For example, you
can assign the |
requestParameters |
A key-value map defining required or optional method request parameters
that can be accepted by API Gateway. A key defines a method request
parameter name matching the pattern of
|
requestModels |
Specifies the Model resources used for the request's content type. Request models are represented as a key/value map, with a content type as the key and a Model name as the value. |
requestValidatorId |
The identifier of a RequestValidator for validating the method request. |
authorizationScopes |
A list of authorization scopes configured on the method. The scopes are
used with a |
Adds a MethodResponse to an existing Method resource
Description
Adds a MethodResponse to an existing Method resource.
See https://www.paws-r-sdk.com/docs/apigateway_put_method_response/ for full documentation.
Usage
apigateway_put_method_response(
restApiId,
resourceId,
httpMethod,
statusCode,
responseParameters = NULL,
responseModels = NULL
)
Arguments
restApiId |
[required] The string identifier of the associated RestApi. |
resourceId |
[required] The Resource identifier for the Method resource. |
httpMethod |
[required] The HTTP verb of the Method resource. |
statusCode |
[required] The method response's status code. |
responseParameters |
A key-value map specifying required or optional response parameters that
API Gateway can send back to the caller. A key defines a method response
header name and the associated value is a Boolean flag indicating
whether the method response parameter is required or not. The method
response header names must match the pattern of
|
responseModels |
Specifies the Model resources used for the response's content type. Response models are represented as a key/value map, with a content type as the key and a Model name as the value. |
A feature of the API Gateway control service for updating an existing API with an input of external API definitions
Description
A feature of the API Gateway control service for updating an existing API with an input of external API definitions. The update can take the form of merging the supplied definition into the existing API or overwriting the existing API.
See https://www.paws-r-sdk.com/docs/apigateway_put_rest_api/ for full documentation.
Usage
apigateway_put_rest_api(
restApiId,
mode = NULL,
failOnWarnings = NULL,
parameters = NULL,
body
)
Arguments
restApiId |
[required] The string identifier of the associated RestApi. |
mode |
The |
failOnWarnings |
A query parameter to indicate whether to rollback the API update
( |
parameters |
Custom header parameters as part of the request. For example, to exclude
DocumentationParts from an imported API, set |
body |
[required] The PUT request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 6MB. |
Rejects a domain name access association with a private custom domain name
Description
Rejects a domain name access association with a private custom domain name.
See https://www.paws-r-sdk.com/docs/apigateway_reject_domain_name_access_association/ for full documentation.
Usage
apigateway_reject_domain_name_access_association(
domainNameAccessAssociationArn,
domainNameArn
)
Arguments
domainNameAccessAssociationArn |
[required] The ARN of the domain name access association resource. |
domainNameArn |
[required] The ARN of the domain name. |
Adds or updates a tag on a given resource
Description
Adds or updates a tag on a given resource.
See https://www.paws-r-sdk.com/docs/apigateway_tag_resource/ for full documentation.
Usage
apigateway_tag_resource(resourceArn, tags)
Arguments
resourceArn |
[required] The ARN of a resource that can be tagged. |
tags |
[required] The key-value map of strings. The valid character set is
[a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not
start with |
Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body
Description
Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.
See https://www.paws-r-sdk.com/docs/apigateway_test_invoke_authorizer/ for full documentation.
Usage
apigateway_test_invoke_authorizer(
restApiId,
authorizerId,
headers = NULL,
multiValueHeaders = NULL,
pathWithQueryString = NULL,
body = NULL,
stageVariables = NULL,
additionalContext = NULL
)
Arguments
restApiId |
[required] The string identifier of the associated RestApi. |
authorizerId |
[required] Specifies a test invoke authorizer request's Authorizer ID. |
headers |
A key-value map of headers to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, should be specified. |
multiValueHeaders |
The headers as a map from string to list of values to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, may be specified. |
pathWithQueryString |
The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters. |
body |
The simulated request body of an incoming invocation request. |
stageVariables |
A key-value map of stage variables to simulate an invocation on a deployed Stage. |
additionalContext |
A key-value map of additional context variables. |
Simulate the invocation of a Method in your RestApi with headers, parameters, and an incoming request body
Description
Simulate the invocation of a Method in your RestApi with headers, parameters, and an incoming request body.
See https://www.paws-r-sdk.com/docs/apigateway_test_invoke_method/ for full documentation.
Usage
apigateway_test_invoke_method(
restApiId,
resourceId,
httpMethod,
pathWithQueryString = NULL,
body = NULL,
headers = NULL,
multiValueHeaders = NULL,
clientCertificateId = NULL,
stageVariables = NULL
)
Arguments
restApiId |
[required] The string identifier of the associated RestApi. |
resourceId |
[required] Specifies a test invoke method request's resource ID. |
httpMethod |
[required] Specifies a test invoke method request's HTTP method. |
pathWithQueryString |
The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters. |
body |
The simulated request body of an incoming invocation request. |
headers |
A key-value map of headers to simulate an incoming invocation request. |
multiValueHeaders |
The headers as a map from string to list of values to simulate an incoming invocation request. |
clientCertificateId |
A ClientCertificate identifier to use in the test invocation. API Gateway will use the certificate when making the HTTPS request to the defined back-end endpoint. |
stageVariables |
A key-value map of stage variables to simulate an invocation on a deployed Stage. |
Removes a tag from a given resource
Description
Removes a tag from a given resource.
See https://www.paws-r-sdk.com/docs/apigateway_untag_resource/ for full documentation.
Usage
apigateway_untag_resource(resourceArn, tagKeys)
Arguments
resourceArn |
[required] The ARN of a resource that can be tagged. |
tagKeys |
[required] The Tag keys to delete. |
Changes information about the current Account resource
Description
Changes information about the current Account resource.
See https://www.paws-r-sdk.com/docs/apigateway_update_account/ for full documentation.
Usage
apigateway_update_account(patchOperations = NULL)
Arguments
patchOperations |
For more information about supported patch operations, see Patch Operations. |
Changes information about an ApiKey resource
Description
Changes information about an ApiKey resource.
See https://www.paws-r-sdk.com/docs/apigateway_update_api_key/ for full documentation.
Usage
apigateway_update_api_key(apiKey, patchOperations = NULL)
Arguments
apiKey |
[required] The identifier of the ApiKey resource to be updated. |
patchOperations |
For more information about supported patch operations, see Patch Operations. |
Updates an existing Authorizer resource
Description
Updates an existing Authorizer resource.
See https://www.paws-r-sdk.com/docs/apigateway_update_authorizer/ for full documentation.
Usage
apigateway_update_authorizer(restApiId, authorizerId, patchOperations = NULL)
Arguments
restApiId |
[required] The string identifier of the associated RestApi. |
authorizerId |
[required] The identifier of the Authorizer resource. |
patchOperations |
For more information about supported patch operations, see Patch Operations. |
Changes information about the BasePathMapping resource
Description
Changes information about the BasePathMapping resource.
See https://www.paws-r-sdk.com/docs/apigateway_update_base_path_mapping/ for full documentation.
Usage
apigateway_update_base_path_mapping(
domainName,
domainNameId = NULL,
basePath,
patchOperations = NULL
)
Arguments
domainName |
[required] The domain name of the BasePathMapping resource to change. |
domainNameId |
The identifier for the domain name resource. Supported only for private custom domain names. |
basePath |
[required] The base path of the BasePathMapping resource to change. To specify an empty base path, set this parameter to |
patchOperations |
For more information about supported patch operations, see Patch Operations. |
Changes information about an ClientCertificate resource
Description
Changes information about an ClientCertificate resource.
See https://www.paws-r-sdk.com/docs/apigateway_update_client_certificate/ for full documentation.
Usage
apigateway_update_client_certificate(
clientCertificateId,
patchOperations = NULL
)
Arguments
clientCertificateId |
[required] The identifier of the ClientCertificate resource to be updated. |
patchOperations |
For more information about supported patch operations, see Patch Operations. |
Changes information about a Deployment resource
Description
Changes information about a Deployment resource.
See https://www.paws-r-sdk.com/docs/apigateway_update_deployment/ for full documentation.
Usage
apigateway_update_deployment(restApiId, deploymentId, patchOperations = NULL)
Arguments
restApiId |
[required] The string identifier of the associated RestApi. |
deploymentId |
[required] The replacement identifier for the Deployment resource to change information about. |
patchOperations |
For more information about supported patch operations, see Patch Operations. |
Updates a documentation part
Description
Updates a documentation part.
See https://www.paws-r-sdk.com/docs/apigateway_update_documentation_part/ for full documentation.
Usage
apigateway_update_documentation_part(
restApiId,
documentationPartId,
patchOperations = NULL
)
Arguments
restApiId |
[required] The string identifier of the associated RestApi. |
documentationPartId |
[required] The identifier of the to-be-updated documentation part. |
patchOperations |
For more information about supported patch operations, see Patch Operations. |
Updates a documentation version
Description
Updates a documentation version.
See https://www.paws-r-sdk.com/docs/apigateway_update_documentation_version/ for full documentation.
Usage
apigateway_update_documentation_version(
restApiId,
documentationVersion,
patchOperations = NULL
)
Arguments
restApiId |
[required] The string identifier of the associated RestApi. |
documentationVersion |
[required] The version identifier of the to-be-updated documentation version. |
patchOperations |
For more information about supported patch operations, see Patch Operations. |
Changes information about the DomainName resource
Description
Changes information about the DomainName resource.
See https://www.paws-r-sdk.com/docs/apigateway_update_domain_name/ for full documentation.
Usage
apigateway_update_domain_name(
domainName,
domainNameId = NULL,
patchOperations = NULL
)
Arguments
domainName |
[required] The name of the DomainName resource to be changed. |
domainNameId |
The identifier for the domain name resource. Supported only for private custom domain names. |
patchOperations |
For more information about supported patch operations, see Patch Operations. |
Updates a GatewayResponse of a specified response type on the given RestApi
Description
Updates a GatewayResponse of a specified response type on the given RestApi.
See https://www.paws-r-sdk.com/docs/apigateway_update_gateway_response/ for full documentation.
Usage
apigateway_update_gateway_response(
restApiId,
responseType,
patchOperations = NULL
)
Arguments
restApiId |
[required] The string identifier of the associated RestApi. |
responseType |
[required] The response type of the associated GatewayResponse. |
patchOperations |
For more information about supported patch operations, see Patch Operations. |
Represents an update integration
Description
Represents an update integration.
See https://www.paws-r-sdk.com/docs/apigateway_update_integration/ for full documentation.
Usage
apigateway_update_integration(
restApiId,
resourceId,
httpMethod,
patchOperations = NULL
)
Arguments
restApiId |
[required] The string identifier of the associated RestApi. |
resourceId |
[required] Represents an update integration request's resource identifier. |
httpMethod |
[required] Represents an update integration request's HTTP method. |
patchOperations |
For more information about supported patch operations, see Patch Operations. |
Represents an update integration response
Description
Represents an update integration response.
See https://www.paws-r-sdk.com/docs/apigateway_update_integration_response/ for full documentation.
Usage
apigateway_update_integration_response(
restApiId,
resourceId,
httpMethod,
statusCode,
patchOperations = NULL
)
Arguments
restApiId |
[required] The string identifier of the associated RestApi. |
resourceId |
[required] Specifies an update integration response request's resource identifier. |
httpMethod |
[required] Specifies an update integration response request's HTTP method. |
statusCode |
[required] Specifies an update integration response request's status code. |
patchOperations |
For more information about supported patch operations, see Patch Operations. |
Updates an existing Method resource
Description
Updates an existing Method resource.
See https://www.paws-r-sdk.com/docs/apigateway_update_method/ for full documentation.
Usage
apigateway_update_method(
restApiId,
resourceId,
httpMethod,
patchOperations = NULL
)
Arguments
restApiId |
[required] The string identifier of the associated RestApi. |
resourceId |
[required] The Resource identifier for the Method resource. |
httpMethod |
[required] The HTTP verb of the Method resource. |
patchOperations |
For more information about supported patch operations, see Patch Operations. |
Updates an existing MethodResponse resource
Description
Updates an existing MethodResponse resource.
See https://www.paws-r-sdk.com/docs/apigateway_update_method_response/ for full documentation.
Usage
apigateway_update_method_response(
restApiId,
resourceId,
httpMethod,
statusCode,
patchOperations = NULL
)
Arguments
restApiId |
[required] The string identifier of the associated RestApi. |
resourceId |
[required] The Resource identifier for the MethodResponse resource. |
httpMethod |
[required] The HTTP verb of the Method resource. |
statusCode |
[required] The status code for the MethodResponse resource. |
patchOperations |
For more information about supported patch operations, see Patch Operations. |
Changes information about a model
Description
Changes information about a model. The maximum size of the model is 400 KB.
See https://www.paws-r-sdk.com/docs/apigateway_update_model/ for full documentation.
Usage
apigateway_update_model(restApiId, modelName, patchOperations = NULL)
Arguments
restApiId |
[required] The string identifier of the associated RestApi. |
modelName |
[required] The name of the model to update. |
patchOperations |
For more information about supported patch operations, see Patch Operations. |
Updates a RequestValidator of a given RestApi
Description
Updates a RequestValidator of a given RestApi.
See https://www.paws-r-sdk.com/docs/apigateway_update_request_validator/ for full documentation.
Usage
apigateway_update_request_validator(
restApiId,
requestValidatorId,
patchOperations = NULL
)
Arguments
restApiId |
[required] The string identifier of the associated RestApi. |
requestValidatorId |
[required] The identifier of RequestValidator to be updated. |
patchOperations |
For more information about supported patch operations, see Patch Operations. |
Changes information about a Resource resource
Description
Changes information about a Resource resource.
See https://www.paws-r-sdk.com/docs/apigateway_update_resource/ for full documentation.
Usage
apigateway_update_resource(restApiId, resourceId, patchOperations = NULL)
Arguments
restApiId |
[required] The string identifier of the associated RestApi. |
resourceId |
[required] The identifier of the Resource resource. |
patchOperations |
For more information about supported patch operations, see Patch Operations. |
Changes information about the specified API
Description
Changes information about the specified API.
See https://www.paws-r-sdk.com/docs/apigateway_update_rest_api/ for full documentation.
Usage
apigateway_update_rest_api(restApiId, patchOperations = NULL)
Arguments
restApiId |
[required] The string identifier of the associated RestApi. |
patchOperations |
For more information about supported patch operations, see Patch Operations. |
Changes information about a Stage resource
Description
Changes information about a Stage resource.
See https://www.paws-r-sdk.com/docs/apigateway_update_stage/ for full documentation.
Usage
apigateway_update_stage(restApiId, stageName, patchOperations = NULL)
Arguments
restApiId |
[required] The string identifier of the associated RestApi. |
stageName |
[required] The name of the Stage resource to change information about. |
patchOperations |
For more information about supported patch operations, see Patch Operations. |
Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key
Description
Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key.
See https://www.paws-r-sdk.com/docs/apigateway_update_usage/ for full documentation.
Usage
apigateway_update_usage(usagePlanId, keyId, patchOperations = NULL)
Arguments
usagePlanId |
[required] The Id of the usage plan associated with the usage data. |
keyId |
[required] The identifier of the API key associated with the usage plan in which a temporary extension is granted to the remaining quota. |
patchOperations |
For more information about supported patch operations, see Patch Operations. |
Updates a usage plan of a given plan Id
Description
Updates a usage plan of a given plan Id.
See https://www.paws-r-sdk.com/docs/apigateway_update_usage_plan/ for full documentation.
Usage
apigateway_update_usage_plan(usagePlanId, patchOperations = NULL)
Arguments
usagePlanId |
[required] The Id of the to-be-updated usage plan. |
patchOperations |
For more information about supported patch operations, see Patch Operations. |
Updates an existing VpcLink of a specified identifier
Description
Updates an existing VpcLink of a specified identifier.
See https://www.paws-r-sdk.com/docs/apigateway_update_vpc_link/ for full documentation.
Usage
apigateway_update_vpc_link(vpcLinkId, patchOperations = NULL)
Arguments
vpcLinkId |
[required] The identifier of the VpcLink. It is used in an Integration to reference this VpcLink. |
patchOperations |
For more information about supported patch operations, see Patch Operations. |
AmazonApiGatewayManagementApi
Description
The Amazon API Gateway Management API allows you to directly manage runtime aspects of your deployed APIs. To use it, you must explicitly set the SDK's endpoint to point to the endpoint of your deployed API. The endpoint will be of the form https://{api-id}.execute-api.{region}.amazonaws.com/{stage}, or will be the endpoint corresponding to your API's custom domain and base path, if applicable.
Usage
apigatewaymanagementapi(
config = list(),
credentials = list(),
endpoint = NULL,
region = NULL
)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...)
, where svc
is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- apigatewaymanagementapi( config = list( credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string", close_connection = "logical", timeout = "numeric", s3_force_path_style = "logical", sts_regional_endpoint = "string" ), credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string" )
Operations
delete_connection | Delete the connection with the provided id |
get_connection | Get information about the connection with the provided id |
post_to_connection | Sends the provided data to the specified connection |
Examples
## Not run:
svc <- apigatewaymanagementapi()
svc$delete_connection(
Foo = 123
)
## End(Not run)
Delete the connection with the provided id
Description
Delete the connection with the provided id.
See https://www.paws-r-sdk.com/docs/apigatewaymanagementapi_delete_connection/ for full documentation.
Usage
apigatewaymanagementapi_delete_connection(ConnectionId)
Arguments
ConnectionId |
[required] |
Get information about the connection with the provided id
Description
Get information about the connection with the provided id.
See https://www.paws-r-sdk.com/docs/apigatewaymanagementapi_get_connection/ for full documentation.
Usage
apigatewaymanagementapi_get_connection(ConnectionId)
Arguments
ConnectionId |
[required] |
Sends the provided data to the specified connection
Description
Sends the provided data to the specified connection.
See https://www.paws-r-sdk.com/docs/apigatewaymanagementapi_post_to_connection/ for full documentation.
Usage
apigatewaymanagementapi_post_to_connection(Data, ConnectionId)
Arguments
Data |
[required] The data to be sent to the client specified by its connection id. |
ConnectionId |
[required] The identifier of the connection that a specific client is using. |
AmazonApiGatewayV2
Description
Amazon API Gateway V2
Usage
apigatewayv2(
config = list(),
credentials = list(),
endpoint = NULL,
region = NULL
)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...)
, where svc
is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- apigatewayv2( config = list( credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string", close_connection = "logical", timeout = "numeric", s3_force_path_style = "logical", sts_regional_endpoint = "string" ), credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string" )
Operations
create_api | Creates an Api resource |
create_api_mapping | Creates an API mapping |
create_authorizer | Creates an Authorizer for an API |
create_deployment | Creates a Deployment for an API |
create_domain_name | Creates a domain name |
create_integration | Creates an Integration |
create_integration_response | Creates an IntegrationResponses |
create_model | Creates a Model for an API |
create_route | Creates a Route for an API |
create_route_response | Creates a RouteResponse for a Route |
create_stage | Creates a Stage for an API |
create_vpc_link | Creates a VPC link |
delete_access_log_settings | Deletes the AccessLogSettings for a Stage |
delete_api | Deletes an Api resource |
delete_api_mapping | Deletes an API mapping |
delete_authorizer | Deletes an Authorizer |
delete_cors_configuration | Deletes a CORS configuration |
delete_deployment | Deletes a Deployment |
delete_domain_name | Deletes a domain name |
delete_integration | Deletes an Integration |
delete_integration_response | Deletes an IntegrationResponses |
delete_model | Deletes a Model |
delete_route | Deletes a Route |
delete_route_request_parameter | Deletes a route request parameter |
delete_route_response | Deletes a RouteResponse |
delete_route_settings | Deletes the RouteSettings for a stage |
delete_stage | Deletes a Stage |
delete_vpc_link | Deletes a VPC link |
export_api | Export api |
get_api | Gets an Api resource |
get_api_mapping | Gets an API mapping |
get_api_mappings | Gets API mappings |
get_apis | Gets a collection of Api resources |
get_authorizer | Gets an Authorizer |
get_authorizers | Gets the Authorizers for an API |
get_deployment | Gets a Deployment |
get_deployments | Gets the Deployments for an API |
get_domain_name | Gets a domain name |
get_domain_names | Gets the domain names for an AWS account |
get_integration | Gets an Integration |
get_integration_response | Gets an IntegrationResponses |
get_integration_responses | Gets the IntegrationResponses for an Integration |
get_integrations | Gets the Integrations for an API |
get_model | Gets a Model |
get_models | Gets the Models for an API |
get_model_template | Gets a model template |
get_route | Gets a Route |
get_route_response | Gets a RouteResponse |
get_route_responses | Gets the RouteResponses for a Route |
get_routes | Gets the Routes for an API |
get_stage | Gets a Stage |
get_stages | Gets the Stages for an API |
get_tags | Gets a collection of Tag resources |
get_vpc_link | Gets a VPC link |
get_vpc_links | Gets a collection of VPC links |
import_api | Imports an API |
reimport_api | Puts an Api resource |
reset_authorizers_cache | Resets all authorizer cache entries on a stage |
tag_resource | Creates a new Tag resource to represent a tag |
untag_resource | Deletes a Tag |
update_api | Updates an Api resource |
update_api_mapping | The API mapping |
update_authorizer | Updates an Authorizer |
update_deployment | Updates a Deployment |
update_domain_name | Updates a domain name |
update_integration | Updates an Integration |
update_integration_response | Updates an IntegrationResponses |
update_model | Updates a Model |
update_route | Updates a Route |
update_route_response | Updates a RouteResponse |
update_stage | Updates a Stage |
update_vpc_link | Updates a VPC link |
Examples
## Not run:
svc <- apigatewayv2()
svc$create_api(
Foo = 123
)
## End(Not run)
Creates an Api resource
Description
Creates an Api resource.
See https://www.paws-r-sdk.com/docs/apigatewayv2_create_api/ for full documentation.
Usage
apigatewayv2_create_api(
ApiKeySelectionExpression = NULL,
CorsConfiguration = NULL,
CredentialsArn = NULL,
Description = NULL,
DisableSchemaValidation = NULL,
DisableExecuteApiEndpoint = NULL,
Name,
ProtocolType,
RouteKey = NULL,
RouteSelectionExpression = NULL,
Tags = NULL,
Target = NULL,
Version = NULL
)
Arguments
ApiKeySelectionExpression |
An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions. |
CorsConfiguration |
A CORS configuration. Supported only for HTTP APIs. See Configuring CORS for more information. |
CredentialsArn |
This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify arn:aws:iam:::user/. To use resource-based permissions on supported AWS services, specify null. Currently, this property is not used for HTTP integrations. Supported only for HTTP APIs. |
Description |
The description of the API. |
DisableSchemaValidation |
Avoid validating models when creating a deployment. Supported only for WebSocket APIs. |
DisableExecuteApiEndpoint |
Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint. |
Name |
[required] The name of the API. |
ProtocolType |
[required] The API protocol. |
RouteKey |
This property is part of quick create. If you don't specify a routeKey, a default route of $default is created. The $default route acts as a catch-all for any request made to your API, for a particular stage. The $default route key can't be modified. You can add routes after creating the API, and you can update the route keys of additional routes. Supported only for HTTP APIs. |
RouteSelectionExpression |
The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs. |
Tags |
The collection of tags. Each tag element is associated with a given resource. |
Target |
This property is part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. Supported only for HTTP APIs. |
Version |
A version identifier for the API. |
Creates an API mapping
Description
Creates an API mapping.
See https://www.paws-r-sdk.com/docs/apigatewayv2_create_api_mapping/ for full documentation.
Usage
apigatewayv2_create_api_mapping(ApiId, ApiMappingKey = NULL, DomainName, Stage)
Arguments
ApiId |
[required] The API identifier. |
ApiMappingKey |
The API mapping key. |
DomainName |
[required] The domain name. |
Stage |
[required] The API stage. |
Creates an Authorizer for an API
Description
Creates an Authorizer for an API.
See https://www.paws-r-sdk.com/docs/apigatewayv2_create_authorizer/ for full documentation.
Usage
apigatewayv2_create_authorizer(
ApiId,
AuthorizerCredentialsArn = NULL,
AuthorizerPayloadFormatVersion = NULL,
AuthorizerResultTtlInSeconds = NULL,
AuthorizerType,
AuthorizerUri = NULL,
EnableSimpleResponses = NULL,
IdentitySource,
IdentityValidationExpression = NULL,
JwtConfiguration = NULL,
Name
)
Arguments
ApiId |
[required] The API identifier. |
AuthorizerCredentialsArn |
Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don't specify this parameter. Supported only for REQUEST authorizers. |
AuthorizerPayloadFormatVersion |
Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see Working with AWS Lambda authorizers for HTTP APIs. |
AuthorizerResultTtlInSeconds |
The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers. |
AuthorizerType |
[required] The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs). |
AuthorizerUri |
The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form: arn:aws:apigateway:{region}:lambda:path/{service_api} , where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers. |
EnableSimpleResponses |
Specifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see Working with AWS Lambda authorizers for HTTP APIs |
IdentitySource |
[required] The identity source for which authorization is requested. For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs. For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization. |
IdentityValidationExpression |
This parameter is not used. |
JwtConfiguration |
Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs. |
Name |
[required] The name of the authorizer. |
Creates a Deployment for an API
Description
Creates a Deployment for an API.
See https://www.paws-r-sdk.com/docs/apigatewayv2_create_deployment/ for full documentation.
Usage
apigatewayv2_create_deployment(ApiId, Description = NULL, StageName = NULL)
Arguments
ApiId |
[required] The API identifier. |
Description |
The description for the deployment resource. |
StageName |
The name of the Stage resource for the Deployment resource to create. |
Creates a domain name
Description
Creates a domain name.
See https://www.paws-r-sdk.com/docs/apigatewayv2_create_domain_name/ for full documentation.
Usage
apigatewayv2_create_domain_name(
DomainName,
DomainNameConfigurations = NULL,
MutualTlsAuthentication = NULL,
Tags = NULL
)
Arguments
DomainName |
[required] The domain name. |
DomainNameConfigurations |
The domain name configurations. |
MutualTlsAuthentication |
The mutual TLS authentication configuration for a custom domain name. |
Tags |
The collection of tags associated with a domain name. |
Creates an Integration
Description
Creates an Integration.
See https://www.paws-r-sdk.com/docs/apigatewayv2_create_integration/ for full documentation.
Usage
apigatewayv2_create_integration(
ApiId,
ConnectionId = NULL,
ConnectionType = NULL,
ContentHandlingStrategy = NULL,
CredentialsArn = NULL,
Description = NULL,
IntegrationMethod = NULL,
IntegrationSubtype = NULL,
IntegrationType,
IntegrationUri = NULL,
PassthroughBehavior = NULL,
PayloadFormatVersion = NULL,
RequestParameters = NULL,
RequestTemplates = NULL,
ResponseParameters = NULL,
TemplateSelectionExpression = NULL,
TimeoutInMillis = NULL,
TlsConfig = NULL
)
Arguments
ApiId |
[required] The API identifier. |
ConnectionId |
The ID of the VPC link for a private integration. Supported only for HTTP APIs. |
ConnectionType |
The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET. |
ContentHandlingStrategy |
Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors: CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob. CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string. If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification. |
CredentialsArn |
Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam:::user/. To use resource-based permissions on supported AWS services, specify null. |
Description |
The description of the integration. |
IntegrationMethod |
Specifies the integration's HTTP method type. |
IntegrationSubtype |
Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference. |
IntegrationType |
[required] The integration type of an integration. One of the following: AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs. AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration. HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs. HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration. For HTTP API private integrations, use an HTTP_PROXY integration. MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs. |
IntegrationUri |
For a Lambda integration, specify the URI of a Lambda function. For an HTTP integration, specify a fully-qualified URL. For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account. |
PassthroughBehavior |
Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs. WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation. NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response. WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response. |
PayloadFormatVersion |
Specifies the format of the payload sent to an integration. Required for HTTP APIs. Supported values for Lambda proxy integrations are 1.0 and 2.0. For all other integrations, 1.0 is the only supported value. To learn more, see Working with AWS Lambda proxy integrations for HTTP APIs. |
RequestParameters |
For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.{location}.{name} , where {location} is querystring, path, or header; and {name} must be a valid and unique method request parameter name. For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs. For HTTP API integrations without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to the backend. The key should follow the pattern \<action\>:\<header|querystring|path\>.\<location\> where action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses. |
RequestTemplates |
Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs. |
ResponseParameters |
Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern \<action\>:\<header\>.\<location\> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses. |
TemplateSelectionExpression |
The template selection expression for the integration. |
TimeoutInMillis |
Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs. |
TlsConfig |
The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs. |
Creates an IntegrationResponses
Description
Creates an IntegrationResponses.
See https://www.paws-r-sdk.com/docs/apigatewayv2_create_integration_response/ for full documentation.
Usage
apigatewayv2_create_integration_response(
ApiId,
ContentHandlingStrategy = NULL,
IntegrationId,
IntegrationResponseKey,
ResponseParameters = NULL,
ResponseTemplates = NULL,
TemplateSelectionExpression = NULL
)
Arguments
ApiId |
[required] The API identifier. |
ContentHandlingStrategy |
Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors: CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob. CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string. If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification. |
IntegrationId |
[required] The integration ID. |
IntegrationResponseKey |
[required] The integration response key. |
ResponseParameters |
A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where {name} is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where {name} is a valid and unique response header name and {JSON-expression} is a valid JSON expression without the $ prefix. |
ResponseTemplates |
The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value. |
TemplateSelectionExpression |
The template selection expression for the integration response. Supported only for WebSocket APIs. |
Creates a Model for an API
Description
Creates a Model for an API.
See https://www.paws-r-sdk.com/docs/apigatewayv2_create_model/ for full documentation.
Usage
apigatewayv2_create_model(
ApiId,
ContentType = NULL,
Description = NULL,
Name,
Schema
)
Arguments
ApiId |
[required] The API identifier. |
ContentType |
The content-type for the model, for example, "application/json". |
Description |
The description of the model. |
Name |
[required] The name of the model. Must be alphanumeric. |
Schema |
[required] The schema for the model. For application/json models, this should be JSON schema draft 4 model. |
Creates a Route for an API
Description
Creates a Route for an API.
See https://www.paws-r-sdk.com/docs/apigatewayv2_create_route/ for full documentation.
Usage
apigatewayv2_create_route(
ApiId,
ApiKeyRequired = NULL,
AuthorizationScopes = NULL,
AuthorizationType = NULL,
AuthorizerId = NULL,
ModelSelectionExpression = NULL,
OperationName = NULL,
RequestModels = NULL,
RequestParameters = NULL,
RouteKey,
RouteResponseSelectionExpression = NULL,
Target = NULL
)
Arguments
ApiId |
[required] The API identifier. |
ApiKeyRequired |
Specifies whether an API key is required for the route. Supported only for WebSocket APIs. |
AuthorizationScopes |
The authorization scopes supported by this route. |
AuthorizationType |
The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer. |
AuthorizerId |
The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer. |
ModelSelectionExpression |
The model selection expression for the route. Supported only for WebSocket APIs. |
OperationName |
The operation name for the route. |
RequestModels |
The request models for the route. Supported only for WebSocket APIs. |
RequestParameters |
The request parameters for the route. Supported only for WebSocket APIs. |
RouteKey |
[required] The route key for the route. |
RouteResponseSelectionExpression |
The route response selection expression for the route. Supported only for WebSocket APIs. |
Target |
The target for the route. |
Creates a RouteResponse for a Route
Description
Creates a RouteResponse for a Route.
See https://www.paws-r-sdk.com/docs/apigatewayv2_create_route_response/ for full documentation.
Usage
apigatewayv2_create_route_response(
ApiId,
ModelSelectionExpression = NULL,
ResponseModels = NULL,
ResponseParameters = NULL,
RouteId,
RouteResponseKey
)
Arguments
ApiId |
[required] The API identifier. |
ModelSelectionExpression |
The model selection expression for the route response. Supported only for WebSocket APIs. |
ResponseModels |
The response models for the route response. |
ResponseParameters |
The route response parameters. |
RouteId |
[required] The route ID. |
RouteResponseKey |
[required] The route response key. |
Creates a Stage for an API
Description
Creates a Stage for an API.
See https://www.paws-r-sdk.com/docs/apigatewayv2_create_stage/ for full documentation.
Usage
apigatewayv2_create_stage(
AccessLogSettings = NULL,
ApiId,
AutoDeploy = NULL,
ClientCertificateId = NULL,
DefaultRouteSettings = NULL,
DeploymentId = NULL,
Description = NULL,
RouteSettings = NULL,
StageName,
StageVariables = NULL,
Tags = NULL
)
Arguments
AccessLogSettings |
Settings for logging access in this stage. |
ApiId |
[required] The API identifier. |
AutoDeploy |
Specifies whether updates to an API automatically trigger a new deployment. The default value is false. |
ClientCertificateId |
The identifier of a client certificate for a Stage. Supported only for WebSocket APIs. |
DefaultRouteSettings |
The default route settings for the stage. |
DeploymentId |
The deployment identifier of the API stage. |
Description |
The description for the API stage. |
RouteSettings |
Route settings for the stage, by routeKey. |
StageName |
[required] The name of the stage. |
StageVariables |
A map that defines the stage variables for a Stage. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+. |
Tags |
The collection of tags. Each tag element is associated with a given resource. |
Creates a VPC link
Description
Creates a VPC link.
See https://www.paws-r-sdk.com/docs/apigatewayv2_create_vpc_link/ for full documentation.
Usage
apigatewayv2_create_vpc_link(
Name,
SecurityGroupIds = NULL,
SubnetIds,
Tags = NULL
)
Arguments
Name |
[required] The name of the VPC link. |
SecurityGroupIds |
A list of security group IDs for the VPC link. |
SubnetIds |
[required] A list of subnet IDs to include in the VPC link. |
Tags |
A list of tags. |
Deletes the AccessLogSettings for a Stage
Description
Deletes the AccessLogSettings for a Stage. To disable access logging for a Stage, delete its AccessLogSettings.
See https://www.paws-r-sdk.com/docs/apigatewayv2_delete_access_log_settings/ for full documentation.
Usage
apigatewayv2_delete_access_log_settings(ApiId, StageName)
Arguments
ApiId |
[required] The API identifier. |
StageName |
[required] The stage name. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters. |
Deletes an Api resource
Description
Deletes an Api resource.
See https://www.paws-r-sdk.com/docs/apigatewayv2_delete_api/ for full documentation.
Usage
apigatewayv2_delete_api(ApiId)
Arguments
ApiId |
[required] The API identifier. |
Deletes an API mapping
Description
Deletes an API mapping.
See https://www.paws-r-sdk.com/docs/apigatewayv2_delete_api_mapping/ for full documentation.
Usage
apigatewayv2_delete_api_mapping(ApiMappingId, DomainName)
Arguments
ApiMappingId |
[required] The API mapping identifier. |
DomainName |
[required] The domain name. |
Deletes an Authorizer
Description
Deletes an Authorizer.
See https://www.paws-r-sdk.com/docs/apigatewayv2_delete_authorizer/ for full documentation.
Usage
apigatewayv2_delete_authorizer(ApiId, AuthorizerId)
Arguments
ApiId |
[required] The API identifier. |
AuthorizerId |
[required] The authorizer identifier. |
Deletes a CORS configuration
Description
Deletes a CORS configuration.
See https://www.paws-r-sdk.com/docs/apigatewayv2_delete_cors_configuration/ for full documentation.
Usage
apigatewayv2_delete_cors_configuration(ApiId)
Arguments
ApiId |
[required] The API identifier. |
Deletes a Deployment
Description
Deletes a Deployment.
See https://www.paws-r-sdk.com/docs/apigatewayv2_delete_deployment/ for full documentation.
Usage
apigatewayv2_delete_deployment(ApiId, DeploymentId)
Arguments
ApiId |
[required] The API identifier. |
DeploymentId |
[required] The deployment ID. |
Deletes a domain name
Description
Deletes a domain name.
See https://www.paws-r-sdk.com/docs/apigatewayv2_delete_domain_name/ for full documentation.
Usage
apigatewayv2_delete_domain_name(DomainName)
Arguments
DomainName |
[required] The domain name. |
Deletes an Integration
Description
Deletes an Integration.
See https://www.paws-r-sdk.com/docs/apigatewayv2_delete_integration/ for full documentation.
Usage
apigatewayv2_delete_integration(ApiId, IntegrationId)
Arguments
ApiId |
[required] The API identifier. |
IntegrationId |
[required] The integration ID. |
Deletes an IntegrationResponses
Description
Deletes an IntegrationResponses.
See https://www.paws-r-sdk.com/docs/apigatewayv2_delete_integration_response/ for full documentation.
Usage
apigatewayv2_delete_integration_response(
ApiId,
IntegrationId,
IntegrationResponseId
)
Arguments
ApiId |
[required] The API identifier. |
IntegrationId |
[required] The integration ID. |
IntegrationResponseId |
[required] The integration response ID. |
Deletes a Model
Description
Deletes a Model.
See https://www.paws-r-sdk.com/docs/apigatewayv2_delete_model/ for full documentation.
Usage
apigatewayv2_delete_model(ApiId, ModelId)
Arguments
ApiId |
[required] The API identifier. |
ModelId |
[required] The model ID. |
Deletes a Route
Description
Deletes a Route.
See https://www.paws-r-sdk.com/docs/apigatewayv2_delete_route/ for full documentation.
Usage
apigatewayv2_delete_route(ApiId, RouteId)
Arguments
ApiId |
[required] The API identifier. |
RouteId |
[required] The route ID. |
Deletes a route request parameter
Description
Deletes a route request parameter. Supported only for WebSocket APIs.
See https://www.paws-r-sdk.com/docs/apigatewayv2_delete_route_request_parameter/ for full documentation.
Usage
apigatewayv2_delete_route_request_parameter(
ApiId,
RequestParameterKey,
RouteId
)
Arguments
ApiId |
[required] The API identifier. |
RequestParameterKey |
[required] The route request parameter key. |
RouteId |
[required] The route ID. |
Deletes a RouteResponse
Description
Deletes a RouteResponse.
See https://www.paws-r-sdk.com/docs/apigatewayv2_delete_route_response/ for full documentation.
Usage
apigatewayv2_delete_route_response(ApiId, RouteId, RouteResponseId)
Arguments
ApiId |
[required] The API identifier. |
RouteId |
[required] The route ID. |
RouteResponseId |
[required] The route response ID. |
Deletes the RouteSettings for a stage
Description
Deletes the RouteSettings for a stage.
See https://www.paws-r-sdk.com/docs/apigatewayv2_delete_route_settings/ for full documentation.
Usage
apigatewayv2_delete_route_settings(ApiId, RouteKey, StageName)
Arguments
ApiId |
[required] The API identifier. |
RouteKey |
[required] The route key. |
StageName |
[required] The stage name. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters. |
Deletes a Stage
Description
Deletes a Stage.
See https://www.paws-r-sdk.com/docs/apigatewayv2_delete_stage/ for full documentation.
Usage
apigatewayv2_delete_stage(ApiId, StageName)
Arguments
ApiId |
[required] The API identifier. |
StageName |
[required] The stage name. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters. |
Deletes a VPC link
Description
Deletes a VPC link.
See https://www.paws-r-sdk.com/docs/apigatewayv2_delete_vpc_link/ for full documentation.
Usage
apigatewayv2_delete_vpc_link(VpcLinkId)
Arguments
VpcLinkId |
[required] The ID of the VPC link. |
Export api
Description
Export api
See https://www.paws-r-sdk.com/docs/apigatewayv2_export_api/ for full documentation.
Usage
apigatewayv2_export_api(
ApiId,
ExportVersion = NULL,
IncludeExtensions = NULL,
OutputType,
Specification,
StageName = NULL
)
Arguments
ApiId |
[required] The API identifier. |
ExportVersion |
The version of the API Gateway export algorithm. API Gateway uses the latest version by default. Currently, the only supported version is 1.0. |
IncludeExtensions |
Specifies whether to include API Gateway extensions in the exported API definition. API Gateway extensions are included by default. |
OutputType |
[required] The output type of the exported definition file. Valid values are JSON and YAML. |
Specification |
[required] The version of the API specification to use. OAS30, for OpenAPI 3.0, is the only supported value. |
StageName |
The name of the API stage to export. If you don't specify this property, a representation of the latest API configuration is exported. |
Gets an Api resource
Description
Gets an Api resource.
See https://www.paws-r-sdk.com/docs/apigatewayv2_get_api/ for full documentation.
Usage
apigatewayv2_get_api(ApiId)
Arguments
ApiId |
[required] The API identifier. |
Gets an API mapping
Description
Gets an API mapping.
See https://www.paws-r-sdk.com/docs/apigatewayv2_get_api_mapping/ for full documentation.
Usage
apigatewayv2_get_api_mapping(ApiMappingId, DomainName)
Arguments
ApiMappingId |
[required] The API mapping identifier. |
DomainName |
[required] The domain name. |
Gets API mappings
Description
Gets API mappings.
See https://www.paws-r-sdk.com/docs/apigatewayv2_get_api_mappings/ for full documentation.
Usage
apigatewayv2_get_api_mappings(DomainName, MaxResults = NULL, NextToken = NULL)
Arguments
DomainName |
[required] The domain name. |
MaxResults |
The maximum number of elements to be returned for this resource. |
NextToken |
The next page of elements from this collection. Not valid for the last element of the collection. |
Gets a collection of Api resources
Description
Gets a collection of Api resources.
See https://www.paws-r-sdk.com/docs/apigatewayv2_get_apis/ for full documentation.
Usage
apigatewayv2_get_apis(MaxResults = NULL, NextToken = NULL)
Arguments
MaxResults |
The maximum number of elements to be returned for this resource. |
NextToken |
The next page of elements from this collection. Not valid for the last element of the collection. |
Gets an Authorizer
Description
Gets an Authorizer.
See https://www.paws-r-sdk.com/docs/apigatewayv2_get_authorizer/ for full documentation.
Usage
apigatewayv2_get_authorizer(ApiId, AuthorizerId)
Arguments
ApiId |
[required] The API identifier. |
AuthorizerId |
[required] The authorizer identifier. |
Gets the Authorizers for an API
Description
Gets the Authorizers for an API.
See https://www.paws-r-sdk.com/docs/apigatewayv2_get_authorizers/ for full documentation.
Usage
apigatewayv2_get_authorizers(ApiId, MaxResults = NULL, NextToken = NULL)
Arguments
ApiId |
[required] The API identifier. |
MaxResults |
The maximum number of elements to be returned for this resource. |
NextToken |
The next page of elements from this collection. Not valid for the last element of the collection. |
Gets a Deployment
Description
Gets a Deployment.
See https://www.paws-r-sdk.com/docs/apigatewayv2_get_deployment/ for full documentation.
Usage
apigatewayv2_get_deployment(ApiId, DeploymentId)
Arguments
ApiId |
[required] The API identifier. |
DeploymentId |
[required] The deployment ID. |
Gets the Deployments for an API
Description
Gets the Deployments for an API.
See https://www.paws-r-sdk.com/docs/apigatewayv2_get_deployments/ for full documentation.
Usage
apigatewayv2_get_deployments(ApiId, MaxResults = NULL, NextToken = NULL)
Arguments
ApiId |
[required] The API identifier. |
MaxResults |
The maximum number of elements to be returned for this resource. |
NextToken |
The next page of elements from this collection. Not valid for the last element of the collection. |
Gets a domain name
Description
Gets a domain name.
See https://www.paws-r-sdk.com/docs/apigatewayv2_get_domain_name/ for full documentation.
Usage
apigatewayv2_get_domain_name(DomainName)
Arguments
DomainName |
[required] The domain name. |
Gets the domain names for an AWS account
Description
Gets the domain names for an AWS account.
See https://www.paws-r-sdk.com/docs/apigatewayv2_get_domain_names/ for full documentation.
Usage
apigatewayv2_get_domain_names(MaxResults = NULL, NextToken = NULL)
Arguments
MaxResults |
The maximum number of elements to be returned for this resource. |
NextToken |
The next page of elements from this collection. Not valid for the last element of the collection. |
Gets an Integration
Description
Gets an Integration.
See https://www.paws-r-sdk.com/docs/apigatewayv2_get_integration/ for full documentation.
Usage
apigatewayv2_get_integration(ApiId, IntegrationId)
Arguments
ApiId |
[required] The API identifier. |
IntegrationId |
[required] The integration ID. |
Gets an IntegrationResponses
Description
Gets an IntegrationResponses.
See https://www.paws-r-sdk.com/docs/apigatewayv2_get_integration_response/ for full documentation.
Usage
apigatewayv2_get_integration_response(
ApiId,
IntegrationId,
IntegrationResponseId
)
Arguments
ApiId |
[required] The API identifier. |
IntegrationId |
[required] The integration ID. |
IntegrationResponseId |
[required] The integration response ID. |
Gets the IntegrationResponses for an Integration
Description
Gets the IntegrationResponses for an Integration.
See https://www.paws-r-sdk.com/docs/apigatewayv2_get_integration_responses/ for full documentation.
Usage
apigatewayv2_get_integration_responses(
ApiId,
IntegrationId,
MaxResults = NULL,
NextToken = NULL
)
Arguments
ApiId |
[required] The API identifier. |
IntegrationId |
[required] The integration ID. |
MaxResults |
The maximum number of elements to be returned for this resource. |
NextToken |
The next page of elements from this collection. Not valid for the last element of the collection. |
Gets the Integrations for an API
Description
Gets the Integrations for an API.
See https://www.paws-r-sdk.com/docs/apigatewayv2_get_integrations/ for full documentation.
Usage
apigatewayv2_get_integrations(ApiId, MaxResults = NULL, NextToken = NULL)
Arguments
ApiId |
[required] The API identifier. |
MaxResults |
The maximum number of elements to be returned for this resource. |
NextToken |
The next page of elements from this collection. Not valid for the last element of the collection. |
Gets a Model
Description
Gets a Model.
See https://www.paws-r-sdk.com/docs/apigatewayv2_get_model/ for full documentation.
Usage
apigatewayv2_get_model(ApiId, ModelId)
Arguments
ApiId |
[required] The API identifier. |
ModelId |
[required] The model ID. |
Gets a model template
Description
Gets a model template.
See https://www.paws-r-sdk.com/docs/apigatewayv2_get_model_template/ for full documentation.
Usage
apigatewayv2_get_model_template(ApiId, ModelId)
Arguments
ApiId |
[required] The API identifier. |
ModelId |
[required] The model ID. |
Gets the Models for an API
Description
Gets the Models for an API.
See https://www.paws-r-sdk.com/docs/apigatewayv2_get_models/ for full documentation.
Usage
apigatewayv2_get_models(ApiId, MaxResults = NULL, NextToken = NULL)
Arguments
ApiId |
[required] The API identifier. |
MaxResults |
The maximum number of elements to be returned for this resource. |
NextToken |
The next page of elements from this collection. Not valid for the last element of the collection. |
Gets a Route
Description
Gets a Route.
See https://www.paws-r-sdk.com/docs/apigatewayv2_get_route/ for full documentation.
Usage
apigatewayv2_get_route(ApiId, RouteId)
Arguments
ApiId |
[required] The API identifier. |
RouteId |
[required] The route ID. |
Gets a RouteResponse
Description
Gets a RouteResponse.
See https://www.paws-r-sdk.com/docs/apigatewayv2_get_route_response/ for full documentation.
Usage
apigatewayv2_get_route_response(ApiId, RouteId, RouteResponseId)
Arguments
ApiId |
[required] The API identifier. |
RouteId |
[required] The route ID. |
RouteResponseId |
[required] The route response ID. |
Gets the RouteResponses for a Route
Description
Gets the RouteResponses for a Route.
See https://www.paws-r-sdk.com/docs/apigatewayv2_get_route_responses/ for full documentation.
Usage
apigatewayv2_get_route_responses(
ApiId,
MaxResults = NULL,
NextToken = NULL,
RouteId
)
Arguments
ApiId |
[required] The API identifier. |
MaxResults |
The maximum number of elements to be returned for this resource. |
NextToken |
The next page of elements from this collection. Not valid for the last element of the collection. |
RouteId |
[required] The route ID. |
Gets the Routes for an API
Description
Gets the Routes for an API.
See https://www.paws-r-sdk.com/docs/apigatewayv2_get_routes/ for full documentation.
Usage
apigatewayv2_get_routes(ApiId, MaxResults = NULL, NextToken = NULL)
Arguments
ApiId |
[required] The API identifier. |
MaxResults |
The maximum number of elements to be returned for this resource. |
NextToken |
The next page of elements from this collection. Not valid for the last element of the collection. |
Gets a Stage
Description
Gets a Stage.
See https://www.paws-r-sdk.com/docs/apigatewayv2_get_stage/ for full documentation.
Usage
apigatewayv2_get_stage(ApiId, StageName)
Arguments
ApiId |
[required] The API identifier. |
StageName |
[required] The stage name. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters. |
Gets the Stages for an API
Description
Gets the Stages for an API.
See https://www.paws-r-sdk.com/docs/apigatewayv2_get_stages/ for full documentation.
Usage
apigatewayv2_get_stages(ApiId, MaxResults = NULL, NextToken = NULL)
Arguments
ApiId |
[required] The API identifier. |
MaxResults |
The maximum number of elements to be returned for this resource. |
NextToken |
The next page of elements from this collection. Not valid for the last element of the collection. |
Gets a collection of Tag resources
Description
Gets a collection of Tag resources.
See https://www.paws-r-sdk.com/docs/apigatewayv2_get_tags/ for full documentation.
Usage
apigatewayv2_get_tags(ResourceArn)
Arguments
ResourceArn |
[required] The resource ARN for the tag. |
Gets a VPC link
Description
Gets a VPC link.
See https://www.paws-r-sdk.com/docs/apigatewayv2_get_vpc_link/ for full documentation.
Usage
apigatewayv2_get_vpc_link(VpcLinkId)
Arguments
VpcLinkId |
[required] The ID of the VPC link. |
Gets a collection of VPC links
Description
Gets a collection of VPC links.
See https://www.paws-r-sdk.com/docs/apigatewayv2_get_vpc_links/ for full documentation.
Usage
apigatewayv2_get_vpc_links(MaxResults = NULL, NextToken = NULL)
Arguments
MaxResults |
The maximum number of elements to be returned for this resource. |
NextToken |
The next page of elements from this collection. Not valid for the last element of the collection. |
Imports an API
Description
Imports an API.
See https://www.paws-r-sdk.com/docs/apigatewayv2_import_api/ for full documentation.
Usage
apigatewayv2_import_api(Basepath = NULL, Body, FailOnWarnings = NULL)
Arguments
Basepath |
Specifies how to interpret the base path of the API during import. Valid values are ignore, prepend, and split. The default value is ignore. To learn more, see Set the OpenAPI basePath Property. Supported only for HTTP APIs. |
Body |
[required] The OpenAPI definition. Supported only for HTTP APIs. |
FailOnWarnings |
Specifies whether to rollback the API creation when a warning is encountered. By default, API creation continues if a warning is encountered. |
Puts an Api resource
Description
Puts an Api resource.
See https://www.paws-r-sdk.com/docs/apigatewayv2_reimport_api/ for full documentation.
Usage
apigatewayv2_reimport_api(ApiId, Basepath = NULL, Body, FailOnWarnings = NULL)
Arguments
ApiId |
[required] The API identifier. |
Basepath |
Specifies how to interpret the base path of the API during import. Valid values are ignore, prepend, and split. The default value is ignore. To learn more, see Set the OpenAPI basePath Property. Supported only for HTTP APIs. |
Body |
[required] The OpenAPI definition. Supported only for HTTP APIs. |
FailOnWarnings |
Specifies whether to rollback the API creation when a warning is encountered. By default, API creation continues if a warning is encountered. |
Resets all authorizer cache entries on a stage
Description
Resets all authorizer cache entries on a stage. Supported only for HTTP APIs.
See https://www.paws-r-sdk.com/docs/apigatewayv2_reset_authorizers_cache/ for full documentation.
Usage
apigatewayv2_reset_authorizers_cache(ApiId, StageName)
Arguments
ApiId |
[required] The API identifier. |
StageName |
[required] The stage name. Stage names can contain only alphanumeric characters, hyphens, and underscores, or be $default. Maximum length is 128 characters. |
Creates a new Tag resource to represent a tag
Description
Creates a new Tag resource to represent a tag.
See https://www.paws-r-sdk.com/docs/apigatewayv2_tag_resource/ for full documentation.
Usage
apigatewayv2_tag_resource(ResourceArn, Tags = NULL)
Arguments
ResourceArn |
[required] The resource ARN for the tag. |
Tags |
The collection of tags. Each tag element is associated with a given resource. |
Deletes a Tag
Description
Deletes a Tag.
See https://www.paws-r-sdk.com/docs/apigatewayv2_untag_resource/ for full documentation.
Usage
apigatewayv2_untag_resource(ResourceArn, TagKeys)
Arguments
ResourceArn |
[required] The resource ARN for the tag. |
TagKeys |
[required] The Tag keys to delete |
Updates an Api resource
Description
Updates an Api resource.
See https://www.paws-r-sdk.com/docs/apigatewayv2_update_api/ for full documentation.
Usage
apigatewayv2_update_api(
ApiId,
ApiKeySelectionExpression = NULL,
CorsConfiguration = NULL,
CredentialsArn = NULL,
Description = NULL,
DisableSchemaValidation = NULL,
DisableExecuteApiEndpoint = NULL,
Name = NULL,
RouteKey = NULL,
RouteSelectionExpression = NULL,
Target = NULL,
Version = NULL
)
Arguments
ApiId |
[required] The API identifier. |
ApiKeySelectionExpression |
An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions. |
CorsConfiguration |
A CORS configuration. Supported only for HTTP APIs. |
CredentialsArn |
This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify arn:aws:iam:::user/. To use resource-based permissions on supported AWS services, don't specify this parameter. Currently, this property is not used for HTTP integrations. If provided, this value replaces the credentials associated with the quick create integration. Supported only for HTTP APIs. |
Description |
The description of the API. |
DisableSchemaValidation |
Avoid validating models when creating a deployment. Supported only for WebSocket APIs. |
DisableExecuteApiEndpoint |
Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint. |
Name |
The name of the API. |
RouteKey |
This property is part of quick create. If not specified, the route created using quick create is kept. Otherwise, this value replaces the route key of the quick create route. Additional routes may still be added after the API is updated. Supported only for HTTP APIs. |
RouteSelectionExpression |
The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs. |
Target |
This property is part of quick create. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. The value provided updates the integration URI and integration type. You can update a quick-created target, but you can't remove it from an API. Supported only for HTTP APIs. |
Version |
A version identifier for the API. |
The API mapping
Description
The API mapping.
See https://www.paws-r-sdk.com/docs/apigatewayv2_update_api_mapping/ for full documentation.
Usage
apigatewayv2_update_api_mapping(
ApiId,
ApiMappingId,
ApiMappingKey = NULL,
DomainName,
Stage = NULL
)
Arguments
ApiId |
[required] The API identifier. |
ApiMappingId |
[required] The API mapping identifier. |
ApiMappingKey |
The API mapping key. |
DomainName |
[required] The domain name. |
Stage |
The API stage. |
Updates an Authorizer
Description
Updates an Authorizer.
See https://www.paws-r-sdk.com/docs/apigatewayv2_update_authorizer/ for full documentation.
Usage
apigatewayv2_update_authorizer(
ApiId,
AuthorizerCredentialsArn = NULL,
AuthorizerId,
AuthorizerPayloadFormatVersion = NULL,
AuthorizerResultTtlInSeconds = NULL,
AuthorizerType = NULL,
AuthorizerUri = NULL,
EnableSimpleResponses = NULL,
IdentitySource = NULL,
IdentityValidationExpression = NULL,
JwtConfiguration = NULL,
Name = NULL
)
Arguments
ApiId |
[required] The API identifier. |
AuthorizerCredentialsArn |
Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don't specify this parameter. |
AuthorizerId |
[required] The authorizer identifier. |
AuthorizerPayloadFormatVersion |
Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see Working with AWS Lambda authorizers for HTTP APIs. |
AuthorizerResultTtlInSeconds |
The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers. |
AuthorizerType |
The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs). |
AuthorizerUri |
The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form: arn:aws:apigateway:{region}:lambda:path/{service_api} , where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers. |
EnableSimpleResponses |
Specifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see Working with AWS Lambda authorizers for HTTP APIs |
IdentitySource |
The identity source for which authorization is requested. For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs. For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization. |
IdentityValidationExpression |
This parameter is not used. |
JwtConfiguration |
Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs. |
Name |
The name of the authorizer. |
Updates a Deployment
Description
Updates a Deployment.
See https://www.paws-r-sdk.com/docs/apigatewayv2_update_deployment/ for full documentation.
Usage
apigatewayv2_update_deployment(ApiId, DeploymentId, Description = NULL)
Arguments
ApiId |
[required] The API identifier. |
DeploymentId |
[required] The deployment ID. |
Description |
The description for the deployment resource. |
Updates a domain name
Description
Updates a domain name.
See https://www.paws-r-sdk.com/docs/apigatewayv2_update_domain_name/ for full documentation.
Usage
apigatewayv2_update_domain_name(
DomainName,
DomainNameConfigurations = NULL,
MutualTlsAuthentication = NULL
)
Arguments
DomainName |
[required] The domain name. |
DomainNameConfigurations |
The domain name configurations. |
MutualTlsAuthentication |
The mutual TLS authentication configuration for a custom domain name. |
Updates an Integration
Description
Updates an Integration.
See https://www.paws-r-sdk.com/docs/apigatewayv2_update_integration/ for full documentation.
Usage
apigatewayv2_update_integration(
ApiId,
ConnectionId = NULL,
ConnectionType = NULL,
ContentHandlingStrategy = NULL,
CredentialsArn = NULL,
Description = NULL,
IntegrationId,
IntegrationMethod = NULL,
IntegrationSubtype = NULL,
IntegrationType = NULL,
IntegrationUri = NULL,
PassthroughBehavior = NULL,
PayloadFormatVersion = NULL,
RequestParameters = NULL,
RequestTemplates = NULL,
ResponseParameters = NULL,
TemplateSelectionExpression = NULL,
TimeoutInMillis = NULL,
TlsConfig = NULL
)
Arguments
ApiId |
[required] The API identifier. |
ConnectionId |
The ID of the VPC link for a private integration. Supported only for HTTP APIs. |
ConnectionType |
The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET. |
ContentHandlingStrategy |
Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors: CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob. CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string. If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification. |
CredentialsArn |
Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam:::user/. To use resource-based permissions on supported AWS services, specify null. |
Description |
The description of the integration |
IntegrationId |
[required] The integration ID. |
IntegrationMethod |
Specifies the integration's HTTP method type. |
IntegrationSubtype |
Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference. |
IntegrationType |
The integration type of an integration. One of the following: AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs. AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration. HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs. HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration. For HTTP API private integrations, use an HTTP_PROXY integration. MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs. |
IntegrationUri |
For a Lambda integration, specify the URI of a Lambda function. For an HTTP integration, specify a fully-qualified URL. For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account. |
PassthroughBehavior |
Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs. WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation. NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response. WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response. |
PayloadFormatVersion |
Specifies the format of the payload sent to an integration. Required for HTTP APIs. Supported values for Lambda proxy integrations are 1.0 and 2.0. For all other integrations, 1.0 is the only supported value. To learn more, see Working with AWS Lambda proxy integrations for HTTP APIs. |
RequestParameters |
For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.{location}.{name} , where {location} is querystring, path, or header; and {name} must be a valid and unique method request parameter name. For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs. For HTTP API integrations, without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to the backend. The key should follow the pattern \<action\>:\<header|querystring|path\>.\<location\> where action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses. |
RequestTemplates |
Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs. |
ResponseParameters |
Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern \<action\>:\<header\>.\<location\> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses. |
TemplateSelectionExpression |
The template selection expression for the integration. |
TimeoutInMillis |
Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs. |
TlsConfig |
The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs. |
Updates an IntegrationResponses
Description
Updates an IntegrationResponses.
See https://www.paws-r-sdk.com/docs/apigatewayv2_update_integration_response/ for full documentation.
Usage
apigatewayv2_update_integration_response(
ApiId,
ContentHandlingStrategy = NULL,
IntegrationId,
IntegrationResponseId,
IntegrationResponseKey = NULL,
ResponseParameters = NULL,
ResponseTemplates = NULL,
TemplateSelectionExpression = NULL
)
Arguments
ApiId |
[required] The API identifier. |
ContentHandlingStrategy |
Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors: CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob. CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string. If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification. |
IntegrationId |
[required] The integration ID. |
IntegrationResponseId |
[required] The integration response ID. |
IntegrationResponseKey |
The integration response key. |
ResponseParameters |
A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name} , where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression} , where {name} is a valid and unique response header name and {JSON-expression} is a valid JSON expression without the $ prefix. |
ResponseTemplates |
The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value. |
TemplateSelectionExpression |
The template selection expression for the integration response. Supported only for WebSocket APIs. |
Updates a Model
Description
Updates a Model.
See https://www.paws-r-sdk.com/docs/apigatewayv2_update_model/ for full documentation.
Usage
apigatewayv2_update_model(
ApiId,
ContentType = NULL,
Description = NULL,
ModelId,
Name = NULL,
Schema = NULL
)
Arguments
ApiId |
[required] The API identifier. |
ContentType |
The content-type for the model, for example, "application/json". |
Description |
The description of the model. |
ModelId |
[required] The model ID. |
Name |
The name of the model. |
Schema |
The schema for the model. For application/json models, this should be JSON schema draft 4 model. |
Updates a Route
Description
Updates a Route.
See https://www.paws-r-sdk.com/docs/apigatewayv2_update_route/ for full documentation.
Usage
apigatewayv2_update_route(
ApiId,
ApiKeyRequired = NULL,
AuthorizationScopes = NULL,
AuthorizationType = NULL,
AuthorizerId = NULL,
ModelSelectionExpression = NULL,
OperationName = NULL,
RequestModels = NULL,
RequestParameters = NULL,
RouteId,
RouteKey = NULL,
RouteResponseSelectionExpression = NULL,
Target = NULL
)
Arguments
ApiId |
[required] The API identifier. |
ApiKeyRequired |
Specifies whether an API key is required for the route. Supported only for WebSocket APIs. |
AuthorizationScopes |
The authorization scopes supported by this route. |
AuthorizationType |
The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer. |
AuthorizerId |
The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer. |
ModelSelectionExpression |
The model selection expression for the route. Supported only for WebSocket APIs. |
OperationName |
The operation name for the route. |
RequestModels |
The request models for the route. Supported only for WebSocket APIs. |
RequestParameters |
The request parameters for the route. Supported only for WebSocket APIs. |
RouteId |
[required] The route ID. |
RouteKey |
The route key for the route. |
RouteResponseSelectionExpression |
The route response selection expression for the route. Supported only for WebSocket APIs. |
Target |
The target for the route. |
Updates a RouteResponse
Description
Updates a RouteResponse.
See https://www.paws-r-sdk.com/docs/apigatewayv2_update_route_response/ for full documentation.
Usage
apigatewayv2_update_route_response(
ApiId,
ModelSelectionExpression = NULL,
ResponseModels = NULL,
ResponseParameters = NULL,
RouteId,
RouteResponseId,
RouteResponseKey = NULL
)
Arguments
ApiId |
[required] The API identifier. |
ModelSelectionExpression |
The model selection expression for the route response. Supported only for WebSocket APIs. |
ResponseModels |
The response models for the route response. |
ResponseParameters |
The route response parameters. |
RouteId |
[required] The route ID. |
RouteResponseId |
[required] The route response ID. |
RouteResponseKey |
The route response key. |
Updates a Stage
Description
Updates a Stage.
See https://www.paws-r-sdk.com/docs/apigatewayv2_update_stage/ for full documentation.
Usage
apigatewayv2_update_stage(
AccessLogSettings = NULL,
ApiId,
AutoDeploy = NULL,
ClientCertificateId = NULL,
DefaultRouteSettings = NULL,
DeploymentId = NULL,
Description = NULL,
RouteSettings = NULL,
StageName,
StageVariables = NULL
)
Arguments
AccessLogSettings |
Settings for logging access in this stage. |
ApiId |
[required] The API identifier. |
AutoDeploy |
Specifies whether updates to an API automatically trigger a new deployment. The default value is false. |
ClientCertificateId |
The identifier of a client certificate for a Stage. |
DefaultRouteSettings |
The default route settings for the stage. |
DeploymentId |
The deployment identifier for the API stage. Can't be updated if autoDeploy is enabled. |
Description |
The description for the API stage. |
RouteSettings |
Route settings for the stage. |
StageName |
[required] The stage name. Stage names can contain only alphanumeric characters, hyphens, and underscores, or be $default. Maximum length is 128 characters. |
StageVariables |
A map that defines the stage variables for a Stage. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+. |
Updates a VPC link
Description
Updates a VPC link.
See https://www.paws-r-sdk.com/docs/apigatewayv2_update_vpc_link/ for full documentation.
Usage
apigatewayv2_update_vpc_link(Name = NULL, VpcLinkId)
Arguments
Name |
The name of the VPC link. |
VpcLinkId |
[required] The ID of the VPC link. |
AppFabric
Description
Amazon Web Services AppFabric quickly connects software as a service (SaaS) applications across your organization. This allows IT and security teams to easily manage and secure applications using a standard schema, and employees can complete everyday tasks faster using generative artificial intelligence (AI). You can use these APIs to complete AppFabric tasks, such as setting up audit log ingestions or viewing user access. For more information about AppFabric, including the required permissions to use the service, see the Amazon Web Services AppFabric Administration Guide. For more information about using the Command Line Interface (CLI) to manage your AppFabric resources, see the AppFabric section of the CLI Reference.
Usage
appfabric(
config = list(),
credentials = list(),
endpoint = NULL,
region = NULL
)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...)
, where svc
is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- appfabric( config = list( credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string", close_connection = "logical", timeout = "numeric", s3_force_path_style = "logical", sts_regional_endpoint = "string" ), credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string" )
Operations
batch_get_user_access_tasks | Gets user access details in a batch request |
connect_app_authorization | Establishes a connection between Amazon Web Services AppFabric and an application, which allows AppFabric to call the APIs of the application |
create_app_authorization | Creates an app authorization within an app bundle, which allows AppFabric to connect to an application |
create_app_bundle | Creates an app bundle to collect data from an application using AppFabric |
create_ingestion | Creates a data ingestion for an application |
create_ingestion_destination | Creates an ingestion destination, which specifies how an application's ingested data is processed by Amazon Web Services AppFabric and where it's delivered |
delete_app_authorization | Deletes an app authorization |
delete_app_bundle | Deletes an app bundle |
delete_ingestion | Deletes an ingestion |
delete_ingestion_destination | Deletes an ingestion destination |
get_app_authorization | Returns information about an app authorization |
get_app_bundle | Returns information about an app bundle |
get_ingestion | Returns information about an ingestion |
get_ingestion_destination | Returns information about an ingestion destination |
list_app_authorizations | Returns a list of all app authorizations configured for an app bundle |
list_app_bundles | Returns a list of app bundles |
list_ingestion_destinations | Returns a list of all ingestion destinations configured for an ingestion |
list_ingestions | Returns a list of all ingestions configured for an app bundle |
list_tags_for_resource | Returns a list of tags for a resource |
start_ingestion | Starts (enables) an ingestion, which collects data from an application |
start_user_access_tasks | Starts the tasks to search user access status for a specific email address |
stop_ingestion | Stops (disables) an ingestion |
tag_resource | Assigns one or more tags (key-value pairs) to the specified resource |
untag_resource | Removes a tag or tags from a resource |
update_app_authorization | Updates an app authorization within an app bundle, which allows AppFabric to connect to an application |
update_ingestion_destination | Updates an ingestion destination, which specifies how an application's ingested data is processed by Amazon Web Services AppFabric and where it's delivered |
Examples
## Not run:
svc <- appfabric()
svc$batch_get_user_access_tasks(
Foo = 123
)
## End(Not run)
Gets user access details in a batch request
Description
Gets user access details in a batch request.
See https://www.paws-r-sdk.com/docs/appfabric_batch_get_user_access_tasks/ for full documentation.
Usage
appfabric_batch_get_user_access_tasks(appBundleIdentifier, taskIdList)
Arguments
appBundleIdentifier |
[required] The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request. |
taskIdList |
[required] The tasks IDs to use for the request. |
Establishes a connection between Amazon Web Services AppFabric and an application, which allows AppFabric to call the APIs of the application
Description
Establishes a connection between Amazon Web Services AppFabric and an application, which allows AppFabric to call the APIs of the application.
See https://www.paws-r-sdk.com/docs/appfabric_connect_app_authorization/ for full documentation.
Usage
appfabric_connect_app_authorization(
appBundleIdentifier,
appAuthorizationIdentifier,
authRequest = NULL
)
Arguments
appBundleIdentifier |
[required] The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle that contains the app authorization to use for the request. |
appAuthorizationIdentifier |
[required] The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app authorization to use for the request. |
authRequest |
Contains OAuth2 authorization information. This is required if the app authorization for the request is configured
with an OAuth2 ( |
Creates an app authorization within an app bundle, which allows AppFabric to connect to an application
Description
Creates an app authorization within an app bundle, which allows AppFabric to connect to an application.
See https://www.paws-r-sdk.com/docs/appfabric_create_app_authorization/ for full documentation.
Usage
appfabric_create_app_authorization(
appBundleIdentifier,
app,
credential,
tenant,
authType,
clientToken = NULL,
tags = NULL
)
Arguments
appBundleIdentifier |
[required] The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request. |
app |
[required] The name of the application. Valid values are:
|
credential |
[required] Contains credentials for the application, such as an API key or OAuth2 client ID and secret. Specify credentials that match the authorization type for your request.
For example, if the authorization type for your request is OAuth2
( |
tenant |
[required] Contains information about an application tenant, such as the application display name and identifier. |
authType |
[required] The authorization type for the app authorization. |
clientToken |
Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value. If you don't provide this value, then Amazon Web Services generates a random one for you. If you retry the operation with the same |
tags |
A map of the key-value pairs of the tag or tags to assign to the resource. |
Creates an app bundle to collect data from an application using AppFabric
Description
Creates an app bundle to collect data from an application using AppFabric.
See https://www.paws-r-sdk.com/docs/appfabric_create_app_bundle/ for full documentation.
Usage
appfabric_create_app_bundle(
clientToken = NULL,
customerManagedKeyIdentifier = NULL,
tags = NULL
)
Arguments
clientToken |
Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value. If you don't provide this value, then Amazon Web Services generates a random one for you. If you retry the operation with the same |
customerManagedKeyIdentifier |
The Amazon Resource Name (ARN) of the Key Management Service (KMS) key to use to encrypt the application data. If this is not specified, an Amazon Web Services owned key is used for encryption. |
tags |
A map of the key-value pairs of the tag or tags to assign to the resource. |
Creates a data ingestion for an application
Description
Creates a data ingestion for an application.
See https://www.paws-r-sdk.com/docs/appfabric_create_ingestion/ for full documentation.
Usage
appfabric_create_ingestion(
appBundleIdentifier,
app,
tenantId,
ingestionType,
clientToken = NULL,
tags = NULL
)
Arguments
appBundleIdentifier |
[required] The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request. |
app |
[required] The name of the application. Valid values are:
|
tenantId |
[required] The ID of the application tenant. |
ingestionType |
[required] The ingestion type. |
clientToken |
Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value. If you don't provide this value, then Amazon Web Services generates a random one for you. If you retry the operation with the same |
tags |
A map of the key-value pairs of the tag or tags to assign to the resource. |
Creates an ingestion destination, which specifies how an application's ingested data is processed by Amazon Web Services AppFabric and where it's delivered
Description
Creates an ingestion destination, which specifies how an application's ingested data is processed by Amazon Web Services AppFabric and where it's delivered.
See https://www.paws-r-sdk.com/docs/appfabric_create_ingestion_destination/ for full documentation.
Usage
appfabric_create_ingestion_destination(
appBundleIdentifier,
ingestionIdentifier,
processingConfiguration,
destinationConfiguration,
clientToken = NULL,
tags = NULL
)
Arguments
appBundleIdentifier |
[required] The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request. |
ingestionIdentifier |
[required] The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request. |
processingConfiguration |
[required] Contains information about how ingested data is processed. |
destinationConfiguration |
[required] Contains information about the destination of ingested data. |
clientToken |
Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value. If you don't provide this value, then Amazon Web Services generates a random one for you. If you retry the operation with the same |
tags |
A map of the key-value pairs of the tag or tags to assign to the resource. |
Deletes an app authorization
Description
Deletes an app authorization. You must delete the associated ingestion before you can delete an app authorization.
See https://www.paws-r-sdk.com/docs/appfabric_delete_app_authorization/ for full documentation.
Usage
appfabric_delete_app_authorization(
appBundleIdentifier,
appAuthorizationIdentifier
)
Arguments
appBundleIdentifier |
[required] The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request. |
appAuthorizationIdentifier |
[required] The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app authorization to use for the request. |
Deletes an app bundle
Description
Deletes an app bundle. You must delete all associated app authorizations before you can delete an app bundle.
See https://www.paws-r-sdk.com/docs/appfabric_delete_app_bundle/ for full documentation.
Usage
appfabric_delete_app_bundle(appBundleIdentifier)
Arguments
appBundleIdentifier |
[required] The ID or Amazon Resource Name (ARN) of the app bundle that needs to be deleted. |
Deletes an ingestion
Description
Deletes an ingestion. You must stop (disable) the ingestion and you must delete all associated ingestion destinations before you can delete an app ingestion.
See https://www.paws-r-sdk.com/docs/appfabric_delete_ingestion/ for full documentation.
Usage
appfabric_delete_ingestion(appBundleIdentifier, ingestionIdentifier)
Arguments
appBundleIdentifier |
[required] The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request. |
ingestionIdentifier |
[required] The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request. |
Deletes an ingestion destination
Description
Deletes an ingestion destination.
See https://www.paws-r-sdk.com/docs/appfabric_delete_ingestion_destination/ for full documentation.
Usage
appfabric_delete_ingestion_destination(
appBundleIdentifier,
ingestionIdentifier,
ingestionDestinationIdentifier
)
Arguments
appBundleIdentifier |
[required] The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request. |
ingestionIdentifier |
[required] The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request. |
ingestionDestinationIdentifier |
[required] The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion destination to use for the request. |
Returns information about an app authorization
Description
Returns information about an app authorization.
See https://www.paws-r-sdk.com/docs/appfabric_get_app_authorization/ for full documentation.
Usage
appfabric_get_app_authorization(
appBundleIdentifier,
appAuthorizationIdentifier
)
Arguments
appBundleIdentifier |
[required] The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request. |
appAuthorizationIdentifier |
[required] The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app authorization to use for the request. |
Returns information about an app bundle
Description
Returns information about an app bundle.
See https://www.paws-r-sdk.com/docs/appfabric_get_app_bundle/ for full documentation.
Usage
appfabric_get_app_bundle(appBundleIdentifier)
Arguments
appBundleIdentifier |
[required] The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request. |
Returns information about an ingestion
Description
Returns information about an ingestion.
See https://www.paws-r-sdk.com/docs/appfabric_get_ingestion/ for full documentation.
Usage
appfabric_get_ingestion(appBundleIdentifier, ingestionIdentifier)
Arguments
appBundleIdentifier |
[required] The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request. |
ingestionIdentifier |
[required] The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request. |
Returns information about an ingestion destination
Description
Returns information about an ingestion destination.
See https://www.paws-r-sdk.com/docs/appfabric_get_ingestion_destination/ for full documentation.
Usage
appfabric_get_ingestion_destination(
appBundleIdentifier,
ingestionIdentifier,
ingestionDestinationIdentifier
)
Arguments
appBundleIdentifier |
[required] The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request. |
ingestionIdentifier |
[required] The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request. |
ingestionDestinationIdentifier |
[required] The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion destination to use for the request. |
Returns a list of all app authorizations configured for an app bundle
Description
Returns a list of all app authorizations configured for an app bundle.
See https://www.paws-r-sdk.com/docs/appfabric_list_app_authorizations/ for full documentation.
Usage
appfabric_list_app_authorizations(
appBundleIdentifier,
maxResults = NULL,
nextToken = NULL
)
Arguments
appBundleIdentifier |
[required] The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request. |
maxResults |
The maximum number of results that are returned per call. You can use
This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum. |
nextToken |
If |
Returns a list of app bundles
Description
Returns a list of app bundles.
See https://www.paws-r-sdk.com/docs/appfabric_list_app_bundles/ for full documentation.
Usage
appfabric_list_app_bundles(maxResults = NULL, nextToken = NULL)
Arguments
maxResults |
The maximum number of results that are returned per call. You can use
This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum. |
nextToken |
If |
Returns a list of all ingestion destinations configured for an ingestion
Description
Returns a list of all ingestion destinations configured for an ingestion.
See https://www.paws-r-sdk.com/docs/appfabric_list_ingestion_destinations/ for full documentation.
Usage
appfabric_list_ingestion_destinations(
appBundleIdentifier,
ingestionIdentifier,
maxResults = NULL,
nextToken = NULL
)
Arguments
appBundleIdentifier |
[required] The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request. |
ingestionIdentifier |
[required] The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request. |
maxResults |
The maximum number of results that are returned per call. You can use
This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum. |
nextToken |
If |
Returns a list of all ingestions configured for an app bundle
Description
Returns a list of all ingestions configured for an app bundle.
See https://www.paws-r-sdk.com/docs/appfabric_list_ingestions/ for full documentation.
Usage
appfabric_list_ingestions(
appBundleIdentifier,
maxResults = NULL,
nextToken = NULL
)
Arguments
appBundleIdentifier |
[required] The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request. |
maxResults |
The maximum number of results that are returned per call. You can use
This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum. |
nextToken |
If |
Returns a list of tags for a resource
Description
Returns a list of tags for a resource.
See https://www.paws-r-sdk.com/docs/appfabric_list_tags_for_resource/ for full documentation.
Usage
appfabric_list_tags_for_resource(resourceArn)
Arguments
resourceArn |
[required] The Amazon Resource Name (ARN) of the resource for which you want to retrieve tags. |
Starts (enables) an ingestion, which collects data from an application
Description
Starts (enables) an ingestion, which collects data from an application.
See https://www.paws-r-sdk.com/docs/appfabric_start_ingestion/ for full documentation.
Usage
appfabric_start_ingestion(ingestionIdentifier, appBundleIdentifier)
Arguments
ingestionIdentifier |
[required] The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request. |
appBundleIdentifier |
[required] The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request. |
Starts the tasks to search user access status for a specific email address
Description
Starts the tasks to search user access status for a specific email address.
See https://www.paws-r-sdk.com/docs/appfabric_start_user_access_tasks/ for full documentation.
Usage
appfabric_start_user_access_tasks(appBundleIdentifier, email)
Arguments
appBundleIdentifier |
[required] The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request. |
email |
[required] The email address of the target user. |
Stops (disables) an ingestion
Description
Stops (disables) an ingestion.
See https://www.paws-r-sdk.com/docs/appfabric_stop_ingestion/ for full documentation.
Usage
appfabric_stop_ingestion(ingestionIdentifier, appBundleIdentifier)
Arguments
ingestionIdentifier |
[required] The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request. |
appBundleIdentifier |
[required] The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request. |
Assigns one or more tags (key-value pairs) to the specified resource
Description
Assigns one or more tags (key-value pairs) to the specified resource.
See https://www.paws-r-sdk.com/docs/appfabric_tag_resource/ for full documentation.
Usage
appfabric_tag_resource(resourceArn, tags)
Arguments
resourceArn |
[required] The Amazon Resource Name (ARN) of the resource that you want to tag. |
tags |
[required] A map of the key-value pairs of the tag or tags to assign to the resource. |
Removes a tag or tags from a resource
Description
Removes a tag or tags from a resource.
See https://www.paws-r-sdk.com/docs/appfabric_untag_resource/ for full documentation.
Usage
appfabric_untag_resource(resourceArn, tagKeys)
Arguments
resourceArn |
[required] The Amazon Resource Name (ARN) of the resource that you want to untag. |
tagKeys |
[required] The keys of the key-value pairs for the tag or tags you want to remove from the specified resource. |
Updates an app authorization within an app bundle, which allows AppFabric to connect to an application
Description
Updates an app authorization within an app bundle, which allows AppFabric to connect to an application.
See https://www.paws-r-sdk.com/docs/appfabric_update_app_authorization/ for full documentation.
Usage
appfabric_update_app_authorization(
appBundleIdentifier,
appAuthorizationIdentifier,
credential = NULL,
tenant = NULL
)
Arguments
appBundleIdentifier |
[required] The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request. |
appAuthorizationIdentifier |
[required] The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app authorization to use for the request. |
credential |
Contains credentials for the application, such as an API key or OAuth2 client ID and secret. Specify credentials that match the authorization type of the app
authorization to update. For example, if the authorization type of the
app authorization is OAuth2 ( |
tenant |
Contains information about an application tenant, such as the application display name and identifier. |
Updates an ingestion destination, which specifies how an application's ingested data is processed by Amazon Web Services AppFabric and where it's delivered
Description
Updates an ingestion destination, which specifies how an application's ingested data is processed by Amazon Web Services AppFabric and where it's delivered.
See https://www.paws-r-sdk.com/docs/appfabric_update_ingestion_destination/ for full documentation.
Usage
appfabric_update_ingestion_destination(
appBundleIdentifier,
ingestionIdentifier,
ingestionDestinationIdentifier,
destinationConfiguration
)
Arguments
appBundleIdentifier |
[required] The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request. |
ingestionIdentifier |
[required] The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request. |
ingestionDestinationIdentifier |
[required] The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion destination to use for the request. |
destinationConfiguration |
[required] Contains information about the destination of ingested data. |
AWS App Mesh
Description
App Mesh is a service mesh based on the Envoy proxy that makes it easy to monitor and control microservices. App Mesh standardizes how your microservices communicate, giving you end-to-end visibility and helping to ensure high availability for your applications.
App Mesh gives you consistent visibility and network traffic controls for every microservice in an application. You can use App Mesh with Amazon Web Services Fargate, Amazon ECS, Amazon EKS, Kubernetes on Amazon Web Services, and Amazon EC2.
App Mesh supports microservice applications that use service discovery
naming for their components. For more information about service
discovery on Amazon ECS, see Service Discovery
in the Amazon Elastic Container Service Developer Guide. Kubernetes
kube-dns
and coredns
are supported. For more information, see DNS for Services and Pods
in the Kubernetes documentation.
Usage
appmesh(config = list(), credentials = list(), endpoint = NULL, region = NULL)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...)
, where svc
is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- appmesh( config = list( credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string", close_connection = "logical", timeout = "numeric", s3_force_path_style = "logical", sts_regional_endpoint = "string" ), credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string" )
Operations
create_gateway_route | Creates a gateway route |
create_mesh | Creates a service mesh |
create_route | Creates a route that is associated with a virtual router |
create_virtual_gateway | Creates a virtual gateway |
create_virtual_node | Creates a virtual node within a service mesh |
create_virtual_router | Creates a virtual router within a service mesh |
create_virtual_service | Creates a virtual service within a service mesh |
delete_gateway_route | Deletes an existing gateway route |
delete_mesh | Deletes an existing service mesh |
delete_route | Deletes an existing route |
delete_virtual_gateway | Deletes an existing virtual gateway |
delete_virtual_node | Deletes an existing virtual node |
delete_virtual_router | Deletes an existing virtual router |
delete_virtual_service | Deletes an existing virtual service |
describe_gateway_route | Describes an existing gateway route |
describe_mesh | Describes an existing service mesh |
describe_route | Describes an existing route |
describe_virtual_gateway | Describes an existing virtual gateway |
describe_virtual_node | Describes an existing virtual node |
describe_virtual_router | Describes an existing virtual router |
describe_virtual_service | Describes an existing virtual service |
list_gateway_routes | Returns a list of existing gateway routes that are associated to a virtual gateway |
list_meshes | Returns a list of existing service meshes |
list_routes | Returns a list of existing routes in a service mesh |
list_tags_for_resource | List the tags for an App Mesh resource |
list_virtual_gateways | Returns a list of existing virtual gateways in a service mesh |
list_virtual_nodes | Returns a list of existing virtual nodes |
list_virtual_routers | Returns a list of existing virtual routers in a service mesh |
list_virtual_services | Returns a list of existing virtual services in a service mesh |
tag_resource | Associates the specified tags to a resource with the specified resourceArn |
untag_resource | Deletes specified tags from a resource |
update_gateway_route | Updates an existing gateway route that is associated to a specified virtual gateway in a service mesh |
update_mesh | Updates an existing service mesh |
update_route | Updates an existing route for a specified service mesh and virtual router |
update_virtual_gateway | Updates an existing virtual gateway in a specified service mesh |
update_virtual_node | Updates an existing virtual node in a specified service mesh |
update_virtual_router | Updates an existing virtual router in a specified service mesh |
update_virtual_service | Updates an existing virtual service in a specified service mesh |
Examples
## Not run:
svc <- appmesh()
svc$create_gateway_route(
Foo = 123
)
## End(Not run)
Creates a gateway route
Description
Creates a gateway route.
See https://www.paws-r-sdk.com/docs/appmesh_create_gateway_route/ for full documentation.
Usage
appmesh_create_gateway_route(
clientToken = NULL,
gatewayRouteName,
meshName,
meshOwner = NULL,
spec,
tags = NULL,
virtualGatewayName
)
Arguments
clientToken |
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed. |
gatewayRouteName |
[required] The name to use for the gateway route. |
meshName |
[required] The name of the service mesh to create the gateway route in. |
meshOwner |
The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then the account that you specify must share the mesh with your account before you can create the resource in the service mesh. For more information about mesh sharing, see Working with shared meshes. |
spec |
[required] The gateway route specification to apply. |
tags |
Optional metadata that you can apply to the gateway route to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters. |
virtualGatewayName |
[required] The name of the virtual gateway to associate the gateway route with. If the virtual gateway is in a shared mesh, then you must be the owner of the virtual gateway resource. |
Creates a service mesh
Description
Creates a service mesh.
See https://www.paws-r-sdk.com/docs/appmesh_create_mesh/ for full documentation.
Usage
appmesh_create_mesh(clientToken = NULL, meshName, spec = NULL, tags = NULL)
Arguments
clientToken |
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed. |
meshName |
[required] The name to use for the service mesh. |
spec |
The service mesh specification to apply. |
tags |
Optional metadata that you can apply to the service mesh to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters. |
Creates a route that is associated with a virtual router
Description
Creates a route that is associated with a virtual router.
See https://www.paws-r-sdk.com/docs/appmesh_create_route/ for full documentation.
Usage
appmesh_create_route(
clientToken = NULL,
meshName,
meshOwner = NULL,
routeName,
spec,
tags = NULL,
virtualRouterName
)
Arguments
clientToken |
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed. |
meshName |
[required] The name of the service mesh to create the route in. |
meshOwner |
The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then the account that you specify must share the mesh with your account before you can create the resource in the service mesh. For more information about mesh sharing, see Working with shared meshes. |
routeName |
[required] The name to use for the route. |
spec |
[required] The route specification to apply. |
tags |
Optional metadata that you can apply to the route to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters. |
virtualRouterName |
[required] The name of the virtual router in which to create the route. If the virtual router is in a shared mesh, then you must be the owner of the virtual router resource. |
Creates a virtual gateway
Description
Creates a virtual gateway.
See https://www.paws-r-sdk.com/docs/appmesh_create_virtual_gateway/ for full documentation.
Usage
appmesh_create_virtual_gateway(
clientToken = NULL,
meshName,
meshOwner = NULL,
spec,
tags = NULL,
virtualGatewayName
)
Arguments
clientToken |
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed. |
meshName |
[required] The name of the service mesh to create the virtual gateway in. |
meshOwner |
The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then the account that you specify must share the mesh with your account before you can create the resource in the service mesh. For more information about mesh sharing, see Working with shared meshes. |
spec |
[required] The virtual gateway specification to apply. |
tags |
Optional metadata that you can apply to the virtual gateway to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters. |
virtualGatewayName |
[required] The name to use for the virtual gateway. |
Creates a virtual node within a service mesh
Description
Creates a virtual node within a service mesh.
See https://www.paws-r-sdk.com/docs/appmesh_create_virtual_node/ for full documentation.
Usage
appmesh_create_virtual_node(
clientToken = NULL,
meshName,
meshOwner = NULL,
spec,
tags = NULL,
virtualNodeName
)
Arguments
clientToken |
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed. |
meshName |
[required] The name of the service mesh to create the virtual node in. |
meshOwner |
The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then the account that you specify must share the mesh with your account before you can create the resource in the service mesh. For more information about mesh sharing, see Working with shared meshes. |
spec |
[required] The virtual node specification to apply. |
tags |
Optional metadata that you can apply to the virtual node to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters. |
virtualNodeName |
[required] The name to use for the virtual node. |
Creates a virtual router within a service mesh
Description
Creates a virtual router within a service mesh.
See https://www.paws-r-sdk.com/docs/appmesh_create_virtual_router/ for full documentation.
Usage
appmesh_create_virtual_router(
clientToken = NULL,
meshName,
meshOwner = NULL,
spec,
tags = NULL,
virtualRouterName
)
Arguments
clientToken |
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed. |
meshName |
[required] The name of the service mesh to create the virtual router in. |
meshOwner |
The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then the account that you specify must share the mesh with your account before you can create the resource in the service mesh. For more information about mesh sharing, see Working with shared meshes. |
spec |
[required] The virtual router specification to apply. |
tags |
Optional metadata that you can apply to the virtual router to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters. |
virtualRouterName |
[required] The name to use for the virtual router. |
Creates a virtual service within a service mesh
Description
Creates a virtual service within a service mesh.
See https://www.paws-r-sdk.com/docs/appmesh_create_virtual_service/ for full documentation.
Usage
appmesh_create_virtual_service(
clientToken = NULL,
meshName,
meshOwner = NULL,
spec,
tags = NULL,
virtualServiceName
)
Arguments
clientToken |
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed. |
meshName |
[required] The name of the service mesh to create the virtual service in. |
meshOwner |
The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then the account that you specify must share the mesh with your account before you can create the resource in the service mesh. For more information about mesh sharing, see Working with shared meshes. |
spec |
[required] The virtual service specification to apply. |
tags |
Optional metadata that you can apply to the virtual service to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters. |
virtualServiceName |
[required] The name to use for the virtual service. |
Deletes an existing gateway route
Description
Deletes an existing gateway route.
See https://www.paws-r-sdk.com/docs/appmesh_delete_gateway_route/ for full documentation.
Usage
appmesh_delete_gateway_route(
gatewayRouteName,
meshName,
meshOwner = NULL,
virtualGatewayName
)
Arguments
gatewayRouteName |
[required] The name of the gateway route to delete. |
meshName |
[required] The name of the service mesh to delete the gateway route from. |
meshOwner |
The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes. |
virtualGatewayName |
[required] The name of the virtual gateway to delete the route from. |
Deletes an existing service mesh
Description
Deletes an existing service mesh.
See https://www.paws-r-sdk.com/docs/appmesh_delete_mesh/ for full documentation.
Usage
appmesh_delete_mesh(meshName)
Arguments
meshName |
[required] The name of the service mesh to delete. |
Deletes an existing route
Description
Deletes an existing route.
See https://www.paws-r-sdk.com/docs/appmesh_delete_route/ for full documentation.
Usage
appmesh_delete_route(meshName, meshOwner = NULL, routeName, virtualRouterName)
Arguments
meshName |
[required] The name of the service mesh to delete the route in. |
meshOwner |
The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes. |
routeName |
[required] The name of the route to delete. |
virtualRouterName |
[required] The name of the virtual router to delete the route in. |
Deletes an existing virtual gateway
Description
Deletes an existing virtual gateway. You cannot delete a virtual gateway if any gateway routes are associated to it.
See https://www.paws-r-sdk.com/docs/appmesh_delete_virtual_gateway/ for full documentation.
Usage
appmesh_delete_virtual_gateway(meshName, meshOwner = NULL, virtualGatewayName)
Arguments
meshName |
[required] The name of the service mesh to delete the virtual gateway from. |
meshOwner |
The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes. |
virtualGatewayName |
[required] The name of the virtual gateway to delete. |
Deletes an existing virtual node
Description
Deletes an existing virtual node.
See https://www.paws-r-sdk.com/docs/appmesh_delete_virtual_node/ for full documentation.
Usage
appmesh_delete_virtual_node(meshName, meshOwner = NULL, virtualNodeName)
Arguments
meshName |
[required] The name of the service mesh to delete the virtual node in. |
meshOwner |
The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes. |
virtualNodeName |
[required] The name of the virtual node to delete. |
Deletes an existing virtual router
Description
Deletes an existing virtual router.
See https://www.paws-r-sdk.com/docs/appmesh_delete_virtual_router/ for full documentation.
Usage
appmesh_delete_virtual_router(meshName, meshOwner = NULL, virtualRouterName)
Arguments
meshName |
[required] The name of the service mesh to delete the virtual router in. |
meshOwner |
The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes. |
virtualRouterName |
[required] The name of the virtual router to delete. |
Deletes an existing virtual service
Description
Deletes an existing virtual service.
See https://www.paws-r-sdk.com/docs/appmesh_delete_virtual_service/ for full documentation.
Usage
appmesh_delete_virtual_service(meshName, meshOwner = NULL, virtualServiceName)
Arguments
meshName |
[required] The name of the service mesh to delete the virtual service in. |
meshOwner |
The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes. |
virtualServiceName |
[required] The name of the virtual service to delete. |
Describes an existing gateway route
Description
Describes an existing gateway route.
See https://www.paws-r-sdk.com/docs/appmesh_describe_gateway_route/ for full documentation.
Usage
appmesh_describe_gateway_route(
gatewayRouteName,
meshName,
meshOwner = NULL,
virtualGatewayName
)
Arguments
gatewayRouteName |
[required] The name of the gateway route to describe. |
meshName |
[required] The name of the service mesh that the gateway route resides in. |
meshOwner |
The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes. |
virtualGatewayName |
[required] The name of the virtual gateway that the gateway route is associated with. |
Describes an existing service mesh
Description
Describes an existing service mesh.
See https://www.paws-r-sdk.com/docs/appmesh_describe_mesh/ for full documentation.
Usage
appmesh_describe_mesh(meshName, meshOwner = NULL)
Arguments
meshName |
[required] The name of the service mesh to describe. |
meshOwner |
The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes. |
Describes an existing route
Description
Describes an existing route.
See https://www.paws-r-sdk.com/docs/appmesh_describe_route/ for full documentation.
Usage
appmesh_describe_route(
meshName,
meshOwner = NULL,
routeName,
virtualRouterName
)
Arguments
meshName |
[required] The name of the service mesh that the route resides in. |
meshOwner |
The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes. |
routeName |
[required] The name of the route to describe. |
virtualRouterName |
[required] The name of the virtual router that the route is associated with. |
Describes an existing virtual gateway
Description
Describes an existing virtual gateway.
See https://www.paws-r-sdk.com/docs/appmesh_describe_virtual_gateway/ for full documentation.
Usage
appmesh_describe_virtual_gateway(
meshName,
meshOwner = NULL,
virtualGatewayName
)
Arguments
meshName |
[required] The name of the service mesh that the gateway route resides in. |
meshOwner |
The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes. |
virtualGatewayName |
[required] The name of the virtual gateway to describe. |
Describes an existing virtual node
Description
Describes an existing virtual node.
See https://www.paws-r-sdk.com/docs/appmesh_describe_virtual_node/ for full documentation.
Usage
appmesh_describe_virtual_node(meshName, meshOwner = NULL, virtualNodeName)
Arguments
meshName |
[required] The name of the service mesh that the virtual node resides in. |
meshOwner |
The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes. |
virtualNodeName |
[required] The name of the virtual node to describe. |
Describes an existing virtual router
Description
Describes an existing virtual router.
See https://www.paws-r-sdk.com/docs/appmesh_describe_virtual_router/ for full documentation.
Usage
appmesh_describe_virtual_router(meshName, meshOwner = NULL, virtualRouterName)
Arguments
meshName |
[required] The name of the service mesh that the virtual router resides in. |
meshOwner |
The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes. |
virtualRouterName |
[required] The name of the virtual router to describe. |
Describes an existing virtual service
Description
Describes an existing virtual service.
See https://www.paws-r-sdk.com/docs/appmesh_describe_virtual_service/ for full documentation.
Usage
appmesh_describe_virtual_service(
meshName,
meshOwner = NULL,
virtualServiceName
)
Arguments
meshName |
[required] The name of the service mesh that the virtual service resides in. |
meshOwner |
The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes. |
virtualServiceName |
[required] The name of the virtual service to describe. |
Returns a list of existing gateway routes that are associated to a virtual gateway
Description
Returns a list of existing gateway routes that are associated to a virtual gateway.
See https://www.paws-r-sdk.com/docs/appmesh_list_gateway_routes/ for full documentation.
Usage
appmesh_list_gateway_routes(
limit = NULL,
meshName,
meshOwner = NULL,
nextToken = NULL,
virtualGatewayName
)
Arguments
limit |
The maximum number of results returned by
|
meshName |
[required] The name of the service mesh to list gateway routes in. |
meshOwner |
The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes. |
nextToken |
The |
virtualGatewayName |
[required] The name of the virtual gateway to list gateway routes in. |
Returns a list of existing service meshes
Description
Returns a list of existing service meshes.
See https://www.paws-r-sdk.com/docs/appmesh_list_meshes/ for full documentation.
Usage
appmesh_list_meshes(limit = NULL, nextToken = NULL)
Arguments
limit |
The maximum number of results returned by
|
nextToken |
The This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes. |
Returns a list of existing routes in a service mesh
Description
Returns a list of existing routes in a service mesh.
See https://www.paws-r-sdk.com/docs/appmesh_list_routes/ for full documentation.
Usage
appmesh_list_routes(
limit = NULL,
meshName,
meshOwner = NULL,
nextToken = NULL,
virtualRouterName
)
Arguments
limit |
The maximum number of results returned by
|
meshName |
[required] The name of the service mesh to list routes in. |
meshOwner |
The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes. |
nextToken |
The |
virtualRouterName |
[required] The name of the virtual router to list routes in. |
List the tags for an App Mesh resource
Description
List the tags for an App Mesh resource.
See https://www.paws-r-sdk.com/docs/appmesh_list_tags_for_resource/ for full documentation.
Usage
appmesh_list_tags_for_resource(limit = NULL, nextToken = NULL, resourceArn)
Arguments
limit |
The maximum number of tag results returned by
|
nextToken |
The |
resourceArn |
[required] The Amazon Resource Name (ARN) that identifies the resource to list the tags for. |
Returns a list of existing virtual gateways in a service mesh
Description
Returns a list of existing virtual gateways in a service mesh.
See https://www.paws-r-sdk.com/docs/appmesh_list_virtual_gateways/ for full documentation.
Usage
appmesh_list_virtual_gateways(
limit = NULL,
meshName,
meshOwner = NULL,
nextToken = NULL
)
Arguments
limit |
The maximum number of results returned by
|
meshName |
[required] The name of the service mesh to list virtual gateways in. |
meshOwner |
The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes. |
nextToken |
The |
Returns a list of existing virtual nodes
Description
Returns a list of existing virtual nodes.
See https://www.paws-r-sdk.com/docs/appmesh_list_virtual_nodes/ for full documentation.
Usage
appmesh_list_virtual_nodes(
limit = NULL,
meshName,
meshOwner = NULL,
nextToken = NULL
)
Arguments
limit |
The maximum number of results returned by
|
meshName |
[required] The name of the service mesh to list virtual nodes in. |
meshOwner |
The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes. |
nextToken |
The |
Returns a list of existing virtual routers in a service mesh
Description
Returns a list of existing virtual routers in a service mesh.
See https://www.paws-r-sdk.com/docs/appmesh_list_virtual_routers/ for full documentation.
Usage
appmesh_list_virtual_routers(
limit = NULL,
meshName,
meshOwner = NULL,
nextToken = NULL
)
Arguments
limit |
The maximum number of results returned by
|
meshName |
[required] The name of the service mesh to list virtual routers in. |
meshOwner |
The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes. |
nextToken |
The |
Returns a list of existing virtual services in a service mesh
Description
Returns a list of existing virtual services in a service mesh.
See https://www.paws-r-sdk.com/docs/appmesh_list_virtual_services/ for full documentation.
Usage
appmesh_list_virtual_services(
limit = NULL,
meshName,
meshOwner = NULL,
nextToken = NULL
)
Arguments
limit |
The maximum number of results returned by
|
meshName |
[required] The name of the service mesh to list virtual services in. |
meshOwner |
The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes. |
nextToken |
The |
Associates the specified tags to a resource with the specified resourceArn
Description
Associates the specified tags to a resource with the specified resourceArn
. If existing tags on a resource aren't specified in the request parameters, they aren't changed. When a resource is deleted, the tags associated with that resource are also deleted.
See https://www.paws-r-sdk.com/docs/appmesh_tag_resource/ for full documentation.
Usage
appmesh_tag_resource(resourceArn, tags)
Arguments
resourceArn |
[required] The Amazon Resource Name (ARN) of the resource to add tags to. |
tags |
[required] The tags to add to the resource. A tag is an array of key-value pairs. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters. |
Deletes specified tags from a resource
Description
Deletes specified tags from a resource.
See https://www.paws-r-sdk.com/docs/appmesh_untag_resource/ for full documentation.
Usage
appmesh_untag_resource(resourceArn, tagKeys)
Arguments
resourceArn |
[required] The Amazon Resource Name (ARN) of the resource to delete tags from. |
tagKeys |
[required] The keys of the tags to be removed. |
Updates an existing gateway route that is associated to a specified virtual gateway in a service mesh
Description
Updates an existing gateway route that is associated to a specified virtual gateway in a service mesh.
See https://www.paws-r-sdk.com/docs/appmesh_update_gateway_route/ for full documentation.
Usage
appmesh_update_gateway_route(
clientToken = NULL,
gatewayRouteName,
meshName,
meshOwner = NULL,
spec,
virtualGatewayName
)
Arguments
clientToken |
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed. |
gatewayRouteName |
[required] The name of the gateway route to update. |
meshName |
[required] The name of the service mesh that the gateway route resides in. |
meshOwner |
The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes. |
spec |
[required] The new gateway route specification to apply. This overwrites the existing data. |
virtualGatewayName |
[required] The name of the virtual gateway that the gateway route is associated with. |
Updates an existing service mesh
Description
Updates an existing service mesh.
See https://www.paws-r-sdk.com/docs/appmesh_update_mesh/ for full documentation.
Usage
appmesh_update_mesh(clientToken = NULL, meshName, spec = NULL)
Arguments
clientToken |
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed. |
meshName |
[required] The name of the service mesh to update. |
spec |
The service mesh specification to apply. |
Updates an existing route for a specified service mesh and virtual router
Description
Updates an existing route for a specified service mesh and virtual router.
See https://www.paws-r-sdk.com/docs/appmesh_update_route/ for full documentation.
Usage
appmesh_update_route(
clientToken = NULL,
meshName,
meshOwner = NULL,
routeName,
spec,
virtualRouterName
)
Arguments
clientToken |
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed. |
meshName |
[required] The name of the service mesh that the route resides in. |
meshOwner |
The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes. |
routeName |
[required] The name of the route to update. |
spec |
[required] The new route specification to apply. This overwrites the existing data. |
virtualRouterName |
[required] The name of the virtual router that the route is associated with. |
Updates an existing virtual gateway in a specified service mesh
Description
Updates an existing virtual gateway in a specified service mesh.
See https://www.paws-r-sdk.com/docs/appmesh_update_virtual_gateway/ for full documentation.
Usage
appmesh_update_virtual_gateway(
clientToken = NULL,
meshName,
meshOwner = NULL,
spec,
virtualGatewayName
)
Arguments
clientToken |
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed. |
meshName |
[required] The name of the service mesh that the virtual gateway resides in. |
meshOwner |
The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes. |
spec |
[required] The new virtual gateway specification to apply. This overwrites the existing data. |
virtualGatewayName |
[required] The name of the virtual gateway to update. |
Updates an existing virtual node in a specified service mesh
Description
Updates an existing virtual node in a specified service mesh.
See https://www.paws-r-sdk.com/docs/appmesh_update_virtual_node/ for full documentation.
Usage
appmesh_update_virtual_node(
clientToken = NULL,
meshName,
meshOwner = NULL,
spec,
virtualNodeName
)
Arguments
clientToken |
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed. |
meshName |
[required] The name of the service mesh that the virtual node resides in. |
meshOwner |
The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes. |
spec |
[required] The new virtual node specification to apply. This overwrites the existing data. |
virtualNodeName |
[required] The name of the virtual node to update. |
Updates an existing virtual router in a specified service mesh
Description
Updates an existing virtual router in a specified service mesh.
See https://www.paws-r-sdk.com/docs/appmesh_update_virtual_router/ for full documentation.
Usage
appmesh_update_virtual_router(
clientToken = NULL,
meshName,
meshOwner = NULL,
spec,
virtualRouterName
)
Arguments
clientToken |
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed. |
meshName |
[required] The name of the service mesh that the virtual router resides in. |
meshOwner |
The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes. |
spec |
[required] The new virtual router specification to apply. This overwrites the existing data. |
virtualRouterName |
[required] The name of the virtual router to update. |
Updates an existing virtual service in a specified service mesh
Description
Updates an existing virtual service in a specified service mesh.
See https://www.paws-r-sdk.com/docs/appmesh_update_virtual_service/ for full documentation.
Usage
appmesh_update_virtual_service(
clientToken = NULL,
meshName,
meshOwner = NULL,
spec,
virtualServiceName
)
Arguments
clientToken |
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed. |
meshName |
[required] The name of the service mesh that the virtual service resides in. |
meshOwner |
The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes. |
spec |
[required] The new virtual service specification to apply. This overwrites the existing data. |
virtualServiceName |
[required] The name of the virtual service to update. |
AWS ARC - Zonal Shift
Description
Welcome to the API Reference Guide for zonal shift and zonal autoshift in Amazon Route 53 Application Recovery Controller (Route 53 ARC).
You can start a zonal shift to move traffic for a load balancer resource away from an Availability Zone to help your application recover quickly from an impairment in an Availability Zone. For example, you can recover your application from a developer's bad code deployment or from an Amazon Web Services infrastructure failure in a single Availability Zone.
You can also configure zonal autoshift for supported load balancer resources. Zonal autoshift is a capability in Route 53 ARC where you authorize Amazon Web Services to shift away application resource traffic from an Availability Zone during events, on your behalf, to help reduce your time to recovery. Amazon Web Services starts an autoshift when internal telemetry indicates that there is an Availability Zone impairment that could potentially impact customers.
To help make sure that zonal autoshift is safe for your application, you must also configure practice runs when you enable zonal autoshift for a resource. Practice runs start weekly zonal shifts for a resource, to shift traffic for the resource away from an Availability Zone. Practice runs help you to make sure, on a regular basis, that you have enough capacity in all the Availability Zones in an Amazon Web Services Region for your application to continue to operate normally when traffic for a resource is shifted away from one Availability Zone.
Before you configure practice runs or enable zonal autoshift, we strongly recommend that you prescale your application resource capacity in all Availability Zones in the Region where your application resources are deployed. You should not rely on scaling on demand when an autoshift or practice run starts. Zonal autoshift, including practice runs, works independently, and does not wait for auto scaling actions to complete. Relying on auto scaling, instead of pre-scaling, can result in loss of availability.
If you use auto scaling to handle regular cycles of traffic, we strongly recommend that you configure the minimum capacity of your auto scaling to continue operating normally with the loss of an Availability Zone.
Be aware that Route 53 ARC does not inspect the health of individual resources. Amazon Web Services only starts an autoshift when Amazon Web Services telemetry detects that there is an Availability Zone impairment that could potentially impact customers. In some cases, resources might be shifted away that are not experiencing impact.
For more information about using zonal shift and zonal autoshift, see the Amazon Route 53 Application Recovery Controller Developer Guide.
Usage
arczonalshift(
config = list(),
credentials = list(),
endpoint = NULL,
region = NULL
)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...)
, where svc
is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- arczonalshift( config = list( credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string", close_connection = "logical", timeout = "numeric", s3_force_path_style = "logical", sts_regional_endpoint = "string" ), credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string" )
Operations
cancel_zonal_shift | Cancel a zonal shift in Amazon Route 53 Application Recovery Controller |
create_practice_run_configuration | A practice run configuration for zonal autoshift is required when you enable zonal autoshift |
delete_practice_run_configuration | Deletes the practice run configuration for a resource |
get_autoshift_observer_notification_status | Returns the status of autoshift observer notification |
get_managed_resource | Get information about a resource that's been registered for zonal shifts with Amazon Route 53 Application Recovery Controller in this Amazon Web Services Region |
list_autoshifts | Returns a list of autoshifts for an Amazon Web Services Region |
list_managed_resources | Lists all the resources in your Amazon Web Services account in this Amazon Web Services Region that are managed for zonal shifts in Amazon Route 53 Application Recovery Controller, and information about them |
list_zonal_shifts | Lists all active and completed zonal shifts in Amazon Route 53 Application Recovery Controller in your Amazon Web Services account in this Amazon Web Services Region |
start_zonal_shift | You start a zonal shift to temporarily move load balancer traffic away from an Availability Zone in an Amazon Web Services Region, to help your application recover immediately, for example, from a developer's bad code deployment or from an Amazon Web Services infrastructure failure in a single Availability Zone |
update_autoshift_observer_notification_status | Update the status of autoshift observer notification |
update_practice_run_configuration | Update a practice run configuration to change one or more of the following: add, change, or remove the blocking alarm; change the outcome alarm; or add, change, or remove blocking dates or time windows |
update_zonal_autoshift_configuration | The zonal autoshift configuration for a resource includes the practice run configuration and the status for running autoshifts, zonal autoshift status |
update_zonal_shift | Update an active zonal shift in Amazon Route 53 Application Recovery Controller in your Amazon Web Services account |
Examples
## Not run:
svc <- arczonalshift()
svc$cancel_zonal_shift(
Foo = 123
)
## End(Not run)
Cancel a zonal shift in Amazon Route 53 Application Recovery Controller
Description
Cancel a zonal shift in Amazon Route 53 Application Recovery Controller. To cancel the zonal shift, specify the zonal shift ID.
See https://www.paws-r-sdk.com/docs/arczonalshift_cancel_zonal_shift/ for full documentation.
Usage
arczonalshift_cancel_zonal_shift(zonalShiftId)
Arguments
zonalShiftId |
[required] The internally-generated identifier of a zonal shift. |
A practice run configuration for zonal autoshift is required when you enable zonal autoshift
Description
A practice run configuration for zonal autoshift is required when you enable zonal autoshift. A practice run configuration includes specifications for blocked dates and blocked time windows, and for Amazon CloudWatch alarms that you create to use with practice runs. The alarms that you specify are an outcome alarm, to monitor application health during practice runs and, optionally, a blocking alarm, to block practice runs from starting.
See https://www.paws-r-sdk.com/docs/arczonalshift_create_practice_run_configuration/ for full documentation.
Usage
arczonalshift_create_practice_run_configuration(
blockedDates = NULL,
blockedWindows = NULL,
blockingAlarms = NULL,
outcomeAlarms,
resourceIdentifier
)
Arguments
blockedDates |
Optionally, you can block Route 53 ARC from starting practice runs for a resource on specific calendar dates. The format for blocked dates is: YYYY-MM-DD. Keep in mind, when you specify dates, that dates and times for practice runs are in UTC. Separate multiple blocked dates with spaces. For example, if you have an application update scheduled to launch on
May 1, 2024, and you don't want practice runs to shift traffic away at
that time, you could set a blocked date for |
blockedWindows |
Optionally, you can block Route 53 ARC from starting practice runs for specific windows of days and times. The format for blocked windows is: DAY:HH:SS-DAY:HH:SS. Keep in mind, when you specify dates, that dates and times for practice runs are in UTC. Also, be aware of potential time adjustments that might be required for daylight saving time differences. Separate multiple blocked windows with spaces. For example, say you run business report summaries three days a week.
For this scenario, you might set the following recurring days and times
as blocked windows, for example:
|
blockingAlarms |
An Amazon CloudWatch alarm that you can specify for zonal autoshift
practice runs. This alarm blocks Route 53 ARC from starting practice run
zonal shifts, and ends a practice run that's in progress, when the alarm
is in an |
outcomeAlarms |
[required] The outcome alarm for practice runs is a required Amazon CloudWatch
alarm that you specify that ends a practice run when the alarm is in an
Configure the alarm to monitor the health of your application when
traffic is shifted away from an Availability Zone during each weekly
practice run. You should configure the alarm to go into an |
resourceIdentifier |
[required] The identifier of the resource that Amazon Web Services shifts traffic for with a practice run zonal shift. The identifier is the Amazon Resource Name (ARN) for the resource. At this time, supported resources are Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off. |
Deletes the practice run configuration for a resource
Description
Deletes the practice run configuration for a resource. Before you can delete a practice run configuration for a resource., you must disable zonal autoshift for the resource. Practice runs must be configured for zonal autoshift to be enabled.
See https://www.paws-r-sdk.com/docs/arczonalshift_delete_practice_run_configuration/ for full documentation.
Usage
arczonalshift_delete_practice_run_configuration(resourceIdentifier)
Arguments
resourceIdentifier |
[required] The identifier for the resource that you want to delete the practice run configuration for. The identifier is the Amazon Resource Name (ARN) for the resource. |
Returns the status of autoshift observer notification
Description
Returns the status of autoshift observer notification. Autoshift observer notification enables you to be notified, through Amazon EventBridge, when there is an autoshift event for zonal autoshift.
See https://www.paws-r-sdk.com/docs/arczonalshift_get_autoshift_observer_notification_status/ for full documentation.
Usage
arczonalshift_get_autoshift_observer_notification_status()
Get information about a resource that's been registered for zonal shifts with Amazon Route 53 Application Recovery Controller in this Amazon Web Services Region
Description
Get information about a resource that's been registered for zonal shifts with Amazon Route 53 Application Recovery Controller in this Amazon Web Services Region. Resources that are registered for zonal shifts are managed resources in Route 53 ARC. You can start zonal shifts and configure zonal autoshift for managed resources.
See https://www.paws-r-sdk.com/docs/arczonalshift_get_managed_resource/ for full documentation.
Usage
arczonalshift_get_managed_resource(resourceIdentifier)
Arguments
resourceIdentifier |
[required] The identifier for the resource that Amazon Web Services shifts traffic for. The identifier is the Amazon Resource Name (ARN) for the resource. At this time, supported resources are Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off. |
Returns a list of autoshifts for an Amazon Web Services Region
Description
Returns a list of autoshifts for an Amazon Web Services Region. By default, the call returns only ACTIVE
autoshifts. Optionally, you can specify the status
parameter to return COMPLETED
autoshifts.
See https://www.paws-r-sdk.com/docs/arczonalshift_list_autoshifts/ for full documentation.
Usage
arczonalshift_list_autoshifts(
maxResults = NULL,
nextToken = NULL,
status = NULL
)
Arguments
maxResults |
The number of objects that you want to return with this call. |
nextToken |
Specifies that you want to receive the next page of results. Valid only
if you received a |
status |
The status of the autoshift. |
Lists all the resources in your Amazon Web Services account in this Amazon Web Services Region that are managed for zonal shifts in Amazon Route 53 Application Recovery Controller, and information about them
Description
Lists all the resources in your Amazon Web Services account in this Amazon Web Services Region that are managed for zonal shifts in Amazon Route 53 Application Recovery Controller, and information about them. The information includes the zonal autoshift status for the resource, as well as the Amazon Resource Name (ARN), the Availability Zones that each resource is deployed in, and the resource name.
See https://www.paws-r-sdk.com/docs/arczonalshift_list_managed_resources/ for full documentation.
Usage
arczonalshift_list_managed_resources(maxResults = NULL, nextToken = NULL)
Arguments
maxResults |
The number of objects that you want to return with this call. |
nextToken |
Specifies that you want to receive the next page of results. Valid only
if you received a |
Lists all active and completed zonal shifts in Amazon Route 53 Application Recovery Controller in your Amazon Web Services account in this Amazon Web Services Region
Description
Lists all active and completed zonal shifts in Amazon Route 53 Application Recovery Controller in your Amazon Web Services account in this Amazon Web Services Region. list_zonal_shifts
returns customer-initiated zonal shifts, as well as practice run zonal shifts that Route 53 ARC started on your behalf for zonal autoshift.
See https://www.paws-r-sdk.com/docs/arczonalshift_list_zonal_shifts/ for full documentation.
Usage
arczonalshift_list_zonal_shifts(
maxResults = NULL,
nextToken = NULL,
resourceIdentifier = NULL,
status = NULL
)
Arguments
maxResults |
The number of objects that you want to return with this call. |
nextToken |
Specifies that you want to receive the next page of results. Valid only
if you received a |
resourceIdentifier |
The identifier for the resource that you want to list zonal shifts for. The identifier is the Amazon Resource Name (ARN) for the resource. |
status |
A status for a zonal shift. The
|
You start a zonal shift to temporarily move load balancer traffic away from an Availability Zone in an Amazon Web Services Region, to help your application recover immediately, for example, from a developer's bad code deployment or from an Amazon Web Services infrastructure failure in a single Availability Zone
Description
You start a zonal shift to temporarily move load balancer traffic away from an Availability Zone in an Amazon Web Services Region, to help your application recover immediately, for example, from a developer's bad code deployment or from an Amazon Web Services infrastructure failure in a single Availability Zone. You can start a zonal shift in Route 53 ARC only for managed resources in your Amazon Web Services account in an Amazon Web Services Region. Resources are automatically registered with Route 53 ARC by Amazon Web Services services.
See https://www.paws-r-sdk.com/docs/arczonalshift_start_zonal_shift/ for full documentation.
Usage
arczonalshift_start_zonal_shift(
awayFrom,
comment,
expiresIn,
resourceIdentifier
)
Arguments
awayFrom |
[required] The Availability Zone (for example, |
comment |
[required] A comment that you enter about the zonal shift. Only the latest comment is retained; no comment history is maintained. A new comment overwrites any existing comment string. |
expiresIn |
[required] The length of time that you want a zonal shift to be active, which Route 53 ARC converts to an expiry time (expiration time). Zonal shifts are temporary. You can set a zonal shift to be active initially for up to three days (72 hours). If you want to still keep traffic away from an Availability Zone, you can update the zonal shift and set a new expiration. You can also cancel a zonal shift, before it expires, for example, if you're ready to restore traffic to the Availability Zone. To set a length of time for a zonal shift to be active, specify a whole number, and then one of the following, with no space:
For example: |
resourceIdentifier |
[required] The identifier for the resource that Amazon Web Services shifts traffic for. The identifier is the Amazon Resource Name (ARN) for the resource. At this time, supported resources are Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off. |
Update the status of autoshift observer notification
Description
Update the status of autoshift observer notification. Autoshift observer notification enables you to be notified, through Amazon EventBridge, when there is an autoshift event for zonal autoshift.
See https://www.paws-r-sdk.com/docs/arczonalshift_update_autoshift_observer_notification_status/ for full documentation.
Usage
arczonalshift_update_autoshift_observer_notification_status(status)
Arguments
status |
[required] The status to set for autoshift observer notification. If the status is
|
Update a practice run configuration to change one or more of the following: add, change, or remove the blocking alarm; change the outcome alarm; or add, change, or remove blocking dates or time windows
Description
Update a practice run configuration to change one or more of the following: add, change, or remove the blocking alarm; change the outcome alarm; or add, change, or remove blocking dates or time windows.
See https://www.paws-r-sdk.com/docs/arczonalshift_update_practice_run_configuration/ for full documentation.
Usage
arczonalshift_update_practice_run_configuration(
blockedDates = NULL,
blockedWindows = NULL,
blockingAlarms = NULL,
outcomeAlarms = NULL,
resourceIdentifier
)
Arguments
blockedDates |
Add, change, or remove blocked dates for a practice run in zonal autoshift. Optionally, you can block practice runs for specific calendar dates. The format for blocked dates is: YYYY-MM-DD. Keep in mind, when you specify dates, that dates and times for practice runs are in UTC. Separate multiple blocked dates with spaces. For example, if you have an application update scheduled to launch on
May 1, 2024, and you don't want practice runs to shift traffic away at
that time, you could set a blocked date for |
blockedWindows |
Add, change, or remove windows of days and times for when you can, optionally, block Route 53 ARC from starting a practice run for a resource. The format for blocked windows is: DAY:HH:SS-DAY:HH:SS. Keep in mind, when you specify dates, that dates and times for practice runs are in UTC. Also, be aware of potential time adjustments that might be required for daylight saving time differences. Separate multiple blocked windows with spaces. For example, say you run business report summaries three days a week.
For this scenario, you might set the following recurring days and times
as blocked windows, for example:
|
blockingAlarms |
Add, change, or remove the Amazon CloudWatch alarm that you optionally specify as the blocking alarm for practice runs. |
outcomeAlarms |
Specify a new the Amazon CloudWatch alarm as the outcome alarm for practice runs. |
resourceIdentifier |
[required] The identifier for the resource that you want to update the practice run configuration for. The identifier is the Amazon Resource Name (ARN) for the resource. |
The zonal autoshift configuration for a resource includes the practice run configuration and the status for running autoshifts, zonal autoshift status
Description
The zonal autoshift configuration for a resource includes the practice run configuration and the status for running autoshifts, zonal autoshift status. When a resource has a practice run configuation, Route 53 ARC starts weekly zonal shifts for the resource, to shift traffic away from an Availability Zone. Weekly practice runs help you to make sure that your application can continue to operate normally with the loss of one Availability Zone.
See https://www.paws-r-sdk.com/docs/arczonalshift_update_zonal_autoshift_configuration/ for full documentation.
Usage
arczonalshift_update_zonal_autoshift_configuration(
resourceIdentifier,
zonalAutoshiftStatus
)
Arguments
resourceIdentifier |
[required] The identifier for the resource that you want to update the zonal autoshift configuration for. The identifier is the Amazon Resource Name (ARN) for the resource. |
zonalAutoshiftStatus |
[required] The zonal autoshift status for the resource that you want to update the
zonal autoshift configuration for. Choose |
Update an active zonal shift in Amazon Route 53 Application Recovery Controller in your Amazon Web Services account
Description
Update an active zonal shift in Amazon Route 53 Application Recovery Controller in your Amazon Web Services account. You can update a zonal shift to set a new expiration, or edit or replace the comment for the zonal shift.
See https://www.paws-r-sdk.com/docs/arczonalshift_update_zonal_shift/ for full documentation.
Usage
arczonalshift_update_zonal_shift(
comment = NULL,
expiresIn = NULL,
zonalShiftId
)
Arguments
comment |
A comment that you enter about the zonal shift. Only the latest comment is retained; no comment history is maintained. A new comment overwrites any existing comment string. |
expiresIn |
The length of time that you want a zonal shift to be active, which Route 53 ARC converts to an expiry time (expiration time). Zonal shifts are temporary. You can set a zonal shift to be active initially for up to three days (72 hours). If you want to still keep traffic away from an Availability Zone, you can update the zonal shift and set a new expiration. You can also cancel a zonal shift, before it expires, for example, if you're ready to restore traffic to the Availability Zone. To set a length of time for a zonal shift to be active, specify a whole number, and then one of the following, with no space:
For example: |
zonalShiftId |
[required] The identifier of a zonal shift. |
AWS Backup Gateway
Description
Backup gateway
Backup gateway connects Backup to your hypervisor, so you can create, store, and restore backups of your virtual machines (VMs) anywhere, whether on-premises or in the VMware Cloud (VMC) on Amazon Web Services.
Add on-premises resources by connecting to a hypervisor through a gateway. Backup will automatically discover the resources in your hypervisor.
Use Backup to assign virtual or on-premises resources to a backup plan, or run on-demand backups. Once you have backed up your resources, you can view them and restore them like any resource supported by Backup.
To download the Amazon Web Services software to get started, navigate to the Backup console, choose Gateways, then choose Create gateway.
Usage
backupgateway(
config = list(),
credentials = list(),
endpoint = NULL,
region = NULL
)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...)
, where svc
is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- backupgateway( config = list( credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string", close_connection = "logical", timeout = "numeric", s3_force_path_style = "logical", sts_regional_endpoint = "string" ), credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string" )
Operations
associate_gateway_to_server | Associates a backup gateway with your server |
create_gateway | Creates a backup gateway |
delete_gateway | Deletes a backup gateway |
delete_hypervisor | Deletes a hypervisor |
disassociate_gateway_from_server | Disassociates a backup gateway from the specified server |
get_bandwidth_rate_limit_schedule | Retrieves the bandwidth rate limit schedule for a specified gateway |
get_gateway | By providing the ARN (Amazon Resource Name), this API returns the gateway |
get_hypervisor | This action requests information about the specified hypervisor to which the gateway will connect |
get_hypervisor_property_mappings | This action retrieves the property mappings for the specified hypervisor |
get_virtual_machine | By providing the ARN (Amazon Resource Name), this API returns the virtual machine |
import_hypervisor_configuration | Connect to a hypervisor by importing its configuration |
list_gateways | Lists backup gateways owned by an Amazon Web Services account in an Amazon Web Services Region |
list_hypervisors | Lists your hypervisors |
list_tags_for_resource | Lists the tags applied to the resource identified by its Amazon Resource Name (ARN) |
list_virtual_machines | Lists your virtual machines |
put_bandwidth_rate_limit_schedule | This action sets the bandwidth rate limit schedule for a specified gateway |
put_hypervisor_property_mappings | This action sets the property mappings for the specified hypervisor |
put_maintenance_start_time | Set the maintenance start time for a gateway |
start_virtual_machines_metadata_sync | This action sends a request to sync metadata across the specified virtual machines |
tag_resource | Tag the resource |
test_hypervisor_configuration | Tests your hypervisor configuration to validate that backup gateway can connect with the hypervisor and its resources |
untag_resource | Removes tags from the resource |
update_gateway_information | Updates a gateway's name |
update_gateway_software_now | Updates the gateway virtual machine (VM) software |
update_hypervisor | Updates a hypervisor metadata, including its host, username, and password |
Examples
## Not run:
svc <- backupgateway()
svc$associate_gateway_to_server(
Foo = 123
)
## End(Not run)
Associates a backup gateway with your server
Description
Associates a backup gateway with your server. After you complete the association process, you can back up and restore your VMs through the gateway.
See https://www.paws-r-sdk.com/docs/backupgateway_associate_gateway_to_server/ for full documentation.
Usage
backupgateway_associate_gateway_to_server(GatewayArn, ServerArn)
Arguments
GatewayArn |
[required] The Amazon Resource Name (ARN) of the gateway. Use the
|
ServerArn |
[required] The Amazon Resource Name (ARN) of the server that hosts your virtual machines. |
Creates a backup gateway
Description
Creates a backup gateway. After you create a gateway, you can associate it with a server using the associate_gateway_to_server
operation.
See https://www.paws-r-sdk.com/docs/backupgateway_create_gateway/ for full documentation.
Usage
backupgateway_create_gateway(
ActivationKey,
GatewayDisplayName,
GatewayType,
Tags = NULL
)
Arguments
ActivationKey |
[required] The activation key of the created gateway. |
GatewayDisplayName |
[required] The display name of the created gateway. |
GatewayType |
[required] The type of created gateway. |
Tags |
A list of up to 50 tags to assign to the gateway. Each tag is a key-value pair. |
Deletes a backup gateway
Description
Deletes a backup gateway.
See https://www.paws-r-sdk.com/docs/backupgateway_delete_gateway/ for full documentation.
Usage
backupgateway_delete_gateway(GatewayArn)
Arguments
GatewayArn |
[required] The Amazon Resource Name (ARN) of the gateway to delete. |
Deletes a hypervisor
Description
Deletes a hypervisor.
See https://www.paws-r-sdk.com/docs/backupgateway_delete_hypervisor/ for full documentation.
Usage
backupgateway_delete_hypervisor(HypervisorArn)
Arguments
HypervisorArn |
[required] The Amazon Resource Name (ARN) of the hypervisor to delete. |
Disassociates a backup gateway from the specified server
Description
Disassociates a backup gateway from the specified server. After the disassociation process finishes, the gateway can no longer access the virtual machines on the server.
See https://www.paws-r-sdk.com/docs/backupgateway_disassociate_gateway_from_server/ for full documentation.
Usage
backupgateway_disassociate_gateway_from_server(GatewayArn)
Arguments
GatewayArn |
[required] The Amazon Resource Name (ARN) of the gateway to disassociate. |
Retrieves the bandwidth rate limit schedule for a specified gateway
Description
Retrieves the bandwidth rate limit schedule for a specified gateway. By default, gateways do not have bandwidth rate limit schedules, which means no bandwidth rate limiting is in effect. Use this to get a gateway's bandwidth rate limit schedule.
See https://www.paws-r-sdk.com/docs/backupgateway_get_bandwidth_rate_limit_schedule/ for full documentation.
Usage
backupgateway_get_bandwidth_rate_limit_schedule(GatewayArn)
Arguments
GatewayArn |
[required] The Amazon Resource Name (ARN) of the gateway. Use the
|
By providing the ARN (Amazon Resource Name), this API returns the gateway
Description
By providing the ARN (Amazon Resource Name), this API returns the gateway.
See https://www.paws-r-sdk.com/docs/backupgateway_get_gateway/ for full documentation.
Usage
backupgateway_get_gateway(GatewayArn)
Arguments
GatewayArn |
[required] The Amazon Resource Name (ARN) of the gateway. |
This action requests information about the specified hypervisor to which the gateway will connect
Description
This action requests information about the specified hypervisor to which the gateway will connect. A hypervisor is hardware, software, or firmware that creates and manages virtual machines, and allocates resources to them.
See https://www.paws-r-sdk.com/docs/backupgateway_get_hypervisor/ for full documentation.
Usage
backupgateway_get_hypervisor(HypervisorArn)
Arguments
HypervisorArn |
[required] The Amazon Resource Name (ARN) of the hypervisor. |
This action retrieves the property mappings for the specified hypervisor
Description
This action retrieves the property mappings for the specified hypervisor. A hypervisor property mapping displays the relationship of entity properties available from the on-premises hypervisor to the properties available in Amazon Web Services.
See https://www.paws-r-sdk.com/docs/backupgateway_get_hypervisor_property_mappings/ for full documentation.
Usage
backupgateway_get_hypervisor_property_mappings(HypervisorArn)
Arguments
HypervisorArn |
[required] The Amazon Resource Name (ARN) of the hypervisor. |
By providing the ARN (Amazon Resource Name), this API returns the virtual machine
Description
By providing the ARN (Amazon Resource Name), this API returns the virtual machine.
See https://www.paws-r-sdk.com/docs/backupgateway_get_virtual_machine/ for full documentation.
Usage
backupgateway_get_virtual_machine(ResourceArn)
Arguments
ResourceArn |
[required] The Amazon Resource Name (ARN) of the virtual machine. |
Connect to a hypervisor by importing its configuration
Description
Connect to a hypervisor by importing its configuration.
See https://www.paws-r-sdk.com/docs/backupgateway_import_hypervisor_configuration/ for full documentation.
Usage
backupgateway_import_hypervisor_configuration(
Host,
KmsKeyArn = NULL,
Name,
Password = NULL,
Tags = NULL,
Username = NULL
)
Arguments
Host |
[required] The server host of the hypervisor. This can be either an IP address or a fully-qualified domain name (FQDN). |
KmsKeyArn |
The Key Management Service for the hypervisor. |
Name |
[required] The name of the hypervisor. |
Password |
The password for the hypervisor. |
Tags |
The tags of the hypervisor configuration to import. |
Username |
The username for the hypervisor. |
Lists backup gateways owned by an Amazon Web Services account in an Amazon Web Services Region
Description
Lists backup gateways owned by an Amazon Web Services account in an Amazon Web Services Region. The returned list is ordered by gateway Amazon Resource Name (ARN).
See https://www.paws-r-sdk.com/docs/backupgateway_list_gateways/ for full documentation.
Usage
backupgateway_list_gateways(MaxResults = NULL, NextToken = NULL)
Arguments
MaxResults |
The maximum number of gateways to list. |
NextToken |
The next item following a partial list of returned resources. For
example, if a request is made to return |
Lists your hypervisors
Description
Lists your hypervisors.
See https://www.paws-r-sdk.com/docs/backupgateway_list_hypervisors/ for full documentation.
Usage
backupgateway_list_hypervisors(MaxResults = NULL, NextToken = NULL)
Arguments
MaxResults |
The maximum number of hypervisors to list. |
NextToken |
The next item following a partial list of returned resources. For
example, if a request is made to return |
Lists the tags applied to the resource identified by its Amazon Resource Name (ARN)
Description
Lists the tags applied to the resource identified by its Amazon Resource Name (ARN).
See https://www.paws-r-sdk.com/docs/backupgateway_list_tags_for_resource/ for full documentation.
Usage
backupgateway_list_tags_for_resource(ResourceArn)
Arguments
ResourceArn |
[required] The Amazon Resource Name (ARN) of the resource's tags to list. |
Lists your virtual machines
Description
Lists your virtual machines.
See https://www.paws-r-sdk.com/docs/backupgateway_list_virtual_machines/ for full documentation.
Usage
backupgateway_list_virtual_machines(
HypervisorArn = NULL,
MaxResults = NULL,
NextToken = NULL
)
Arguments
HypervisorArn |
The Amazon Resource Name (ARN) of the hypervisor connected to your virtual machine. |
MaxResults |
The maximum number of virtual machines to list. |
NextToken |
The next item following a partial list of returned resources. For
example, if a request is made to return |
This action sets the bandwidth rate limit schedule for a specified gateway
Description
This action sets the bandwidth rate limit schedule for a specified gateway. By default, gateways do not have a bandwidth rate limit schedule, which means no bandwidth rate limiting is in effect. Use this to initiate a gateway's bandwidth rate limit schedule.
See https://www.paws-r-sdk.com/docs/backupgateway_put_bandwidth_rate_limit_schedule/ for full documentation.
Usage
backupgateway_put_bandwidth_rate_limit_schedule(
BandwidthRateLimitIntervals,
GatewayArn
)
Arguments
BandwidthRateLimitIntervals |
[required] An array containing bandwidth rate limit schedule intervals for a gateway. When no bandwidth rate limit intervals have been scheduled, the array is empty. |
GatewayArn |
[required] The Amazon Resource Name (ARN) of the gateway. Use the
|
This action sets the property mappings for the specified hypervisor
Description
This action sets the property mappings for the specified hypervisor. A hypervisor property mapping displays the relationship of entity properties available from the on-premises hypervisor to the properties available in Amazon Web Services.
See https://www.paws-r-sdk.com/docs/backupgateway_put_hypervisor_property_mappings/ for full documentation.
Usage
backupgateway_put_hypervisor_property_mappings(
HypervisorArn,
IamRoleArn,
VmwareToAwsTagMappings
)
Arguments
HypervisorArn |
[required] The Amazon Resource Name (ARN) of the hypervisor. |
IamRoleArn |
[required] The Amazon Resource Name (ARN) of the IAM role. |
VmwareToAwsTagMappings |
[required] This action requests the mappings of on-premises VMware tags to the Amazon Web Services tags. |
Set the maintenance start time for a gateway
Description
Set the maintenance start time for a gateway.
See https://www.paws-r-sdk.com/docs/backupgateway_put_maintenance_start_time/ for full documentation.
Usage
backupgateway_put_maintenance_start_time(
DayOfMonth = NULL,
DayOfWeek = NULL,
GatewayArn,
HourOfDay,
MinuteOfHour
)
Arguments
DayOfMonth |
The day of the month start maintenance on a gateway. Valid values range from |
DayOfWeek |
The day of the week to start maintenance on a gateway. |
GatewayArn |
[required] The Amazon Resource Name (ARN) for the gateway, used to specify its maintenance start time. |
HourOfDay |
[required] The hour of the day to start maintenance on a gateway. |
MinuteOfHour |
[required] The minute of the hour to start maintenance on a gateway. |
This action sends a request to sync metadata across the specified virtual machines
Description
This action sends a request to sync metadata across the specified virtual machines.
See https://www.paws-r-sdk.com/docs/backupgateway_start_virtual_machines_metadata_sync/ for full documentation.
Usage
backupgateway_start_virtual_machines_metadata_sync(HypervisorArn)
Arguments
HypervisorArn |
[required] The Amazon Resource Name (ARN) of the hypervisor. |
Tag the resource
Description
Tag the resource.
See https://www.paws-r-sdk.com/docs/backupgateway_tag_resource/ for full documentation.
Usage
backupgateway_tag_resource(ResourceARN, Tags)
Arguments
ResourceARN |
[required] The Amazon Resource Name (ARN) of the resource to tag. |
Tags |
[required] A list of tags to assign to the resource. |
Tests your hypervisor configuration to validate that backup gateway can connect with the hypervisor and its resources
Description
Tests your hypervisor configuration to validate that backup gateway can connect with the hypervisor and its resources.
See https://www.paws-r-sdk.com/docs/backupgateway_test_hypervisor_configuration/ for full documentation.
Usage
backupgateway_test_hypervisor_configuration(
GatewayArn,
Host,
Password = NULL,
Username = NULL
)
Arguments
GatewayArn |
[required] The Amazon Resource Name (ARN) of the gateway to the hypervisor to test. |
Host |
[required] The server host of the hypervisor. This can be either an IP address or a fully-qualified domain name (FQDN). |
Password |
The password for the hypervisor. |
Username |
The username for the hypervisor. |
Removes tags from the resource
Description
Removes tags from the resource.
See https://www.paws-r-sdk.com/docs/backupgateway_untag_resource/ for full documentation.
Usage
backupgateway_untag_resource(ResourceARN, TagKeys)
Arguments
ResourceARN |
[required] The Amazon Resource Name (ARN) of the resource from which to remove tags. |
TagKeys |
[required] The list of tag keys specifying which tags to remove. |
Updates a gateway's name
Description
Updates a gateway's name. Specify which gateway to update using the Amazon Resource Name (ARN) of the gateway in your request.
See https://www.paws-r-sdk.com/docs/backupgateway_update_gateway_information/ for full documentation.
Usage
backupgateway_update_gateway_information(GatewayArn, GatewayDisplayName = NULL)
Arguments
GatewayArn |
[required] The Amazon Resource Name (ARN) of the gateway to update. |
GatewayDisplayName |
The updated display name of the gateway. |
Updates the gateway virtual machine (VM) software
Description
Updates the gateway virtual machine (VM) software. The request immediately triggers the software update.
See https://www.paws-r-sdk.com/docs/backupgateway_update_gateway_software_now/ for full documentation.
Usage
backupgateway_update_gateway_software_now(GatewayArn)
Arguments
GatewayArn |
[required] The Amazon Resource Name (ARN) of the gateway to be updated. |
Updates a hypervisor metadata, including its host, username, and password
Description
Updates a hypervisor metadata, including its host, username, and password. Specify which hypervisor to update using the Amazon Resource Name (ARN) of the hypervisor in your request.
See https://www.paws-r-sdk.com/docs/backupgateway_update_hypervisor/ for full documentation.
Usage
backupgateway_update_hypervisor(
Host = NULL,
HypervisorArn,
LogGroupArn = NULL,
Name = NULL,
Password = NULL,
Username = NULL
)
Arguments
Host |
The updated host of the hypervisor. This can be either an IP address or a fully-qualified domain name (FQDN). |
HypervisorArn |
[required] The Amazon Resource Name (ARN) of the hypervisor to update. |
LogGroupArn |
The Amazon Resource Name (ARN) of the group of gateways within the requested log. |
Name |
The updated name for the hypervisor |
Password |
The updated password for the hypervisor. |
Username |
The updated username for the hypervisor. |
Amazon CloudFront
Description
This is the Amazon CloudFront API Reference. This guide is for developers who need detailed information about CloudFront API actions, data types, and errors. For detailed information about CloudFront features, see the Amazon CloudFront Developer Guide.
Usage
cloudfront(
config = list(),
credentials = list(),
endpoint = NULL,
region = NULL
)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...)
, where svc
is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- cloudfront( config = list( credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string", close_connection = "logical", timeout = "numeric", s3_force_path_style = "logical", sts_regional_endpoint = "string" ), credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string" )
Operations
associate_alias | Associates an alias (also known as a CNAME or an alternate domain name) with a CloudFront distribution |
copy_distribution | Creates a staging distribution using the configuration of the provided primary distribution |
create_anycast_ip_list | Creates an Anycast static IP list |
create_cache_policy | Creates a cache policy |
create_cloud_front_origin_access_identity | Creates a new origin access identity |
create_continuous_deployment_policy | Creates a continuous deployment policy that distributes traffic for a custom domain name to two different CloudFront distributions |
create_distribution | Creates a CloudFront distribution |
create_distribution_with_tags | Create a new distribution with tags |
create_field_level_encryption_config | Create a new field-level encryption configuration |
create_field_level_encryption_profile | Create a field-level encryption profile |
create_function | Creates a CloudFront function |
create_invalidation | Create a new invalidation |
create_key_group | Creates a key group that you can use with CloudFront signed URLs and signed cookies |
create_key_value_store | Specifies the key value store resource to add to your account |
create_monitoring_subscription | Enables additional CloudWatch metrics for the specified CloudFront distribution |
create_origin_access_control | Creates a new origin access control in CloudFront |
create_origin_request_policy | Creates an origin request policy |
create_public_key | Uploads a public key to CloudFront that you can use with signed URLs and signed cookies, or with field-level encryption |
create_realtime_log_config | Creates a real-time log configuration |
create_response_headers_policy | Creates a response headers policy |
create_streaming_distribution | This API is deprecated |
create_streaming_distribution_with_tags | This API is deprecated |
create_vpc_origin | Create an Amazon CloudFront VPC origin |
delete_anycast_ip_list | Deletes an Anycast static IP list |
delete_cache_policy | Deletes a cache policy |
delete_cloud_front_origin_access_identity | Delete an origin access identity |
delete_continuous_deployment_policy | Deletes a continuous deployment policy |
delete_distribution | Delete a distribution |
delete_field_level_encryption_config | Remove a field-level encryption configuration |
delete_field_level_encryption_profile | Remove a field-level encryption profile |
delete_function | Deletes a CloudFront function |
delete_key_group | Deletes a key group |
delete_key_value_store | Specifies the key value store to delete |
delete_monitoring_subscription | Disables additional CloudWatch metrics for the specified CloudFront distribution |
delete_origin_access_control | Deletes a CloudFront origin access control |
delete_origin_request_policy | Deletes an origin request policy |
delete_public_key | Remove a public key you previously added to CloudFront |
delete_realtime_log_config | Deletes a real-time log configuration |
delete_response_headers_policy | Deletes a response headers policy |
delete_streaming_distribution | Delete a streaming distribution |
delete_vpc_origin | Delete an Amazon CloudFront VPC origin |
describe_function | Gets configuration information and metadata about a CloudFront function, but not the function's code |
describe_key_value_store | Specifies the key value store and its configuration |
get_anycast_ip_list | Gets an Anycast static IP list |
get_cache_policy | Gets a cache policy, including the following metadata: |
get_cache_policy_config | Gets a cache policy configuration |
get_cloud_front_origin_access_identity | Get the information about an origin access identity |
get_cloud_front_origin_access_identity_config | Get the configuration information about an origin access identity |
get_continuous_deployment_policy | Gets a continuous deployment policy, including metadata (the policy's identifier and the date and time when the policy was last modified) |
get_continuous_deployment_policy_config | Gets configuration information about a continuous deployment policy |
get_distribution | Get the information about a distribution |
get_distribution_config | Get the configuration information about a distribution |
get_field_level_encryption | Get the field-level encryption configuration information |
get_field_level_encryption_config | Get the field-level encryption configuration information |
get_field_level_encryption_profile | Get the field-level encryption profile information |
get_field_level_encryption_profile_config | Get the field-level encryption profile configuration information |
get_function | Gets the code of a CloudFront function |
get_invalidation | Get the information about an invalidation |
get_key_group | Gets a key group, including the date and time when the key group was last modified |
get_key_group_config | Gets a key group configuration |
get_monitoring_subscription | Gets information about whether additional CloudWatch metrics are enabled for the specified CloudFront distribution |
get_origin_access_control | Gets a CloudFront origin access control, including its unique identifier |
get_origin_access_control_config | Gets a CloudFront origin access control configuration |
get_origin_request_policy | Gets an origin request policy, including the following metadata: |
get_origin_request_policy_config | Gets an origin request policy configuration |
get_public_key | Gets a public key |
get_public_key_config | Gets a public key configuration |
get_realtime_log_config | Gets a real-time log configuration |
get_response_headers_policy | Gets a response headers policy, including metadata (the policy's identifier and the date and time when the policy was last modified) |
get_response_headers_policy_config | Gets a response headers policy configuration |
get_streaming_distribution | Gets information about a specified RTMP distribution, including the distribution configuration |
get_streaming_distribution_config | Get the configuration information about a streaming distribution |
get_vpc_origin | Get the details of an Amazon CloudFront VPC origin |
list_anycast_ip_lists | Lists your Anycast static IP lists |
list_cache_policies | Gets a list of cache policies |
list_cloud_front_origin_access_identities | Lists origin access identities |
list_conflicting_aliases | Gets a list of aliases (also called CNAMEs or alternate domain names) that conflict or overlap with the provided alias, and the associated CloudFront distributions and Amazon Web Services accounts for each conflicting alias |
list_continuous_deployment_policies | Gets a list of the continuous deployment policies in your Amazon Web Services account |
list_distributions | List CloudFront distributions |
list_distributions_by_anycast_ip_list_id | Lists the distributions in your account that are associated with the specified AnycastIpListId |
list_distributions_by_cache_policy_id | Gets a list of distribution IDs for distributions that have a cache behavior that's associated with the specified cache policy |
list_distributions_by_key_group | Gets a list of distribution IDs for distributions that have a cache behavior that references the specified key group |
list_distributions_by_origin_request_policy_id | Gets a list of distribution IDs for distributions that have a cache behavior that's associated with the specified origin request policy |
list_distributions_by_realtime_log_config | Gets a list of distributions that have a cache behavior that's associated with the specified real-time log configuration |
list_distributions_by_response_headers_policy_id | Gets a list of distribution IDs for distributions that have a cache behavior that's associated with the specified response headers policy |
list_distributions_by_vpc_origin_id | List CloudFront distributions by their VPC origin ID |
list_distributions_by_web_acl_id | List the distributions that are associated with a specified WAF web ACL |
list_field_level_encryption_configs | List all field-level encryption configurations that have been created in CloudFront for this account |
list_field_level_encryption_profiles | Request a list of field-level encryption profiles that have been created in CloudFront for this account |
list_functions | Gets a list of all CloudFront functions in your Amazon Web Services account |
list_invalidations | Lists invalidation batches |
list_key_groups | Gets a list of key groups |
list_key_value_stores | Specifies the key value stores to list |
list_origin_access_controls | Gets the list of CloudFront origin access controls (OACs) in this Amazon Web Services account |
list_origin_request_policies | Gets a list of origin request policies |
list_public_keys | List all public keys that have been added to CloudFront for this account |
list_realtime_log_configs | Gets a list of real-time log configurations |
list_response_headers_policies | Gets a list of response headers policies |
list_streaming_distributions | List streaming distributions |
list_tags_for_resource | List tags for a CloudFront resource |
list_vpc_origins | List the CloudFront VPC origins in your account |
publish_function | Publishes a CloudFront function by copying the function code from the DEVELOPMENT stage to LIVE |
tag_resource | Add tags to a CloudFront resource |
test_function | Tests a CloudFront function |
untag_resource | Remove tags from a CloudFront resource |
update_cache_policy | Updates a cache policy configuration |
update_cloud_front_origin_access_identity | Update an origin access identity |
update_continuous_deployment_policy | Updates a continuous deployment policy |
update_distribution | Updates the configuration for a CloudFront distribution |
update_distribution_with_staging_config | Copies the staging distribution's configuration to its corresponding primary distribution |
update_field_level_encryption_config | Update a field-level encryption configuration |
update_field_level_encryption_profile | Update a field-level encryption profile |
update_function | Updates a CloudFront function |
update_key_group | Updates a key group |
update_key_value_store | Specifies the key value store to update |
update_origin_access_control | Updates a CloudFront origin access control |
update_origin_request_policy | Updates an origin request policy configuration |
update_public_key | Update public key information |
update_realtime_log_config | Updates a real-time log configuration |
update_response_headers_policy | Updates a response headers policy |
update_streaming_distribution | Update a streaming distribution |
update_vpc_origin | Update an Amazon CloudFront VPC origin in your account |
Examples
## Not run:
svc <- cloudfront()
svc$associate_alias(
Foo = 123
)
## End(Not run)
Associates an alias (also known as a CNAME or an alternate domain name) with a CloudFront distribution
Description
Associates an alias (also known as a CNAME or an alternate domain name) with a CloudFront distribution.
See https://www.paws-r-sdk.com/docs/cloudfront_associate_alias/ for full documentation.
Usage
cloudfront_associate_alias(TargetDistributionId, Alias)
Arguments
TargetDistributionId |
[required] The ID of the distribution that you're associating the alias with. |
Alias |
[required] The alias (also known as a CNAME) to add to the target distribution. |
Creates a staging distribution using the configuration of the provided primary distribution
Description
Creates a staging distribution using the configuration of the provided primary distribution. A staging distribution is a copy of an existing distribution (called the primary distribution) that you can use in a continuous deployment workflow.
See https://www.paws-r-sdk.com/docs/cloudfront_copy_distribution/ for full documentation.
Usage
cloudfront_copy_distribution(
PrimaryDistributionId,
Staging = NULL,
IfMatch = NULL,
CallerReference,
Enabled = NULL
)
Arguments
PrimaryDistributionId |
[required] The identifier of the primary distribution whose configuration you are
copying. To get a distribution ID, use
|
Staging |
The type of distribution that your primary distribution will be copied
to. The only valid value is |
IfMatch |
The version identifier of the primary distribution whose configuration
you are copying. This is the |
CallerReference |
[required] A value that uniquely identifies a request to create a resource. This helps to prevent CloudFront from creating a duplicate resource if you accidentally resubmit an identical request. |
Enabled |
A Boolean flag to specify the state of the staging distribution when
it's created. When you set this value to If you omit this field, the default value is |
Creates an Anycast static IP list
Description
Creates an Anycast static IP list.
See https://www.paws-r-sdk.com/docs/cloudfront_create_anycast_ip_list/ for full documentation.
Usage
cloudfront_create_anycast_ip_list(Name, IpCount, Tags = NULL)
Arguments
Name |
[required] Name of the Anycast static IP list. |
IpCount |
[required] The number of static IP addresses that are allocated to the Anycast static IP list. |
Tags |
Creates a cache policy
Description
Creates a cache policy.
See https://www.paws-r-sdk.com/docs/cloudfront_create_cache_policy/ for full documentation.
Usage
cloudfront_create_cache_policy(CachePolicyConfig)
Arguments
CachePolicyConfig |
[required] A cache policy configuration. |
Creates a new origin access identity
Description
Creates a new origin access identity. If you're using Amazon S3 for your origin, you can use an origin access identity to require users to access your content using a CloudFront URL instead of the Amazon S3 URL. For more information about how to use origin access identities, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.
See https://www.paws-r-sdk.com/docs/cloudfront_create_cloud_front_origin_access_identity/ for full documentation.
Usage
cloudfront_create_cloud_front_origin_access_identity(
CloudFrontOriginAccessIdentityConfig
)
Arguments
CloudFrontOriginAccessIdentityConfig |
[required] The current configuration information for the identity. |
Creates a continuous deployment policy that distributes traffic for a custom domain name to two different CloudFront distributions
Description
Creates a continuous deployment policy that distributes traffic for a custom domain name to two different CloudFront distributions.
See https://www.paws-r-sdk.com/docs/cloudfront_create_continuous_deployment_policy/ for full documentation.
Usage
cloudfront_create_continuous_deployment_policy(
ContinuousDeploymentPolicyConfig
)
Arguments
ContinuousDeploymentPolicyConfig |
[required] Contains the configuration for a continuous deployment policy. |
Creates a CloudFront distribution
Description
Creates a CloudFront distribution.
See https://www.paws-r-sdk.com/docs/cloudfront_create_distribution/ for full documentation.
Usage
cloudfront_create_distribution(DistributionConfig)
Arguments
DistributionConfig |
[required] The distribution's configuration information. |
Create a new distribution with tags
Description
Create a new distribution with tags. This API operation requires the following IAM permissions:
See https://www.paws-r-sdk.com/docs/cloudfront_create_distribution_with_tags/ for full documentation.
Usage
cloudfront_create_distribution_with_tags(DistributionConfigWithTags)
Arguments
DistributionConfigWithTags |
[required] The distribution's configuration information. |
Create a new field-level encryption configuration
Description
Create a new field-level encryption configuration.
See https://www.paws-r-sdk.com/docs/cloudfront_create_field_level_encryption_config/ for full documentation.
Usage
cloudfront_create_field_level_encryption_config(FieldLevelEncryptionConfig)
Arguments
FieldLevelEncryptionConfig |
[required] The request to create a new field-level encryption configuration. |
Create a field-level encryption profile
Description
Create a field-level encryption profile.
See https://www.paws-r-sdk.com/docs/cloudfront_create_field_level_encryption_profile/ for full documentation.
Usage
cloudfront_create_field_level_encryption_profile(
FieldLevelEncryptionProfileConfig
)
Arguments
FieldLevelEncryptionProfileConfig |
[required] The request to create a field-level encryption profile. |
Creates a CloudFront function
Description
Creates a CloudFront function.
See https://www.paws-r-sdk.com/docs/cloudfront_create_function/ for full documentation.
Usage
cloudfront_create_function(Name, FunctionConfig, FunctionCode)
Arguments
Name |
[required] A name to identify the function. |
FunctionConfig |
[required] Configuration information about the function, including an optional comment and the function's runtime. |
FunctionCode |
[required] The function code. For more information about writing a CloudFront function, see Writing function code for CloudFront Functions in the Amazon CloudFront Developer Guide. |
Create a new invalidation
Description
Create a new invalidation. For more information, see Invalidating files in the Amazon CloudFront Developer Guide.
See https://www.paws-r-sdk.com/docs/cloudfront_create_invalidation/ for full documentation.
Usage
cloudfront_create_invalidation(DistributionId, InvalidationBatch)
Arguments
DistributionId |
[required] The distribution's id. |
InvalidationBatch |
[required] The batch information for the invalidation. |
Creates a key group that you can use with CloudFront signed URLs and signed cookies
Description
Creates a key group that you can use with CloudFront signed URLs and signed cookies.
See https://www.paws-r-sdk.com/docs/cloudfront_create_key_group/ for full documentation.
Usage
cloudfront_create_key_group(KeyGroupConfig)
Arguments
KeyGroupConfig |
[required] A key group configuration. |
Specifies the key value store resource to add to your account
Description
Specifies the key value store resource to add to your account. In your account, the key value store names must be unique. You can also import key value store data in JSON format from an S3 bucket by providing a valid ImportSource
that you own.
See https://www.paws-r-sdk.com/docs/cloudfront_create_key_value_store/ for full documentation.
Usage
cloudfront_create_key_value_store(Name, Comment = NULL, ImportSource = NULL)
Arguments
Name |
[required] The name of the key value store. The minimum length is 1 character and the maximum length is 64 characters. |
Comment |
The comment of the key value store. |
ImportSource |
The S3 bucket that provides the source for the import. The source must be in a valid JSON format. |
Enables additional CloudWatch metrics for the specified CloudFront distribution
Description
Enables additional CloudWatch metrics for the specified CloudFront distribution. The additional metrics incur an additional cost.
See https://www.paws-r-sdk.com/docs/cloudfront_create_monitoring_subscription/ for full documentation.
Usage
cloudfront_create_monitoring_subscription(
DistributionId,
MonitoringSubscription
)
Arguments
DistributionId |
[required] The ID of the distribution that you are enabling metrics for. |
MonitoringSubscription |
[required] A monitoring subscription. This structure contains information about whether additional CloudWatch metrics are enabled for a given CloudFront distribution. |
Creates a new origin access control in CloudFront
Description
Creates a new origin access control in CloudFront. After you create an origin access control, you can add it to an origin in a CloudFront distribution so that CloudFront sends authenticated (signed) requests to the origin.
See https://www.paws-r-sdk.com/docs/cloudfront_create_origin_access_control/ for full documentation.
Usage
cloudfront_create_origin_access_control(OriginAccessControlConfig)
Arguments
OriginAccessControlConfig |
[required] Contains the origin access control. |
Creates an origin request policy
Description
Creates an origin request policy.
See https://www.paws-r-sdk.com/docs/cloudfront_create_origin_request_policy/ for full documentation.
Usage
cloudfront_create_origin_request_policy(OriginRequestPolicyConfig)
Arguments
OriginRequestPolicyConfig |
[required] An origin request policy configuration. |
Uploads a public key to CloudFront that you can use with signed URLs and signed cookies, or with field-level encryption
Description
Uploads a public key to CloudFront that you can use with signed URLs and signed cookies, or with field-level encryption.
See https://www.paws-r-sdk.com/docs/cloudfront_create_public_key/ for full documentation.
Usage
cloudfront_create_public_key(PublicKeyConfig)
Arguments
PublicKeyConfig |
[required] A CloudFront public key configuration. |
Creates a real-time log configuration
Description
Creates a real-time log configuration.
See https://www.paws-r-sdk.com/docs/cloudfront_create_realtime_log_config/ for full documentation.
Usage
cloudfront_create_realtime_log_config(EndPoints, Fields, Name, SamplingRate)
Arguments
EndPoints |
[required] Contains information about the Amazon Kinesis data stream where you are sending real-time log data. |
Fields |
[required] A list of fields to include in each real-time log record. For more information about fields, see Real-time log configuration fields in the Amazon CloudFront Developer Guide. |
Name |
[required] A unique name to identify this real-time log configuration. |
SamplingRate |
[required] The sampling rate for this real-time log configuration. You can specify a whole number between 1 and 100 (inclusive) to determine the percentage of viewer requests that are represented in the real-time log data. |
Creates a response headers policy
Description
Creates a response headers policy.
See https://www.paws-r-sdk.com/docs/cloudfront_create_response_headers_policy/ for full documentation.
Usage
cloudfront_create_response_headers_policy(ResponseHeadersPolicyConfig)
Arguments
ResponseHeadersPolicyConfig |
[required] Contains metadata about the response headers policy, and a set of configurations that specify the HTTP headers. |
This API is deprecated
Description
This API is deprecated. Amazon CloudFront is deprecating real-time messaging protocol (RTMP) distributions on December 31, 2020. For more information, read the announcement on the Amazon CloudFront discussion forum.
See https://www.paws-r-sdk.com/docs/cloudfront_create_streaming_distribution/ for full documentation.
Usage
cloudfront_create_streaming_distribution(StreamingDistributionConfig)
Arguments
StreamingDistributionConfig |
[required] The streaming distribution's configuration information. |
This API is deprecated
Description
This API is deprecated. Amazon CloudFront is deprecating real-time messaging protocol (RTMP) distributions on December 31, 2020. For more information, read the announcement on the Amazon CloudFront discussion forum.
See https://www.paws-r-sdk.com/docs/cloudfront_create_streaming_distribution_with_tags/ for full documentation.
Usage
cloudfront_create_streaming_distribution_with_tags(
StreamingDistributionConfigWithTags
)
Arguments
StreamingDistributionConfigWithTags |
[required] The streaming distribution's configuration information. |
Create an Amazon CloudFront VPC origin
Description
Create an Amazon CloudFront VPC origin.
See https://www.paws-r-sdk.com/docs/cloudfront_create_vpc_origin/ for full documentation.
Usage
cloudfront_create_vpc_origin(VpcOriginEndpointConfig, Tags = NULL)
Arguments
VpcOriginEndpointConfig |
[required] The VPC origin endpoint configuration. |
Tags |
Deletes an Anycast static IP list
Description
Deletes an Anycast static IP list.
See https://www.paws-r-sdk.com/docs/cloudfront_delete_anycast_ip_list/ for full documentation.
Usage
cloudfront_delete_anycast_ip_list(Id, IfMatch)
Arguments
Id |
[required] The ID of the Anycast static IP list. |
IfMatch |
[required] The current version ( |
Deletes a cache policy
Description
Deletes a cache policy.
See https://www.paws-r-sdk.com/docs/cloudfront_delete_cache_policy/ for full documentation.
Usage
cloudfront_delete_cache_policy(Id, IfMatch = NULL)
Arguments
Id |
[required] The unique identifier for the cache policy that you are deleting. To get
the identifier, you can use
|
IfMatch |
The version of the cache policy that you are deleting. The version is
the cache policy's |
Delete an origin access identity
Description
Delete an origin access identity.
See https://www.paws-r-sdk.com/docs/cloudfront_delete_cloud_front_origin_access_identity/ for full documentation.
Usage
cloudfront_delete_cloud_front_origin_access_identity(Id, IfMatch = NULL)
Arguments
Id |
[required] The origin access identity's ID. |
IfMatch |
The value of the |
Deletes a continuous deployment policy
Description
Deletes a continuous deployment policy.
See https://www.paws-r-sdk.com/docs/cloudfront_delete_continuous_deployment_policy/ for full documentation.
Usage
cloudfront_delete_continuous_deployment_policy(Id, IfMatch = NULL)
Arguments
Id |
[required] The identifier of the continuous deployment policy that you are deleting. |
IfMatch |
The current version ( |
Delete a distribution
Description
Delete a distribution.
See https://www.paws-r-sdk.com/docs/cloudfront_delete_distribution/ for full documentation.
Usage
cloudfront_delete_distribution(Id, IfMatch = NULL)
Arguments
Id |
[required] The distribution ID. |
IfMatch |
The value of the |
Remove a field-level encryption configuration
Description
Remove a field-level encryption configuration.
See https://www.paws-r-sdk.com/docs/cloudfront_delete_field_level_encryption_config/ for full documentation.
Usage
cloudfront_delete_field_level_encryption_config(Id, IfMatch = NULL)
Arguments
Id |
[required] The ID of the configuration you want to delete from CloudFront. |
IfMatch |
The value of the |
Remove a field-level encryption profile
Description
Remove a field-level encryption profile.
See https://www.paws-r-sdk.com/docs/cloudfront_delete_field_level_encryption_profile/ for full documentation.
Usage
cloudfront_delete_field_level_encryption_profile(Id, IfMatch = NULL)
Arguments
Id |
[required] Request the ID of the profile you want to delete from CloudFront. |
IfMatch |
The value of the |
Deletes a CloudFront function
Description
Deletes a CloudFront function.
See https://www.paws-r-sdk.com/docs/cloudfront_delete_function/ for full documentation.
Usage
cloudfront_delete_function(Name, IfMatch)
Arguments
Name |
[required] The name of the function that you are deleting. |
IfMatch |
[required] The current version ( |
Deletes a key group
Description
Deletes a key group.
See https://www.paws-r-sdk.com/docs/cloudfront_delete_key_group/ for full documentation.
Usage
cloudfront_delete_key_group(Id, IfMatch = NULL)
Arguments
Id |
[required] The identifier of the key group that you are deleting. To get the
identifier, use |
IfMatch |
The version of the key group that you are deleting. The version is the
key group's |
Specifies the key value store to delete
Description
Specifies the key value store to delete.
See https://www.paws-r-sdk.com/docs/cloudfront_delete_key_value_store/ for full documentation.
Usage
cloudfront_delete_key_value_store(Name, IfMatch)
Arguments
Name |
[required] The name of the key value store. |
IfMatch |
[required] The key value store to delete, if a match occurs. |
Disables additional CloudWatch metrics for the specified CloudFront distribution
Description
Disables additional CloudWatch metrics for the specified CloudFront distribution.
See https://www.paws-r-sdk.com/docs/cloudfront_delete_monitoring_subscription/ for full documentation.
Usage
cloudfront_delete_monitoring_subscription(DistributionId)
Arguments
DistributionId |
[required] The ID of the distribution that you are disabling metrics for. |
Deletes a CloudFront origin access control
Description
Deletes a CloudFront origin access control.
See https://www.paws-r-sdk.com/docs/cloudfront_delete_origin_access_control/ for full documentation.
Usage
cloudfront_delete_origin_access_control(Id, IfMatch = NULL)
Arguments
Id |
[required] The unique identifier of the origin access control that you are deleting. |
IfMatch |
The current version ( |
Deletes an origin request policy
Description
Deletes an origin request policy.
See https://www.paws-r-sdk.com/docs/cloudfront_delete_origin_request_policy/ for full documentation.
Usage
cloudfront_delete_origin_request_policy(Id, IfMatch = NULL)
Arguments
Id |
[required] The unique identifier for the origin request policy that you are
deleting. To get the identifier, you can use
|
IfMatch |
The version of the origin request policy that you are deleting. The
version is the origin request policy's |
Remove a public key you previously added to CloudFront
Description
Remove a public key you previously added to CloudFront.
See https://www.paws-r-sdk.com/docs/cloudfront_delete_public_key/ for full documentation.
Usage
cloudfront_delete_public_key(Id, IfMatch = NULL)
Arguments
Id |
[required] The ID of the public key you want to remove from CloudFront. |
IfMatch |
The value of the |
Deletes a real-time log configuration
Description
Deletes a real-time log configuration.
See https://www.paws-r-sdk.com/docs/cloudfront_delete_realtime_log_config/ for full documentation.
Usage
cloudfront_delete_realtime_log_config(Name = NULL, ARN = NULL)
Arguments
Name |
The name of the real-time log configuration to delete. |
ARN |
The Amazon Resource Name (ARN) of the real-time log configuration to delete. |
Deletes a response headers policy
Description
Deletes a response headers policy.
See https://www.paws-r-sdk.com/docs/cloudfront_delete_response_headers_policy/ for full documentation.
Usage
cloudfront_delete_response_headers_policy(Id, IfMatch = NULL)
Arguments
Id |
[required] The identifier for the response headers policy that you are deleting. To get the identifier, you can use
|
IfMatch |
The version of the response headers policy that you are deleting. The version is the response headers policy's |
Delete a streaming distribution
Description
Delete a streaming distribution. To delete an RTMP distribution using the CloudFront API, perform the following steps.
See https://www.paws-r-sdk.com/docs/cloudfront_delete_streaming_distribution/ for full documentation.
Usage
cloudfront_delete_streaming_distribution(Id, IfMatch = NULL)
Arguments
Id |
[required] The distribution ID. |
IfMatch |
The value of the |
Delete an Amazon CloudFront VPC origin
Description
Delete an Amazon CloudFront VPC origin.
See https://www.paws-r-sdk.com/docs/cloudfront_delete_vpc_origin/ for full documentation.
Usage
cloudfront_delete_vpc_origin(Id, IfMatch)
Arguments
Id |
[required] The VPC origin ID. |
IfMatch |
[required] The version identifier of the VPC origin to delete. This is the |
Gets configuration information and metadata about a CloudFront function, but not the function's code
Description
Gets configuration information and metadata about a CloudFront function, but not the function's code. To get a function's code, use get_function
.
See https://www.paws-r-sdk.com/docs/cloudfront_describe_function/ for full documentation.
Usage
cloudfront_describe_function(Name, Stage = NULL)
Arguments
Name |
[required] The name of the function that you are getting information about. |
Stage |
The function's stage, either |
Specifies the key value store and its configuration
Description
Specifies the key value store and its configuration.
See https://www.paws-r-sdk.com/docs/cloudfront_describe_key_value_store/ for full documentation.
Usage
cloudfront_describe_key_value_store(Name)
Arguments
Name |
[required] The name of the key value store. |
Gets an Anycast static IP list
Description
Gets an Anycast static IP list.
See https://www.paws-r-sdk.com/docs/cloudfront_get_anycast_ip_list/ for full documentation.
Usage
cloudfront_get_anycast_ip_list(Id)
Arguments
Id |
[required] The ID of the Anycast static IP list. |
Gets a cache policy, including the following metadata:
Description
Gets a cache policy, including the following metadata:
See https://www.paws-r-sdk.com/docs/cloudfront_get_cache_policy/ for full documentation.
Usage
cloudfront_get_cache_policy(Id)
Arguments
Id |
[required] The unique identifier for the cache policy. If the cache policy is
attached to a distribution's cache behavior, you can get the policy's
identifier using |
Gets a cache policy configuration
Description
Gets a cache policy configuration.
See https://www.paws-r-sdk.com/docs/cloudfront_get_cache_policy_config/ for full documentation.
Usage
cloudfront_get_cache_policy_config(Id)
Arguments
Id |
[required] The unique identifier for the cache policy. If the cache policy is
attached to a distribution's cache behavior, you can get the policy's
identifier using |
Get the information about an origin access identity
Description
Get the information about an origin access identity.
See https://www.paws-r-sdk.com/docs/cloudfront_get_cloud_front_origin_access_identity/ for full documentation.
Usage
cloudfront_get_cloud_front_origin_access_identity(Id)
Arguments
Id |
[required] The identity's ID. |
Get the configuration information about an origin access identity
Description
Get the configuration information about an origin access identity.
See https://www.paws-r-sdk.com/docs/cloudfront_get_cloud_front_origin_access_identity_config/ for full documentation.
Usage
cloudfront_get_cloud_front_origin_access_identity_config(Id)
Arguments
Id |
[required] The identity's ID. |
Gets a continuous deployment policy, including metadata (the policy's identifier and the date and time when the policy was last modified)
Description
Gets a continuous deployment policy, including metadata (the policy's identifier and the date and time when the policy was last modified).
See https://www.paws-r-sdk.com/docs/cloudfront_get_continuous_deployment_policy/ for full documentation.
Usage
cloudfront_get_continuous_deployment_policy(Id)
Arguments
Id |
[required] The identifier of the continuous deployment policy that you are getting. |
Gets configuration information about a continuous deployment policy
Description
Gets configuration information about a continuous deployment policy.
See https://www.paws-r-sdk.com/docs/cloudfront_get_continuous_deployment_policy_config/ for full documentation.
Usage
cloudfront_get_continuous_deployment_policy_config(Id)
Arguments
Id |
[required] The identifier of the continuous deployment policy whose configuration you are getting. |
Get the information about a distribution
Description
Get the information about a distribution.
See https://www.paws-r-sdk.com/docs/cloudfront_get_distribution/ for full documentation.
Usage
cloudfront_get_distribution(Id)
Arguments
Id |
[required] The distribution's ID. If the ID is empty, an empty distribution configuration is returned. |
Get the configuration information about a distribution
Description
Get the configuration information about a distribution.
See https://www.paws-r-sdk.com/docs/cloudfront_get_distribution_config/ for full documentation.
Usage
cloudfront_get_distribution_config(Id)
Arguments
Id |
[required] The distribution's ID. If the ID is empty, an empty distribution configuration is returned. |
Get the field-level encryption configuration information
Description
Get the field-level encryption configuration information.
See https://www.paws-r-sdk.com/docs/cloudfront_get_field_level_encryption/ for full documentation.
Usage
cloudfront_get_field_level_encryption(Id)
Arguments
Id |
[required] Request the ID for the field-level encryption configuration information. |
Get the field-level encryption configuration information
Description
Get the field-level encryption configuration information.
See https://www.paws-r-sdk.com/docs/cloudfront_get_field_level_encryption_config/ for full documentation.
Usage
cloudfront_get_field_level_encryption_config(Id)
Arguments
Id |
[required] Request the ID for the field-level encryption configuration information. |
Get the field-level encryption profile information
Description
Get the field-level encryption profile information.
See https://www.paws-r-sdk.com/docs/cloudfront_get_field_level_encryption_profile/ for full documentation.
Usage
cloudfront_get_field_level_encryption_profile(Id)
Arguments
Id |
[required] Get the ID for the field-level encryption profile information. |
Get the field-level encryption profile configuration information
Description
Get the field-level encryption profile configuration information.
See https://www.paws-r-sdk.com/docs/cloudfront_get_field_level_encryption_profile_config/ for full documentation.
Usage
cloudfront_get_field_level_encryption_profile_config(Id)
Arguments
Id |
[required] Get the ID for the field-level encryption profile configuration information. |
Gets the code of a CloudFront function
Description
Gets the code of a CloudFront function. To get configuration information and metadata about a function, use describe_function
.
See https://www.paws-r-sdk.com/docs/cloudfront_get_function/ for full documentation.
Usage
cloudfront_get_function(Name, Stage = NULL)
Arguments
Name |
[required] The name of the function whose code you are getting. |
Stage |
The function's stage, either |
Get the information about an invalidation
Description
Get the information about an invalidation.
See https://www.paws-r-sdk.com/docs/cloudfront_get_invalidation/ for full documentation.
Usage
cloudfront_get_invalidation(DistributionId, Id)
Arguments
DistributionId |
[required] The distribution's ID. |
Id |
[required] The identifier for the invalidation request, for example,
|
Gets a key group, including the date and time when the key group was last modified
Description
Gets a key group, including the date and time when the key group was last modified.
See https://www.paws-r-sdk.com/docs/cloudfront_get_key_group/ for full documentation.
Usage
cloudfront_get_key_group(Id)
Arguments
Id |
[required] The identifier of the key group that you are getting. To get the
identifier, use |
Gets a key group configuration
Description
Gets a key group configuration.
See https://www.paws-r-sdk.com/docs/cloudfront_get_key_group_config/ for full documentation.
Usage
cloudfront_get_key_group_config(Id)
Arguments
Id |
[required] The identifier of the key group whose configuration you are getting. To
get the identifier, use |
Gets information about whether additional CloudWatch metrics are enabled for the specified CloudFront distribution
Description
Gets information about whether additional CloudWatch metrics are enabled for the specified CloudFront distribution.
See https://www.paws-r-sdk.com/docs/cloudfront_get_monitoring_subscription/ for full documentation.
Usage
cloudfront_get_monitoring_subscription(DistributionId)
Arguments
DistributionId |
[required] The ID of the distribution that you are getting metrics information for. |
Gets a CloudFront origin access control, including its unique identifier
Description
Gets a CloudFront origin access control, including its unique identifier.
See https://www.paws-r-sdk.com/docs/cloudfront_get_origin_access_control/ for full documentation.
Usage
cloudfront_get_origin_access_control(Id)
Arguments
Id |
[required] The unique identifier of the origin access control. |
Gets a CloudFront origin access control configuration
Description
Gets a CloudFront origin access control configuration.
See https://www.paws-r-sdk.com/docs/cloudfront_get_origin_access_control_config/ for full documentation.
Usage
cloudfront_get_origin_access_control_config(Id)
Arguments
Id |
[required] The unique identifier of the origin access control. |
Gets an origin request policy, including the following metadata:
Description
Gets an origin request policy, including the following metadata:
See https://www.paws-r-sdk.com/docs/cloudfront_get_origin_request_policy/ for full documentation.
Usage
cloudfront_get_origin_request_policy(Id)
Arguments
Id |
[required] The unique identifier for the origin request policy. If the origin
request policy is attached to a distribution's cache behavior, you can
get the policy's identifier using
|
Gets an origin request policy configuration
Description
Gets an origin request policy configuration.
See https://www.paws-r-sdk.com/docs/cloudfront_get_origin_request_policy_config/ for full documentation.
Usage
cloudfront_get_origin_request_policy_config(Id)
Arguments
Id |
[required] The unique identifier for the origin request policy. If the origin
request policy is attached to a distribution's cache behavior, you can
get the policy's identifier using
|
Gets a public key
Description
Gets a public key.
See https://www.paws-r-sdk.com/docs/cloudfront_get_public_key/ for full documentation.
Usage
cloudfront_get_public_key(Id)
Arguments
Id |
[required] The identifier of the public key you are getting. |
Gets a public key configuration
Description
Gets a public key configuration.
See https://www.paws-r-sdk.com/docs/cloudfront_get_public_key_config/ for full documentation.
Usage
cloudfront_get_public_key_config(Id)
Arguments
Id |
[required] The identifier of the public key whose configuration you are getting. |
Gets a real-time log configuration
Description
Gets a real-time log configuration.
See https://www.paws-r-sdk.com/docs/cloudfront_get_realtime_log_config/ for full documentation.
Usage
cloudfront_get_realtime_log_config(Name = NULL, ARN = NULL)
Arguments
Name |
The name of the real-time log configuration to get. |
ARN |
The Amazon Resource Name (ARN) of the real-time log configuration to get. |
Gets a response headers policy, including metadata (the policy's identifier and the date and time when the policy was last modified)
Description
Gets a response headers policy, including metadata (the policy's identifier and the date and time when the policy was last modified).
See https://www.paws-r-sdk.com/docs/cloudfront_get_response_headers_policy/ for full documentation.
Usage
cloudfront_get_response_headers_policy(Id)
Arguments
Id |
[required] The identifier for the response headers policy. If the response headers policy is attached to a distribution's cache
behavior, you can get the policy's identifier using
|
Gets a response headers policy configuration
Description
Gets a response headers policy configuration.
See https://www.paws-r-sdk.com/docs/cloudfront_get_response_headers_policy_config/ for full documentation.
Usage
cloudfront_get_response_headers_policy_config(Id)
Arguments
Id |
[required] The identifier for the response headers policy. If the response headers policy is attached to a distribution's cache
behavior, you can get the policy's identifier using
|
Gets information about a specified RTMP distribution, including the distribution configuration
Description
Gets information about a specified RTMP distribution, including the distribution configuration.
See https://www.paws-r-sdk.com/docs/cloudfront_get_streaming_distribution/ for full documentation.
Usage
cloudfront_get_streaming_distribution(Id)
Arguments
Id |
[required] The streaming distribution's ID. |
Get the configuration information about a streaming distribution
Description
Get the configuration information about a streaming distribution.
See https://www.paws-r-sdk.com/docs/cloudfront_get_streaming_distribution_config/ for full documentation.
Usage
cloudfront_get_streaming_distribution_config(Id)
Arguments
Id |
[required] The streaming distribution's ID. |
Get the details of an Amazon CloudFront VPC origin
Description
Get the details of an Amazon CloudFront VPC origin.
See https://www.paws-r-sdk.com/docs/cloudfront_get_vpc_origin/ for full documentation.
Usage
cloudfront_get_vpc_origin(Id)
Arguments
Id |
[required] The VPC origin ID. |
Lists your Anycast static IP lists
Description
Lists your Anycast static IP lists.
See https://www.paws-r-sdk.com/docs/cloudfront_list_anycast_ip_lists/ for full documentation.
Usage
cloudfront_list_anycast_ip_lists(Marker = NULL, MaxItems = NULL)
Arguments
Marker |
Use this field when paginating results to indicate where to begin in
your list. The response includes items in the list that occur after the
marker. To get the next page of the list, set this field's value to the
value of |
MaxItems |
The maximum number of Anycast static IP lists that you want returned in the response. |
Gets a list of cache policies
Description
Gets a list of cache policies.
See https://www.paws-r-sdk.com/docs/cloudfront_list_cache_policies/ for full documentation.
Usage
cloudfront_list_cache_policies(Type = NULL, Marker = NULL, MaxItems = NULL)
Arguments
Type |
A filter to return only the specified kinds of cache policies. Valid values are:
|
Marker |
Use this field when paginating results to indicate where to begin in
your list of cache policies. The response includes cache policies in the
list that occur after the marker. To get the next page of the list, set
this field's value to the value of |
MaxItems |
The maximum number of cache policies that you want in the response. |
Lists origin access identities
Description
Lists origin access identities.
See https://www.paws-r-sdk.com/docs/cloudfront_list_cloud_front_origin_access_identities/ for full documentation.
Usage
cloudfront_list_cloud_front_origin_access_identities(
Marker = NULL,
MaxItems = NULL
)
Arguments
Marker |
Use this when paginating results to indicate where to begin in your list
of origin access identities. The results include identities in the list
that occur after the marker. To get the next page of results, set the
|
MaxItems |
The maximum number of origin access identities you want in the response body. |
Gets a list of aliases (also called CNAMEs or alternate domain names) that conflict or overlap with the provided alias, and the associated CloudFront distributions and Amazon Web Services accounts for each conflicting alias
Description
Gets a list of aliases (also called CNAMEs or alternate domain names) that conflict or overlap with the provided alias, and the associated CloudFront distributions and Amazon Web Services accounts for each conflicting alias. In the returned list, the distribution and account IDs are partially hidden, which allows you to identify the distributions and accounts that you own, but helps to protect the information of ones that you don't own.
See https://www.paws-r-sdk.com/docs/cloudfront_list_conflicting_aliases/ for full documentation.
Usage
cloudfront_list_conflicting_aliases(
DistributionId,
Alias,
Marker = NULL,
MaxItems = NULL
)
Arguments
DistributionId |
[required] The ID of a distribution in your account that has an attached SSL/TLS certificate that includes the provided alias. |
Alias |
[required] The alias (also called a CNAME) to search for conflicting aliases. |
Marker |
Use this field when paginating results to indicate where to begin in the
list of conflicting aliases. The response includes conflicting aliases
in the list that occur after the marker. To get the next page of the
list, set this field's value to the value of |
MaxItems |
The maximum number of conflicting aliases that you want in the response. |
Gets a list of the continuous deployment policies in your Amazon Web Services account
Description
Gets a list of the continuous deployment policies in your Amazon Web Services account.
See https://www.paws-r-sdk.com/docs/cloudfront_list_continuous_deployment_policies/ for full documentation.
Usage
cloudfront_list_continuous_deployment_policies(Marker = NULL, MaxItems = NULL)
Arguments
Marker |
Use this field when paginating results to indicate where to begin in
your list of continuous deployment policies. The response includes
policies in the list that occur after the marker. To get the next page
of the list, set this field's value to the value of |
MaxItems |
The maximum number of continuous deployment policies that you want returned in the response. |
List CloudFront distributions
Description
List CloudFront distributions.
See https://www.paws-r-sdk.com/docs/cloudfront_list_distributions/ for full documentation.
Usage
cloudfront_list_distributions(Marker = NULL, MaxItems = NULL)
Arguments
Marker |
Use this when paginating results to indicate where to begin in your list
of distributions. The results include distributions in the list that
occur after the marker. To get the next page of results, set the
|
MaxItems |
The maximum number of distributions you want in the response body. |
Lists the distributions in your account that are associated with the specified AnycastIpListId
Description
Lists the distributions in your account that are associated with the specified AnycastIpListId
.
See https://www.paws-r-sdk.com/docs/cloudfront_list_distributions_by_anycast_ip_list_id/ for full documentation.
Usage
cloudfront_list_distributions_by_anycast_ip_list_id(
Marker = NULL,
MaxItems = NULL,
AnycastIpListId
)
Arguments
Marker |
Use this field when paginating results to indicate where to begin in
your list. The response includes items in the list that occur after the
marker. To get the next page of the list, set this field's value to the
value of |
MaxItems |
The maximum number of distributions that you want returned in the response. |
AnycastIpListId |
[required] The ID of the Anycast static IP list. |
Gets a list of distribution IDs for distributions that have a cache behavior that's associated with the specified cache policy
Description
Gets a list of distribution IDs for distributions that have a cache behavior that's associated with the specified cache policy.
See https://www.paws-r-sdk.com/docs/cloudfront_list_distributions_by_cache_policy_id/ for full documentation.
Usage
cloudfront_list_distributions_by_cache_policy_id(
Marker = NULL,
MaxItems = NULL,
CachePolicyId
)
Arguments
Marker |
Use this field when paginating results to indicate where to begin in
your list of distribution IDs. The response includes distribution IDs in
the list that occur after the marker. To get the next page of the list,
set this field's value to the value of |
MaxItems |
The maximum number of distribution IDs that you want in the response. |
CachePolicyId |
[required] The ID of the cache policy whose associated distribution IDs you want to list. |
Gets a list of distribution IDs for distributions that have a cache behavior that references the specified key group
Description
Gets a list of distribution IDs for distributions that have a cache behavior that references the specified key group.
See https://www.paws-r-sdk.com/docs/cloudfront_list_distributions_by_key_group/ for full documentation.
Usage
cloudfront_list_distributions_by_key_group(
Marker = NULL,
MaxItems = NULL,
KeyGroupId
)
Arguments
Marker |
Use this field when paginating results to indicate where to begin in
your list of distribution IDs. The response includes distribution IDs in
the list that occur after the marker. To get the next page of the list,
set this field's value to the value of |
MaxItems |
The maximum number of distribution IDs that you want in the response. |
KeyGroupId |
[required] The ID of the key group whose associated distribution IDs you are listing. |
Gets a list of distribution IDs for distributions that have a cache behavior that's associated with the specified origin request policy
Description
Gets a list of distribution IDs for distributions that have a cache behavior that's associated with the specified origin request policy.
See https://www.paws-r-sdk.com/docs/cloudfront_list_distributions_by_origin_request_policy_id/ for full documentation.
Usage
cloudfront_list_distributions_by_origin_request_policy_id(
Marker = NULL,
MaxItems = NULL,
OriginRequestPolicyId
)
Arguments
Marker |
Use this field when paginating results to indicate where to begin in
your list of distribution IDs. The response includes distribution IDs in
the list that occur after the marker. To get the next page of the list,
set this field's value to the value of |
MaxItems |
The maximum number of distribution IDs that you want in the response. |
OriginRequestPolicyId |
[required] The ID of the origin request policy whose associated distribution IDs you want to list. |
Gets a list of distributions that have a cache behavior that's associated with the specified real-time log configuration
Description
Gets a list of distributions that have a cache behavior that's associated with the specified real-time log configuration.
See https://www.paws-r-sdk.com/docs/cloudfront_list_distributions_by_realtime_log_config/ for full documentation.
Usage
cloudfront_list_distributions_by_realtime_log_config(
Marker = NULL,
MaxItems = NULL,
RealtimeLogConfigName = NULL,
RealtimeLogConfigArn = NULL
)
Arguments
Marker |
Use this field when paginating results to indicate where to begin in
your list of distributions. The response includes distributions in the
list that occur after the marker. To get the next page of the list, set
this field's value to the value of |
MaxItems |
The maximum number of distributions that you want in the response. |
RealtimeLogConfigName |
The name of the real-time log configuration whose associated distributions you want to list. |
RealtimeLogConfigArn |
The Amazon Resource Name (ARN) of the real-time log configuration whose associated distributions you want to list. |
Gets a list of distribution IDs for distributions that have a cache behavior that's associated with the specified response headers policy
Description
Gets a list of distribution IDs for distributions that have a cache behavior that's associated with the specified response headers policy.
See https://www.paws-r-sdk.com/docs/cloudfront_list_distributions_by_response_headers_policy_id/ for full documentation.
Usage
cloudfront_list_distributions_by_response_headers_policy_id(
Marker = NULL,
MaxItems = NULL,
ResponseHeadersPolicyId
)
Arguments
Marker |
Use this field when paginating results to indicate where to begin in
your list of distribution IDs. The response includes distribution IDs in
the list that occur after the marker. To get the next page of the list,
set this field's value to the value of |
MaxItems |
The maximum number of distribution IDs that you want to get in the response. |
ResponseHeadersPolicyId |
[required] The ID of the response headers policy whose associated distribution IDs you want to list. |
List CloudFront distributions by their VPC origin ID
Description
List CloudFront distributions by their VPC origin ID.
See https://www.paws-r-sdk.com/docs/cloudfront_list_distributions_by_vpc_origin_id/ for full documentation.
Usage
cloudfront_list_distributions_by_vpc_origin_id(
Marker = NULL,
MaxItems = NULL,
VpcOriginId
)
Arguments
Marker |
The marker associated with the VPC origin distributions list. |
MaxItems |
The maximum number of items included in the list. |
VpcOriginId |
[required] The VPC origin ID. |
List the distributions that are associated with a specified WAF web ACL
Description
List the distributions that are associated with a specified WAF web ACL.
See https://www.paws-r-sdk.com/docs/cloudfront_list_distributions_by_web_acl_id/ for full documentation.
Usage
cloudfront_list_distributions_by_web_acl_id(
Marker = NULL,
MaxItems = NULL,
WebACLId
)
Arguments
Marker |
Use |
MaxItems |
The maximum number of distributions that you want CloudFront to return in the response body. The maximum and default values are both 100. |
WebACLId |
[required] The ID of the WAF web ACL that you want to list the associated distributions. If you specify "null" for the ID, the request returns a list of the distributions that aren't associated with a web ACL. For WAFV2, this is the ARN of the web ACL, such as
For WAF Classic, this is the ID of the web ACL, such as
|
List all field-level encryption configurations that have been created in CloudFront for this account
Description
List all field-level encryption configurations that have been created in CloudFront for this account.
See https://www.paws-r-sdk.com/docs/cloudfront_list_field_level_encryption_configs/ for full documentation.
Usage
cloudfront_list_field_level_encryption_configs(Marker = NULL, MaxItems = NULL)
Arguments
Marker |
Use this when paginating results to indicate where to begin in your list
of configurations. The results include configurations in the list that
occur after the marker. To get the next page of results, set the
|
MaxItems |
The maximum number of field-level encryption configurations you want in the response body. |
Request a list of field-level encryption profiles that have been created in CloudFront for this account
Description
Request a list of field-level encryption profiles that have been created in CloudFront for this account.
See https://www.paws-r-sdk.com/docs/cloudfront_list_field_level_encryption_profiles/ for full documentation.
Usage
cloudfront_list_field_level_encryption_profiles(Marker = NULL, MaxItems = NULL)
Arguments
Marker |
Use this when paginating results to indicate where to begin in your list
of profiles. The results include profiles in the list that occur after
the marker. To get the next page of results, set the |
MaxItems |
The maximum number of field-level encryption profiles you want in the response body. |
Gets a list of all CloudFront functions in your Amazon Web Services account
Description
Gets a list of all CloudFront functions in your Amazon Web Services account.
See https://www.paws-r-sdk.com/docs/cloudfront_list_functions/ for full documentation.
Usage
cloudfront_list_functions(Marker = NULL, MaxItems = NULL, Stage = NULL)
Arguments
Marker |
Use this field when paginating results to indicate where to begin in
your list of functions. The response includes functions in the list that
occur after the marker. To get the next page of the list, set this
field's value to the value of |
MaxItems |
The maximum number of functions that you want in the response. |
Stage |
An optional filter to return only the functions that are in the
specified stage, either |
Lists invalidation batches
Description
Lists invalidation batches.
See https://www.paws-r-sdk.com/docs/cloudfront_list_invalidations/ for full documentation.
Usage
cloudfront_list_invalidations(DistributionId, Marker = NULL, MaxItems = NULL)
Arguments
DistributionId |
[required] The distribution's ID. |
Marker |
Use this parameter when paginating results to indicate where to begin in
your list of invalidation batches. Because the results are returned in
decreasing order from most recent to oldest, the most recent results are
on the first page, the second page will contain earlier results, and so
on. To get the next page of results, set |
MaxItems |
The maximum number of invalidation batches that you want in the response body. |
Gets a list of key groups
Description
Gets a list of key groups.
See https://www.paws-r-sdk.com/docs/cloudfront_list_key_groups/ for full documentation.
Usage
cloudfront_list_key_groups(Marker = NULL, MaxItems = NULL)
Arguments
Marker |
Use this field when paginating results to indicate where to begin in
your list of key groups. The response includes key groups in the list
that occur after the marker. To get the next page of the list, set this
field's value to the value of |
MaxItems |
The maximum number of key groups that you want in the response. |
Specifies the key value stores to list
Description
Specifies the key value stores to list.
See https://www.paws-r-sdk.com/docs/cloudfront_list_key_value_stores/ for full documentation.
Usage
cloudfront_list_key_value_stores(Marker = NULL, MaxItems = NULL, Status = NULL)
Arguments
Marker |
The marker associated with the key value stores list. |
MaxItems |
The maximum number of items in the key value stores list. |
Status |
The status of the request for the key value stores list. |
Gets the list of CloudFront origin access controls (OACs) in this Amazon Web Services account
Description
Gets the list of CloudFront origin access controls (OACs) in this Amazon Web Services account.
See https://www.paws-r-sdk.com/docs/cloudfront_list_origin_access_controls/ for full documentation.
Usage
cloudfront_list_origin_access_controls(Marker = NULL, MaxItems = NULL)
Arguments
Marker |
Use this field when paginating results to indicate where to begin in
your list of origin access controls. The response includes the items in
the list that occur after the marker. To get the next page of the list,
set this field's value to the value of |
MaxItems |
The maximum number of origin access controls that you want in the response. |
Gets a list of origin request policies
Description
Gets a list of origin request policies.
See https://www.paws-r-sdk.com/docs/cloudfront_list_origin_request_policies/ for full documentation.
Usage
cloudfront_list_origin_request_policies(
Type = NULL,
Marker = NULL,
MaxItems = NULL
)
Arguments
Type |
A filter to return only the specified kinds of origin request policies. Valid values are:
|
Marker |
Use this field when paginating results to indicate where to begin in
your list of origin request policies. The response includes origin
request policies in the list that occur after the marker. To get the
next page of the list, set this field's value to the value of
|
MaxItems |
The maximum number of origin request policies that you want in the response. |
List all public keys that have been added to CloudFront for this account
Description
List all public keys that have been added to CloudFront for this account.
See https://www.paws-r-sdk.com/docs/cloudfront_list_public_keys/ for full documentation.
Usage
cloudfront_list_public_keys(Marker = NULL, MaxItems = NULL)
Arguments
Marker |
Use this when paginating results to indicate where to begin in your list
of public keys. The results include public keys in the list that occur
after the marker. To get the next page of results, set the |
MaxItems |
The maximum number of public keys you want in the response body. |
Gets a list of real-time log configurations
Description
Gets a list of real-time log configurations.
See https://www.paws-r-sdk.com/docs/cloudfront_list_realtime_log_configs/ for full documentation.
Usage
cloudfront_list_realtime_log_configs(MaxItems = NULL, Marker = NULL)
Arguments
MaxItems |
The maximum number of real-time log configurations that you want in the response. |
Marker |
Use this field when paginating results to indicate where to begin in
your list of real-time log configurations. The response includes
real-time log configurations in the list that occur after the marker. To
get the next page of the list, set this field's value to the value of
|
Gets a list of response headers policies
Description
Gets a list of response headers policies.
See https://www.paws-r-sdk.com/docs/cloudfront_list_response_headers_policies/ for full documentation.
Usage
cloudfront_list_response_headers_policies(
Type = NULL,
Marker = NULL,
MaxItems = NULL
)
Arguments
Type |
A filter to get only the specified kind of response headers policies. Valid values are:
|
Marker |
Use this field when paginating results to indicate where to begin in
your list of response headers policies. The response includes response
headers policies in the list that occur after the marker. To get the
next page of the list, set this field's value to the value of
|
MaxItems |
The maximum number of response headers policies that you want to get in the response. |
List streaming distributions
Description
List streaming distributions.
See https://www.paws-r-sdk.com/docs/cloudfront_list_streaming_distributions/ for full documentation.
Usage
cloudfront_list_streaming_distributions(Marker = NULL, MaxItems = NULL)
Arguments
Marker |
The value that you provided for the |
MaxItems |
The value that you provided for the |
List tags for a CloudFront resource
Description
List tags for a CloudFront resource. For more information, see Tagging a distribution in the Amazon CloudFront Developer Guide.
See https://www.paws-r-sdk.com/docs/cloudfront_list_tags_for_resource/ for full documentation.
Usage
cloudfront_list_tags_for_resource(Resource)
Arguments
Resource |
[required] An ARN of a CloudFront resource. |
List the CloudFront VPC origins in your account
Description
List the CloudFront VPC origins in your account.
See https://www.paws-r-sdk.com/docs/cloudfront_list_vpc_origins/ for full documentation.
Usage
cloudfront_list_vpc_origins(Marker = NULL, MaxItems = NULL)
Arguments
Marker |
The marker associated with the VPC origins list. |
MaxItems |
The maximum number of items included in the list. |
Publishes a CloudFront function by copying the function code from the DEVELOPMENT stage to LIVE
Description
Publishes a CloudFront function by copying the function code from the DEVELOPMENT
stage to LIVE
. This automatically updates all cache behaviors that are using this function to use the newly published copy in the LIVE
stage.
See https://www.paws-r-sdk.com/docs/cloudfront_publish_function/ for full documentation.
Usage
cloudfront_publish_function(Name, IfMatch)
Arguments
Name |
[required] The name of the function that you are publishing. |
IfMatch |
[required] The current version ( |
Add tags to a CloudFront resource
Description
Add tags to a CloudFront resource. For more information, see Tagging a distribution in the Amazon CloudFront Developer Guide.
See https://www.paws-r-sdk.com/docs/cloudfront_tag_resource/ for full documentation.
Usage
cloudfront_tag_resource(Resource, Tags)
Arguments
Resource |
[required] An ARN of a CloudFront resource. |
Tags |
[required] A complex type that contains zero or more |
Tests a CloudFront function
Description
Tests a CloudFront function.
See https://www.paws-r-sdk.com/docs/cloudfront_test_function/ for full documentation.
Usage
cloudfront_test_function(Name, IfMatch, Stage = NULL, EventObject)
Arguments
Name |
[required] The name of the function that you are testing. |
IfMatch |
[required] The current version ( |
Stage |
The stage of the function that you are testing, either |
EventObject |
[required] The event object to test the function with. For more information about the structure of the event object, see Testing functions in the Amazon CloudFront Developer Guide. |
Remove tags from a CloudFront resource
Description
Remove tags from a CloudFront resource. For more information, see Tagging a distribution in the Amazon CloudFront Developer Guide.
See https://www.paws-r-sdk.com/docs/cloudfront_untag_resource/ for full documentation.
Usage
cloudfront_untag_resource(Resource, TagKeys)
Arguments
Resource |
[required] An ARN of a CloudFront resource. |
TagKeys |
[required] A complex type that contains zero or more |
Updates a cache policy configuration
Description
Updates a cache policy configuration.
See https://www.paws-r-sdk.com/docs/cloudfront_update_cache_policy/ for full documentation.
Usage
cloudfront_update_cache_policy(CachePolicyConfig, Id, IfMatch = NULL)
Arguments
CachePolicyConfig |
[required] A cache policy configuration. |
Id |
[required] The unique identifier for the cache policy that you are updating. The
identifier is returned in a cache behavior's |
IfMatch |
The version of the cache policy that you are updating. The version is
returned in the cache policy's |
Update an origin access identity
Description
Update an origin access identity.
See https://www.paws-r-sdk.com/docs/cloudfront_update_cloud_front_origin_access_identity/ for full documentation.
Usage
cloudfront_update_cloud_front_origin_access_identity(
CloudFrontOriginAccessIdentityConfig,
Id,
IfMatch = NULL
)
Arguments
CloudFrontOriginAccessIdentityConfig |
[required] The identity's configuration information. |
Id |
[required] The identity's id. |
IfMatch |
The value of the |
Updates a continuous deployment policy
Description
Updates a continuous deployment policy. You can update a continuous deployment policy to enable or disable it, to change the percentage of traffic that it sends to the staging distribution, or to change the staging distribution that it sends traffic to.
See https://www.paws-r-sdk.com/docs/cloudfront_update_continuous_deployment_policy/ for full documentation.
Usage
cloudfront_update_continuous_deployment_policy(
ContinuousDeploymentPolicyConfig,
Id,
IfMatch = NULL
)
Arguments
ContinuousDeploymentPolicyConfig |
[required] The continuous deployment policy configuration. |
Id |
[required] The identifier of the continuous deployment policy that you are updating. |
IfMatch |
The current version ( |
Updates the configuration for a CloudFront distribution
Description
Updates the configuration for a CloudFront distribution.
See https://www.paws-r-sdk.com/docs/cloudfront_update_distribution/ for full documentation.
Usage
cloudfront_update_distribution(DistributionConfig, Id, IfMatch = NULL)
Arguments
DistributionConfig |
[required] The distribution's configuration information. |
Id |
[required] The distribution's id. |
IfMatch |
The value of the |
Copies the staging distribution's configuration to its corresponding primary distribution
Description
Copies the staging distribution's configuration to its corresponding primary distribution. The primary distribution retains its Aliases
(also known as alternate domain names or CNAMEs) and ContinuousDeploymentPolicyId
value, but otherwise its configuration is overwritten to match the staging distribution.
See https://www.paws-r-sdk.com/docs/cloudfront_update_distribution_with_staging_config/ for full documentation.
Usage
cloudfront_update_distribution_with_staging_config(
Id,
StagingDistributionId = NULL,
IfMatch = NULL
)
Arguments
Id |
[required] The identifier of the primary distribution to which you are copying a staging distribution's configuration. |
StagingDistributionId |
The identifier of the staging distribution whose configuration you are copying to the primary distribution. |
IfMatch |
The current versions (
|
Update a field-level encryption configuration
Description
Update a field-level encryption configuration.
See https://www.paws-r-sdk.com/docs/cloudfront_update_field_level_encryption_config/ for full documentation.
Usage
cloudfront_update_field_level_encryption_config(
FieldLevelEncryptionConfig,
Id,
IfMatch = NULL
)
Arguments
FieldLevelEncryptionConfig |
[required] Request to update a field-level encryption configuration. |
Id |
[required] The ID of the configuration you want to update. |
IfMatch |
The value of the |
Update a field-level encryption profile
Description
Update a field-level encryption profile.
See https://www.paws-r-sdk.com/docs/cloudfront_update_field_level_encryption_profile/ for full documentation.
Usage
cloudfront_update_field_level_encryption_profile(
FieldLevelEncryptionProfileConfig,
Id,
IfMatch = NULL
)
Arguments
FieldLevelEncryptionProfileConfig |
[required] Request to update a field-level encryption profile. |
Id |
[required] The ID of the field-level encryption profile request. |
IfMatch |
The value of the |
Updates a CloudFront function
Description
Updates a CloudFront function.
See https://www.paws-r-sdk.com/docs/cloudfront_update_function/ for full documentation.
Usage
cloudfront_update_function(Name, IfMatch, FunctionConfig, FunctionCode)
Arguments
Name |
[required] The name of the function that you are updating. |
IfMatch |
[required] The current version ( |
FunctionConfig |
[required] Configuration information about the function. |
FunctionCode |
[required] The function code. For more information about writing a CloudFront function, see Writing function code for CloudFront Functions in the Amazon CloudFront Developer Guide. |
Updates a key group
Description
Updates a key group.
See https://www.paws-r-sdk.com/docs/cloudfront_update_key_group/ for full documentation.
Usage
cloudfront_update_key_group(KeyGroupConfig, Id, IfMatch = NULL)
Arguments
KeyGroupConfig |
[required] The key group configuration. |
Id |
[required] The identifier of the key group that you are updating. |
IfMatch |
The version of the key group that you are updating. The version is the
key group's |
Specifies the key value store to update
Description
Specifies the key value store to update.
See https://www.paws-r-sdk.com/docs/cloudfront_update_key_value_store/ for full documentation.
Usage
cloudfront_update_key_value_store(Name, Comment, IfMatch)
Arguments
Name |
[required] The name of the key value store to update. |
Comment |
[required] The comment of the key value store to update. |
IfMatch |
[required] The key value store to update, if a match occurs. |
Updates a CloudFront origin access control
Description
Updates a CloudFront origin access control.
See https://www.paws-r-sdk.com/docs/cloudfront_update_origin_access_control/ for full documentation.
Usage
cloudfront_update_origin_access_control(
OriginAccessControlConfig,
Id,
IfMatch = NULL
)
Arguments
OriginAccessControlConfig |
[required] An origin access control. |
Id |
[required] The unique identifier of the origin access control that you are updating. |
IfMatch |
The current version ( |
Updates an origin request policy configuration
Description
Updates an origin request policy configuration.
See https://www.paws-r-sdk.com/docs/cloudfront_update_origin_request_policy/ for full documentation.
Usage
cloudfront_update_origin_request_policy(
OriginRequestPolicyConfig,
Id,
IfMatch = NULL
)
Arguments
OriginRequestPolicyConfig |
[required] An origin request policy configuration. |
Id |
[required] The unique identifier for the origin request policy that you are
updating. The identifier is returned in a cache behavior's
|
IfMatch |
The version of the origin request policy that you are updating. The
version is returned in the origin request policy's |
Update public key information
Description
Update public key information. Note that the only value you can change is the comment.
See https://www.paws-r-sdk.com/docs/cloudfront_update_public_key/ for full documentation.
Usage
cloudfront_update_public_key(PublicKeyConfig, Id, IfMatch = NULL)
Arguments
PublicKeyConfig |
[required] A public key configuration. |
Id |
[required] The identifier of the public key that you are updating. |
IfMatch |
The value of the |
Updates a real-time log configuration
Description
Updates a real-time log configuration.
See https://www.paws-r-sdk.com/docs/cloudfront_update_realtime_log_config/ for full documentation.
Usage
cloudfront_update_realtime_log_config(
EndPoints = NULL,
Fields = NULL,
Name = NULL,
ARN = NULL,
SamplingRate = NULL
)
Arguments
EndPoints |
Contains information about the Amazon Kinesis data stream where you are sending real-time log data. |
Fields |
A list of fields to include in each real-time log record. For more information about fields, see Real-time log configuration fields in the Amazon CloudFront Developer Guide. |
Name |
The name for this real-time log configuration. |
ARN |
The Amazon Resource Name (ARN) for this real-time log configuration. |
SamplingRate |
The sampling rate for this real-time log configuration. The sampling rate determines the percentage of viewer requests that are represented in the real-time log data. You must provide an integer between 1 and 100, inclusive. |
Updates a response headers policy
Description
Updates a response headers policy.
See https://www.paws-r-sdk.com/docs/cloudfront_update_response_headers_policy/ for full documentation.
Usage
cloudfront_update_response_headers_policy(
ResponseHeadersPolicyConfig,
Id,
IfMatch = NULL
)
Arguments
ResponseHeadersPolicyConfig |
[required] A response headers policy configuration. |
Id |
[required] The identifier for the response headers policy that you are updating. |
IfMatch |
The version of the response headers policy that you are updating. The version is returned in the cache policy's |
Update a streaming distribution
Description
Update a streaming distribution.
See https://www.paws-r-sdk.com/docs/cloudfront_update_streaming_distribution/ for full documentation.
Usage
cloudfront_update_streaming_distribution(
StreamingDistributionConfig,
Id,
IfMatch = NULL
)
Arguments
StreamingDistributionConfig |
[required] The streaming distribution's configuration information. |
Id |
[required] The streaming distribution's id. |
IfMatch |
The value of the |
Update an Amazon CloudFront VPC origin in your account
Description
Update an Amazon CloudFront VPC origin in your account.
See https://www.paws-r-sdk.com/docs/cloudfront_update_vpc_origin/ for full documentation.
Usage
cloudfront_update_vpc_origin(VpcOriginEndpointConfig, Id, IfMatch)
Arguments
VpcOriginEndpointConfig |
[required] The VPC origin endpoint configuration. |
Id |
[required] The VPC origin ID. |
IfMatch |
[required] The VPC origin to update, if a match occurs. |
Amazon CloudFront KeyValueStore
Description
Amazon CloudFront KeyValueStore Service to View and Update Data in a KVS Resource
Usage
cloudfrontkeyvaluestore(
config = list(),
credentials = list(),
endpoint = NULL,
region = NULL
)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...)
, where svc
is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- cloudfrontkeyvaluestore( config = list( credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string", close_connection = "logical", timeout = "numeric", s3_force_path_style = "logical", sts_regional_endpoint = "string" ), credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string" )
Operations
delete_key | Deletes the key value pair specified by the key |
describe_key_value_store | Returns metadata information about Key Value Store |
get_key | Returns a key value pair |
list_keys | Returns a list of key value pairs |
put_key | Creates a new key value pair or replaces the value of an existing key |
update_keys | Puts or Deletes multiple key value pairs in a single, all-or-nothing operation |
Examples
## Not run:
svc <- cloudfrontkeyvaluestore()
svc$delete_key(
Foo = 123
)
## End(Not run)
Deletes the key value pair specified by the key
Description
Deletes the key value pair specified by the key.
See https://www.paws-r-sdk.com/docs/cloudfrontkeyvaluestore_delete_key/ for full documentation.
Usage
cloudfrontkeyvaluestore_delete_key(KvsARN, Key, IfMatch)
Arguments
KvsARN |
[required] The Amazon Resource Name (ARN) of the Key Value Store. |
Key |
[required] The key to delete. |
IfMatch |
[required] The current version (ETag) of the Key Value Store that you are deleting keys from, which you can get using DescribeKeyValueStore. |
Returns metadata information about Key Value Store
Description
Returns metadata information about Key Value Store.
See https://www.paws-r-sdk.com/docs/cloudfrontkeyvaluestore_describe_key_value_store/ for full documentation.
Usage
cloudfrontkeyvaluestore_describe_key_value_store(KvsARN)
Arguments
KvsARN |
[required] The Amazon Resource Name (ARN) of the Key Value Store. |
Returns a key value pair
Description
Returns a key value pair.
See https://www.paws-r-sdk.com/docs/cloudfrontkeyvaluestore_get_key/ for full documentation.
Usage
cloudfrontkeyvaluestore_get_key(KvsARN, Key)
Arguments
KvsARN |
[required] The Amazon Resource Name (ARN) of the Key Value Store. |
Key |
[required] The key to get. |
Returns a list of key value pairs
Description
Returns a list of key value pairs.
See https://www.paws-r-sdk.com/docs/cloudfrontkeyvaluestore_list_keys/ for full documentation.
Usage
cloudfrontkeyvaluestore_list_keys(KvsARN, NextToken = NULL, MaxResults = NULL)
Arguments
KvsARN |
[required] The Amazon Resource Name (ARN) of the Key Value Store. |
NextToken |
If nextToken is returned in the response, there are more results available. Make the next call using the returned token to retrieve the next page. |
MaxResults |
Maximum number of results that are returned per call. The default is 10 and maximum allowed page is 50. |
Creates a new key value pair or replaces the value of an existing key
Description
Creates a new key value pair or replaces the value of an existing key.
See https://www.paws-r-sdk.com/docs/cloudfrontkeyvaluestore_put_key/ for full documentation.
Usage
cloudfrontkeyvaluestore_put_key(Key, Value, KvsARN, IfMatch)
Arguments
Key |
[required] The key to put. |
Value |
[required] The value to put. |
KvsARN |
[required] The Amazon Resource Name (ARN) of the Key Value Store. |
IfMatch |
[required] The current version (ETag) of the Key Value Store that you are putting keys into, which you can get using DescribeKeyValueStore. |
Puts or Deletes multiple key value pairs in a single, all-or-nothing operation
Description
Puts or Deletes multiple key value pairs in a single, all-or-nothing operation.
See https://www.paws-r-sdk.com/docs/cloudfrontkeyvaluestore_update_keys/ for full documentation.
Usage
cloudfrontkeyvaluestore_update_keys(
KvsARN,
IfMatch,
Puts = NULL,
Deletes = NULL
)
Arguments
KvsARN |
[required] The Amazon Resource Name (ARN) of the Key Value Store. |
IfMatch |
[required] The current version (ETag) of the Key Value Store that you are updating keys of, which you can get using DescribeKeyValueStore. |
Puts |
List of key value pairs to put. |
Deletes |
List of keys to delete. |
AWS Direct Connect
Description
Direct Connect links your internal network to an Direct Connect location over a standard Ethernet fiber-optic cable. One end of the cable is connected to your router, the other to an Direct Connect router. With this connection in place, you can create virtual interfaces directly to the Amazon Web Services Cloud (for example, to Amazon EC2 and Amazon S3) and to Amazon VPC, bypassing Internet service providers in your network path. A connection provides access to all Amazon Web Services Regions except the China (Beijing) and (China) Ningxia Regions. Amazon Web Services resources in the China Regions can only be accessed through locations associated with those Regions.
Usage
directconnect(
config = list(),
credentials = list(),
endpoint = NULL,
region = NULL
)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...)
, where svc
is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- directconnect( config = list( credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string", close_connection = "logical", timeout = "numeric", s3_force_path_style = "logical", sts_regional_endpoint = "string" ), credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string" )
Operations
accept_direct_connect_gateway_association_proposal | Accepts a proposal request to attach a virtual private gateway or transit gateway to a Direct Connect gateway |
allocate_connection_on_interconnect | Deprecated |
allocate_hosted_connection | Creates a hosted connection on the specified interconnect or a link aggregation group (LAG) of interconnects |
allocate_private_virtual_interface | Provisions a private virtual interface to be owned by the specified Amazon Web Services account |
allocate_public_virtual_interface | Provisions a public virtual interface to be owned by the specified Amazon Web Services account |
allocate_transit_virtual_interface | Provisions a transit virtual interface to be owned by the specified Amazon Web Services account |
associate_connection_with_lag | Associates an existing connection with a link aggregation group (LAG) |
associate_hosted_connection | Associates a hosted connection and its virtual interfaces with a link aggregation group (LAG) or interconnect |
associate_mac_sec_key | Associates a MAC Security (MACsec) Connection Key Name (CKN)/ Connectivity Association Key (CAK) pair with an Direct Connect dedicated connection |
associate_virtual_interface | Associates a virtual interface with a specified link aggregation group (LAG) or connection |
confirm_connection | Confirms the creation of the specified hosted connection on an interconnect |
confirm_customer_agreement | The confirmation of the terms of agreement when creating the connection/link aggregation group (LAG) |
confirm_private_virtual_interface | Accepts ownership of a private virtual interface created by another Amazon Web Services account |
confirm_public_virtual_interface | Accepts ownership of a public virtual interface created by another Amazon Web Services account |
confirm_transit_virtual_interface | Accepts ownership of a transit virtual interface created by another Amazon Web Services account |
create_bgp_peer | Creates a BGP peer on the specified virtual interface |
create_connection | Creates a connection between a customer network and a specific Direct Connect location |
create_direct_connect_gateway | Creates a Direct Connect gateway, which is an intermediate object that enables you to connect a set of virtual interfaces and virtual private gateways |
create_direct_connect_gateway_association | Creates an association between a Direct Connect gateway and a virtual private gateway |
create_direct_connect_gateway_association_proposal | Creates a proposal to associate the specified virtual private gateway or transit gateway with the specified Direct Connect gateway |
create_interconnect | Creates an interconnect between an Direct Connect Partner's network and a specific Direct Connect location |
create_lag | Creates a link aggregation group (LAG) with the specified number of bundled physical dedicated connections between the customer network and a specific Direct Connect location |
create_private_virtual_interface | Creates a private virtual interface |
create_public_virtual_interface | Creates a public virtual interface |
create_transit_virtual_interface | Creates a transit virtual interface |
delete_bgp_peer | Deletes the specified BGP peer on the specified virtual interface with the specified customer address and ASN |
delete_connection | Deletes the specified connection |
delete_direct_connect_gateway | Deletes the specified Direct Connect gateway |
delete_direct_connect_gateway_association | Deletes the association between the specified Direct Connect gateway and virtual private gateway |
delete_direct_connect_gateway_association_proposal | Deletes the association proposal request between the specified Direct Connect gateway and virtual private gateway or transit gateway |
delete_interconnect | Deletes the specified interconnect |
delete_lag | Deletes the specified link aggregation group (LAG) |
delete_virtual_interface | Deletes a virtual interface |
describe_connection_loa | Deprecated |
describe_connections | Displays the specified connection or all connections in this Region |
describe_connections_on_interconnect | Deprecated |
describe_customer_metadata | Get and view a list of customer agreements, along with their signed status and whether the customer is an NNIPartner, NNIPartnerV2, or a nonPartner |
describe_direct_connect_gateway_association_proposals | Describes one or more association proposals for connection between a virtual private gateway or transit gateway and a Direct Connect gateway |
describe_direct_connect_gateway_associations | Lists the associations between your Direct Connect gateways and virtual private gateways and transit gateways |
describe_direct_connect_gateway_attachments | Lists the attachments between your Direct Connect gateways and virtual interfaces |
describe_direct_connect_gateways | Lists all your Direct Connect gateways or only the specified Direct Connect gateway |
describe_hosted_connections | Lists the hosted connections that have been provisioned on the specified interconnect or link aggregation group (LAG) |
describe_interconnect_loa | Deprecated |
describe_interconnects | Lists the interconnects owned by the Amazon Web Services account or only the specified interconnect |
describe_lags | Describes all your link aggregation groups (LAG) or the specified LAG |
describe_loa | Gets the LOA-CFA for a connection, interconnect, or link aggregation group (LAG) |
describe_locations | Lists the Direct Connect locations in the current Amazon Web Services Region |
describe_router_configuration | Details about the router |
describe_tags | Describes the tags associated with the specified Direct Connect resources |
describe_virtual_gateways | Deprecated |
describe_virtual_interfaces | Displays all virtual interfaces for an Amazon Web Services account |
disassociate_connection_from_lag | Disassociates a connection from a link aggregation group (LAG) |
disassociate_mac_sec_key | Removes the association between a MAC Security (MACsec) security key and an Direct Connect dedicated connection |
list_virtual_interface_test_history | Lists the virtual interface failover test history |
start_bgp_failover_test | Starts the virtual interface failover test that verifies your configuration meets your resiliency requirements by placing the BGP peering session in the DOWN state |
stop_bgp_failover_test | Stops the virtual interface failover test |
tag_resource | Adds the specified tags to the specified Direct Connect resource |
untag_resource | Removes one or more tags from the specified Direct Connect resource |
update_connection | Updates the Direct Connect dedicated connection configuration |
update_direct_connect_gateway | Updates the name of a current Direct Connect gateway |
update_direct_connect_gateway_association | Updates the specified attributes of the Direct Connect gateway association |
update_lag | Updates the attributes of the specified link aggregation group (LAG) |
update_virtual_interface_attributes | Updates the specified attributes of the specified virtual private interface |
Examples
## Not run:
svc <- directconnect()
svc$accept_direct_connect_gateway_association_proposal(
Foo = 123
)
## End(Not run)
Accepts a proposal request to attach a virtual private gateway or transit gateway to a Direct Connect gateway
Description
Accepts a proposal request to attach a virtual private gateway or transit gateway to a Direct Connect gateway.
See https://www.paws-r-sdk.com/docs/directconnect_accept_direct_connect_gateway_association_proposal/ for full documentation.
Usage
directconnect_accept_direct_connect_gateway_association_proposal(
directConnectGatewayId,
proposalId,
associatedGatewayOwnerAccount,
overrideAllowedPrefixesToDirectConnectGateway = NULL
)
Arguments
directConnectGatewayId |
[required] The ID of the Direct Connect gateway. |
proposalId |
[required] The ID of the request proposal. |
associatedGatewayOwnerAccount |
[required] The ID of the Amazon Web Services account that owns the virtual private gateway or transit gateway. |
overrideAllowedPrefixesToDirectConnectGateway |
Overrides the Amazon VPC prefixes advertised to the Direct Connect gateway. For information about how to set the prefixes, see Allowed Prefixes in the Direct Connect User Guide. |
Deprecated
Description
Deprecated. Use allocate_hosted_connection
instead.
See https://www.paws-r-sdk.com/docs/directconnect_allocate_connection_on_interconnect/ for full documentation.
Usage
directconnect_allocate_connection_on_interconnect(
bandwidth,
connectionName,
ownerAccount,
interconnectId,
vlan
)
Arguments
bandwidth |
[required] The bandwidth of the connection. The possible values are 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, and 10Gbps. Note that only those Direct Connect Partners who have met specific requirements are allowed to create a 1Gbps, 2Gbps, 5Gbps or 10Gbps hosted connection. |
connectionName |
[required] The name of the provisioned connection. |
ownerAccount |
[required] The ID of the Amazon Web Services account of the customer for whom the connection will be provisioned. |
interconnectId |
[required] The ID of the interconnect on which the connection will be provisioned. |
vlan |
[required] The dedicated VLAN provisioned to the connection. |
Creates a hosted connection on the specified interconnect or a link aggregation group (LAG) of interconnects
Description
Creates a hosted connection on the specified interconnect or a link aggregation group (LAG) of interconnects.
See https://www.paws-r-sdk.com/docs/directconnect_allocate_hosted_connection/ for full documentation.
Usage
directconnect_allocate_hosted_connection(
connectionId,
ownerAccount,
bandwidth,
connectionName,
vlan,
tags = NULL
)
Arguments
connectionId |
[required] The ID of the interconnect or LAG. |
ownerAccount |
[required] The ID of the Amazon Web Services account ID of the customer for the connection. |
bandwidth |
[required] The bandwidth of the connection. The possible values are 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, 10Gbps, and 25Gbps. Note that only those Direct Connect Partners who have met specific requirements are allowed to create a 1Gbps, 2Gbps, 5Gbps, 10Gbps, or 25Gbps hosted connection. |
connectionName |
[required] The name of the hosted connection. |
vlan |
[required] The dedicated VLAN provisioned to the hosted connection. |
tags |
The tags associated with the connection. |
Provisions a private virtual interface to be owned by the specified Amazon Web Services account
Description
Provisions a private virtual interface to be owned by the specified Amazon Web Services account.
See https://www.paws-r-sdk.com/docs/directconnect_allocate_private_virtual_interface/ for full documentation.
Usage
directconnect_allocate_private_virtual_interface(
connectionId,
ownerAccount,
newPrivateVirtualInterfaceAllocation
)
Arguments
connectionId |
[required] The ID of the connection on which the private virtual interface is provisioned. |
ownerAccount |
[required] The ID of the Amazon Web Services account that owns the virtual private interface. |
newPrivateVirtualInterfaceAllocation |
[required] Information about the private virtual interface. |
Provisions a public virtual interface to be owned by the specified Amazon Web Services account
Description
Provisions a public virtual interface to be owned by the specified Amazon Web Services account.
See https://www.paws-r-sdk.com/docs/directconnect_allocate_public_virtual_interface/ for full documentation.
Usage
directconnect_allocate_public_virtual_interface(
connectionId,
ownerAccount,
newPublicVirtualInterfaceAllocation
)
Arguments
connectionId |
[required] The ID of the connection on which the public virtual interface is provisioned. |
ownerAccount |
[required] The ID of the Amazon Web Services account that owns the public virtual interface. |
newPublicVirtualInterfaceAllocation |
[required] Information about the public virtual interface. |
Provisions a transit virtual interface to be owned by the specified Amazon Web Services account
Description
Provisions a transit virtual interface to be owned by the specified Amazon Web Services account. Use this type of interface to connect a transit gateway to your Direct Connect gateway.
See https://www.paws-r-sdk.com/docs/directconnect_allocate_transit_virtual_interface/ for full documentation.
Usage
directconnect_allocate_transit_virtual_interface(
connectionId,
ownerAccount,
newTransitVirtualInterfaceAllocation
)
Arguments
connectionId |
[required] The ID of the connection on which the transit virtual interface is provisioned. |
ownerAccount |
[required] The ID of the Amazon Web Services account that owns the transit virtual interface. |
newTransitVirtualInterfaceAllocation |
[required] Information about the transit virtual interface. |
Associates an existing connection with a link aggregation group (LAG)
Description
Associates an existing connection with a link aggregation group (LAG). The connection is interrupted and re-established as a member of the LAG (connectivity to Amazon Web Services is interrupted). The connection must be hosted on the same Direct Connect endpoint as the LAG, and its bandwidth must match the bandwidth for the LAG. You can re-associate a connection that's currently associated with a different LAG; however, if removing the connection would cause the original LAG to fall below its setting for minimum number of operational connections, the request fails.
See https://www.paws-r-sdk.com/docs/directconnect_associate_connection_with_lag/ for full documentation.
Usage
directconnect_associate_connection_with_lag(connectionId, lagId)
Arguments
connectionId |
[required] The ID of the connection. |
lagId |
[required] The ID of the LAG with which to associate the connection. |
Associates a hosted connection and its virtual interfaces with a link aggregation group (LAG) or interconnect
Description
Associates a hosted connection and its virtual interfaces with a link aggregation group (LAG) or interconnect. If the target interconnect or LAG has an existing hosted connection with a conflicting VLAN number or IP address, the operation fails. This action temporarily interrupts the hosted connection's connectivity to Amazon Web Services as it is being migrated.
See https://www.paws-r-sdk.com/docs/directconnect_associate_hosted_connection/ for full documentation.
Usage
directconnect_associate_hosted_connection(connectionId, parentConnectionId)
Arguments
connectionId |
[required] The ID of the hosted connection. |
parentConnectionId |
[required] The ID of the interconnect or the LAG. |
Associates a MAC Security (MACsec) Connection Key Name (CKN)/ Connectivity Association Key (CAK) pair with an Direct Connect dedicated connection
Description
Associates a MAC Security (MACsec) Connection Key Name (CKN)/ Connectivity Association Key (CAK) pair with an Direct Connect dedicated connection.
See https://www.paws-r-sdk.com/docs/directconnect_associate_mac_sec_key/ for full documentation.
Usage
directconnect_associate_mac_sec_key(
connectionId,
secretARN = NULL,
ckn = NULL,
cak = NULL
)
Arguments
connectionId |
[required] The ID of the dedicated connection (dxcon-xxxx), or the ID of the LAG (dxlag-xxxx). You can use |
secretARN |
The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key to associate with the dedicated connection. You can use If you use this request parameter, you do not use the |
ckn |
The MAC Security (MACsec) CKN to associate with the dedicated connection. You can create the CKN/CAK pair using an industry standard tool. The valid values are 64 hexadecimal characters (0-9, A-E). If you use this request parameter, you must use the |
cak |
The MAC Security (MACsec) CAK to associate with the dedicated connection. You can create the CKN/CAK pair using an industry standard tool. The valid values are 64 hexadecimal characters (0-9, A-E). If you use this request parameter, you must use the |
Associates a virtual interface with a specified link aggregation group (LAG) or connection
Description
Associates a virtual interface with a specified link aggregation group (LAG) or connection. Connectivity to Amazon Web Services is temporarily interrupted as the virtual interface is being migrated. If the target connection or LAG has an associated virtual interface with a conflicting VLAN number or a conflicting IP address, the operation fails.
See https://www.paws-r-sdk.com/docs/directconnect_associate_virtual_interface/ for full documentation.
Usage
directconnect_associate_virtual_interface(virtualInterfaceId, connectionId)
Arguments
virtualInterfaceId |
[required] The ID of the virtual interface. |
connectionId |
[required] The ID of the LAG or connection. |
Confirms the creation of the specified hosted connection on an interconnect
Description
Confirms the creation of the specified hosted connection on an interconnect.
See https://www.paws-r-sdk.com/docs/directconnect_confirm_connection/ for full documentation.
Usage
directconnect_confirm_connection(connectionId)
Arguments
connectionId |
[required] The ID of the hosted connection. |
The confirmation of the terms of agreement when creating the connection/link aggregation group (LAG)
Description
The confirmation of the terms of agreement when creating the connection/link aggregation group (LAG).
See https://www.paws-r-sdk.com/docs/directconnect_confirm_customer_agreement/ for full documentation.
Usage
directconnect_confirm_customer_agreement(agreementName = NULL)
Arguments
agreementName |
The name of the customer agreement. |
Accepts ownership of a private virtual interface created by another Amazon Web Services account
Description
Accepts ownership of a private virtual interface created by another Amazon Web Services account.
See https://www.paws-r-sdk.com/docs/directconnect_confirm_private_virtual_interface/ for full documentation.
Usage
directconnect_confirm_private_virtual_interface(
virtualInterfaceId,
virtualGatewayId = NULL,
directConnectGatewayId = NULL
)
Arguments
virtualInterfaceId |
[required] The ID of the virtual interface. |
virtualGatewayId |
The ID of the virtual private gateway. |
directConnectGatewayId |
The ID of the Direct Connect gateway. |
Accepts ownership of a public virtual interface created by another Amazon Web Services account
Description
Accepts ownership of a public virtual interface created by another Amazon Web Services account.
See https://www.paws-r-sdk.com/docs/directconnect_confirm_public_virtual_interface/ for full documentation.
Usage
directconnect_confirm_public_virtual_interface(virtualInterfaceId)
Arguments
virtualInterfaceId |
[required] The ID of the virtual interface. |
Accepts ownership of a transit virtual interface created by another Amazon Web Services account
Description
Accepts ownership of a transit virtual interface created by another Amazon Web Services account.
See https://www.paws-r-sdk.com/docs/directconnect_confirm_transit_virtual_interface/ for full documentation.
Usage
directconnect_confirm_transit_virtual_interface(
virtualInterfaceId,
directConnectGatewayId
)
Arguments
virtualInterfaceId |
[required] The ID of the virtual interface. |
directConnectGatewayId |
[required] The ID of the Direct Connect gateway. |
Creates a BGP peer on the specified virtual interface
Description
Creates a BGP peer on the specified virtual interface.
See https://www.paws-r-sdk.com/docs/directconnect_create_bgp_peer/ for full documentation.
Usage
directconnect_create_bgp_peer(virtualInterfaceId = NULL, newBGPPeer = NULL)
Arguments
virtualInterfaceId |
The ID of the virtual interface. |
newBGPPeer |
Information about the BGP peer. |
Creates a connection between a customer network and a specific Direct Connect location
Description
Creates a connection between a customer network and a specific Direct Connect location.
See https://www.paws-r-sdk.com/docs/directconnect_create_connection/ for full documentation.
Usage
directconnect_create_connection(
location,
bandwidth,
connectionName,
lagId = NULL,
tags = NULL,
providerName = NULL,
requestMACSec = NULL
)
Arguments
location |
[required] The location of the connection. |
bandwidth |
[required] The bandwidth of the connection. |
connectionName |
[required] The name of the connection. |
lagId |
The ID of the LAG. |
tags |
The tags to associate with the lag. |
providerName |
The name of the service provider associated with the requested connection. |
requestMACSec |
Indicates whether you want the connection to support MAC Security (MACsec). MAC Security (MACsec) is only available on dedicated connections. For information about MAC Security (MACsec) prerequisties, see MACsec prerequisties in the Direct Connect User Guide. |
Creates a Direct Connect gateway, which is an intermediate object that enables you to connect a set of virtual interfaces and virtual private gateways
Description
Creates a Direct Connect gateway, which is an intermediate object that enables you to connect a set of virtual interfaces and virtual private gateways. A Direct Connect gateway is global and visible in any Amazon Web Services Region after it is created. The virtual interfaces and virtual private gateways that are connected through a Direct Connect gateway can be in different Amazon Web Services Regions. This enables you to connect to a VPC in any Region, regardless of the Region in which the virtual interfaces are located, and pass traffic between them.
See https://www.paws-r-sdk.com/docs/directconnect_create_direct_connect_gateway/ for full documentation.
Usage
directconnect_create_direct_connect_gateway(
directConnectGatewayName,
amazonSideAsn = NULL
)
Arguments
directConnectGatewayName |
[required] The name of the Direct Connect gateway. |
amazonSideAsn |
The autonomous system number (ASN) for Border Gateway Protocol (BGP) to be configured on the Amazon side of the connection. The ASN must be in the private range of 64,512 to 65,534 or 4,200,000,000 to 4,294,967,294. The default is 64512. |
Creates an association between a Direct Connect gateway and a virtual private gateway
Description
Creates an association between a Direct Connect gateway and a virtual private gateway. The virtual private gateway must be attached to a VPC and must not be associated with another Direct Connect gateway.
See https://www.paws-r-sdk.com/docs/directconnect_create_direct_connect_gateway_association/ for full documentation.
Usage
directconnect_create_direct_connect_gateway_association(
directConnectGatewayId,
gatewayId = NULL,
addAllowedPrefixesToDirectConnectGateway = NULL,
virtualGatewayId = NULL
)
Arguments
directConnectGatewayId |
[required] The ID of the Direct Connect gateway. |
gatewayId |
The ID of the virtual private gateway or transit gateway. |
addAllowedPrefixesToDirectConnectGateway |
The Amazon VPC prefixes to advertise to the Direct Connect gateway This parameter is required when you create an association to a transit gateway. For information about how to set the prefixes, see Allowed Prefixes in the Direct Connect User Guide. |
virtualGatewayId |
The ID of the virtual private gateway. |
Creates a proposal to associate the specified virtual private gateway or transit gateway with the specified Direct Connect gateway
Description
Creates a proposal to associate the specified virtual private gateway or transit gateway with the specified Direct Connect gateway.
See https://www.paws-r-sdk.com/docs/directconnect_create_direct_connect_gateway_association_proposal/ for full documentation.
Usage
directconnect_create_direct_connect_gateway_association_proposal(
directConnectGatewayId,
directConnectGatewayOwnerAccount,
gatewayId,
addAllowedPrefixesToDirectConnectGateway = NULL,
removeAllowedPrefixesToDirectConnectGateway = NULL
)
Arguments
directConnectGatewayId |
[required] The ID of the Direct Connect gateway. |
directConnectGatewayOwnerAccount |
[required] The ID of the Amazon Web Services account that owns the Direct Connect gateway. |
gatewayId |
[required] The ID of the virtual private gateway or transit gateway. |
addAllowedPrefixesToDirectConnectGateway |
The Amazon VPC prefixes to advertise to the Direct Connect gateway. |
removeAllowedPrefixesToDirectConnectGateway |
The Amazon VPC prefixes to no longer advertise to the Direct Connect gateway. |
Creates an interconnect between an Direct Connect Partner's network and a specific Direct Connect location
Description
Creates an interconnect between an Direct Connect Partner's network and a specific Direct Connect location.
See https://www.paws-r-sdk.com/docs/directconnect_create_interconnect/ for full documentation.
Usage
directconnect_create_interconnect(
interconnectName,
bandwidth,
location,
lagId = NULL,
tags = NULL,
providerName = NULL
)
Arguments
interconnectName |
[required] The name of the interconnect. |
bandwidth |
[required] The port bandwidth, in Gbps. The possible values are 1, 10, and 100. |
location |
[required] The location of the interconnect. |
lagId |
The ID of the LAG. |
tags |
The tags to associate with the interconnect. |
providerName |
The name of the service provider associated with the interconnect. |
Creates a link aggregation group (LAG) with the specified number of bundled physical dedicated connections between the customer network and a specific Direct Connect location
Description
Creates a link aggregation group (LAG) with the specified number of bundled physical dedicated connections between the customer network and a specific Direct Connect location. A LAG is a logical interface that uses the Link Aggregation Control Protocol (LACP) to aggregate multiple interfaces, enabling you to treat them as a single interface.
See https://www.paws-r-sdk.com/docs/directconnect_create_lag/ for full documentation.
Usage
directconnect_create_lag(
numberOfConnections,
location,
connectionsBandwidth,
lagName,
connectionId = NULL,
tags = NULL,
childConnectionTags = NULL,
providerName = NULL,
requestMACSec = NULL
)
Arguments
numberOfConnections |
[required] The number of physical dedicated connections initially provisioned and bundled by the LAG. You can have a maximum of four connections when the port speed is 1Gbps or 10Gbps, or two when the port speed is 100Gbps or 400Gbps. |
location |
[required] The location for the LAG. |
connectionsBandwidth |
[required] The bandwidth of the individual physical dedicated connections bundled by the LAG. The possible values are 1Gbps,10Gbps, 100Gbps, and 400Gbps. |
lagName |
[required] The name of the LAG. |
connectionId |
The ID of an existing dedicated connection to migrate to the LAG. |
tags |
The tags to associate with the LAG. |
childConnectionTags |
The tags to associate with the automtically created LAGs. |
providerName |
The name of the service provider associated with the LAG. |
requestMACSec |
Indicates whether the connection will support MAC Security (MACsec). All connections in the LAG must be capable of supporting MAC Security (MACsec). For information about MAC Security (MACsec) prerequisties, see MACsec prerequisties in the Direct Connect User Guide. |
Creates a private virtual interface
Description
Creates a private virtual interface. A virtual interface is the VLAN that transports Direct Connect traffic. A private virtual interface can be connected to either a Direct Connect gateway or a Virtual Private Gateway (VGW). Connecting the private virtual interface to a Direct Connect gateway enables the possibility for connecting to multiple VPCs, including VPCs in different Amazon Web Services Regions. Connecting the private virtual interface to a VGW only provides access to a single VPC within the same Region.
See https://www.paws-r-sdk.com/docs/directconnect_create_private_virtual_interface/ for full documentation.
Usage
directconnect_create_private_virtual_interface(
connectionId,
newPrivateVirtualInterface
)
Arguments
connectionId |
[required] The ID of the connection. |
newPrivateVirtualInterface |
[required] Information about the private virtual interface. |
Creates a public virtual interface
Description
Creates a public virtual interface. A virtual interface is the VLAN that transports Direct Connect traffic. A public virtual interface supports sending traffic to public services of Amazon Web Services such as Amazon S3.
See https://www.paws-r-sdk.com/docs/directconnect_create_public_virtual_interface/ for full documentation.
Usage
directconnect_create_public_virtual_interface(
connectionId,
newPublicVirtualInterface
)
Arguments
connectionId |
[required] The ID of the connection. |
newPublicVirtualInterface |
[required] Information about the public virtual interface. |
Creates a transit virtual interface
Description
Creates a transit virtual interface. A transit virtual interface should be used to access one or more transit gateways associated with Direct Connect gateways. A transit virtual interface enables the connection of multiple VPCs attached to a transit gateway to a Direct Connect gateway.
See https://www.paws-r-sdk.com/docs/directconnect_create_transit_virtual_interface/ for full documentation.
Usage
directconnect_create_transit_virtual_interface(
connectionId,
newTransitVirtualInterface
)
Arguments
connectionId |
[required] The ID of the connection. |
newTransitVirtualInterface |
[required] Information about the transit virtual interface. |
Deletes the specified BGP peer on the specified virtual interface with the specified customer address and ASN
Description
Deletes the specified BGP peer on the specified virtual interface with the specified customer address and ASN.
See https://www.paws-r-sdk.com/docs/directconnect_delete_bgp_peer/ for full documentation.
Usage
directconnect_delete_bgp_peer(
virtualInterfaceId = NULL,
asn = NULL,
customerAddress = NULL,
bgpPeerId = NULL
)
Arguments
virtualInterfaceId |
The ID of the virtual interface. |
asn |
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration. |
customerAddress |
The IP address assigned to the customer interface. |
bgpPeerId |
The ID of the BGP peer. |
Deletes the specified connection
Description
Deletes the specified connection.
See https://www.paws-r-sdk.com/docs/directconnect_delete_connection/ for full documentation.
Usage
directconnect_delete_connection(connectionId)
Arguments
connectionId |
[required] The ID of the connection. |
Deletes the specified Direct Connect gateway
Description
Deletes the specified Direct Connect gateway. You must first delete all virtual interfaces that are attached to the Direct Connect gateway and disassociate all virtual private gateways associated with the Direct Connect gateway.
See https://www.paws-r-sdk.com/docs/directconnect_delete_direct_connect_gateway/ for full documentation.
Usage
directconnect_delete_direct_connect_gateway(directConnectGatewayId)
Arguments
directConnectGatewayId |
[required] The ID of the Direct Connect gateway. |
Deletes the association between the specified Direct Connect gateway and virtual private gateway
Description
Deletes the association between the specified Direct Connect gateway and virtual private gateway.
See https://www.paws-r-sdk.com/docs/directconnect_delete_direct_connect_gateway_association/ for full documentation.
Usage
directconnect_delete_direct_connect_gateway_association(
associationId = NULL,
directConnectGatewayId = NULL,
virtualGatewayId = NULL
)
Arguments
associationId |
The ID of the Direct Connect gateway association. |
directConnectGatewayId |
The ID of the Direct Connect gateway. |
virtualGatewayId |
The ID of the virtual private gateway. |
Deletes the association proposal request between the specified Direct Connect gateway and virtual private gateway or transit gateway
Description
Deletes the association proposal request between the specified Direct Connect gateway and virtual private gateway or transit gateway.
See https://www.paws-r-sdk.com/docs/directconnect_delete_direct_connect_gateway_association_proposal/ for full documentation.
Usage
directconnect_delete_direct_connect_gateway_association_proposal(proposalId)
Arguments
proposalId |
[required] The ID of the proposal. |
Deletes the specified interconnect
Description
Deletes the specified interconnect.
See https://www.paws-r-sdk.com/docs/directconnect_delete_interconnect/ for full documentation.
Usage
directconnect_delete_interconnect(interconnectId)
Arguments
interconnectId |
[required] The ID of the interconnect. |
Deletes the specified link aggregation group (LAG)
Description
Deletes the specified link aggregation group (LAG). You cannot delete a LAG if it has active virtual interfaces or hosted connections.
See https://www.paws-r-sdk.com/docs/directconnect_delete_lag/ for full documentation.
Usage
directconnect_delete_lag(lagId)
Arguments
lagId |
[required] The ID of the LAG. |
Deletes a virtual interface
Description
Deletes a virtual interface.
See https://www.paws-r-sdk.com/docs/directconnect_delete_virtual_interface/ for full documentation.
Usage
directconnect_delete_virtual_interface(virtualInterfaceId)
Arguments
virtualInterfaceId |
[required] The ID of the virtual interface. |
Deprecated
Description
Deprecated. Use describe_loa
instead.
See https://www.paws-r-sdk.com/docs/directconnect_describe_connection_loa/ for full documentation.
Usage
directconnect_describe_connection_loa(
connectionId,
providerName = NULL,
loaContentType = NULL
)
Arguments
connectionId |
[required] The ID of the connection. |
providerName |
The name of the APN partner or service provider who establishes connectivity on your behalf. If you specify this parameter, the LOA-CFA lists the provider name alongside your company name as the requester of the cross connect. |
loaContentType |
The standard media type for the LOA-CFA document. The only supported value is application/pdf. |
Displays the specified connection or all connections in this Region
Description
Displays the specified connection or all connections in this Region.
See https://www.paws-r-sdk.com/docs/directconnect_describe_connections/ for full documentation.
Usage
directconnect_describe_connections(connectionId = NULL)
Arguments
connectionId |
The ID of the connection. |
Deprecated
Description
Deprecated. Use describe_hosted_connections
instead.
See https://www.paws-r-sdk.com/docs/directconnect_describe_connections_on_interconnect/ for full documentation.
Usage
directconnect_describe_connections_on_interconnect(interconnectId)
Arguments
interconnectId |
[required] The ID of the interconnect. |
Get and view a list of customer agreements, along with their signed status and whether the customer is an NNIPartner, NNIPartnerV2, or a nonPartner
Description
Get and view a list of customer agreements, along with their signed status and whether the customer is an NNIPartner, NNIPartnerV2, or a nonPartner.
See https://www.paws-r-sdk.com/docs/directconnect_describe_customer_metadata/ for full documentation.
Usage
directconnect_describe_customer_metadata()
Describes one or more association proposals for connection between a virtual private gateway or transit gateway and a Direct Connect gateway
Description
Describes one or more association proposals for connection between a virtual private gateway or transit gateway and a Direct Connect gateway.
See https://www.paws-r-sdk.com/docs/directconnect_describe_direct_connect_gateway_association_proposals/ for full documentation.
Usage
directconnect_describe_direct_connect_gateway_association_proposals(
directConnectGatewayId = NULL,
proposalId = NULL,
associatedGatewayId = NULL,
maxResults = NULL,
nextToken = NULL
)
Arguments
directConnectGatewayId |
The ID of the Direct Connect gateway. |
proposalId |
The ID of the proposal. |
associatedGatewayId |
The ID of the associated gateway. |
maxResults |
The maximum number of results to return with a single call. To retrieve
the remaining results, make another call with the returned If |
nextToken |
The token for the next page of results. |
Lists the associations between your Direct Connect gateways and virtual private gateways and transit gateways
Description
Lists the associations between your Direct Connect gateways and virtual private gateways and transit gateways. You must specify one of the following:
See https://www.paws-r-sdk.com/docs/directconnect_describe_direct_connect_gateway_associations/ for full documentation.
Usage
directconnect_describe_direct_connect_gateway_associations(
associationId = NULL,
associatedGatewayId = NULL,
directConnectGatewayId = NULL,
maxResults = NULL,
nextToken = NULL,
virtualGatewayId = NULL
)
Arguments
associationId |
The ID of the Direct Connect gateway association. |
associatedGatewayId |
The ID of the associated gateway. |
directConnectGatewayId |
The ID of the Direct Connect gateway. |
maxResults |
The maximum number of results to return with a single call. To retrieve
the remaining results, make another call with the returned If |
nextToken |
The token provided in the previous call to retrieve the next page. |
virtualGatewayId |
The ID of the virtual private gateway or transit gateway. |
Lists the attachments between your Direct Connect gateways and virtual interfaces
Description
Lists the attachments between your Direct Connect gateways and virtual interfaces. You must specify a Direct Connect gateway, a virtual interface, or both. If you specify a Direct Connect gateway, the response contains all virtual interfaces attached to the Direct Connect gateway. If you specify a virtual interface, the response contains all Direct Connect gateways attached to the virtual interface. If you specify both, the response contains the attachment between the Direct Connect gateway and the virtual interface.
See https://www.paws-r-sdk.com/docs/directconnect_describe_direct_connect_gateway_attachments/ for full documentation.
Usage
directconnect_describe_direct_connect_gateway_attachments(
directConnectGatewayId = NULL,
virtualInterfaceId = NULL,
maxResults = NULL,
nextToken = NULL
)
Arguments
directConnectGatewayId |
The ID of the Direct Connect gateway. |
virtualInterfaceId |
The ID of the virtual interface. |
maxResults |
The maximum number of results to return with a single call. To retrieve
the remaining results, make another call with the returned If |
nextToken |
The token provided in the previous call to retrieve the next page. |
Lists all your Direct Connect gateways or only the specified Direct Connect gateway
Description
Lists all your Direct Connect gateways or only the specified Direct Connect gateway. Deleted Direct Connect gateways are not returned.
See https://www.paws-r-sdk.com/docs/directconnect_describe_direct_connect_gateways/ for full documentation.
Usage
directconnect_describe_direct_connect_gateways(
directConnectGatewayId = NULL,
maxResults = NULL,
nextToken = NULL
)
Arguments
directConnectGatewayId |
The ID of the Direct Connect gateway. |
maxResults |
The maximum number of results to return with a single call. To retrieve
the remaining results, make another call with the returned If |
nextToken |
The token provided in the previous call to retrieve the next page. |
Lists the hosted connections that have been provisioned on the specified interconnect or link aggregation group (LAG)
Description
Lists the hosted connections that have been provisioned on the specified interconnect or link aggregation group (LAG).
See https://www.paws-r-sdk.com/docs/directconnect_describe_hosted_connections/ for full documentation.
Usage
directconnect_describe_hosted_connections(connectionId)
Arguments
connectionId |
[required] The ID of the interconnect or LAG. |
Deprecated
Description
Deprecated. Use describe_loa
instead.
See https://www.paws-r-sdk.com/docs/directconnect_describe_interconnect_loa/ for full documentation.
Usage
directconnect_describe_interconnect_loa(
interconnectId,
providerName = NULL,
loaContentType = NULL
)
Arguments
interconnectId |
[required] The ID of the interconnect. |
providerName |
The name of the service provider who establishes connectivity on your behalf. If you supply this parameter, the LOA-CFA lists the provider name alongside your company name as the requester of the cross connect. |
loaContentType |
The standard media type for the LOA-CFA document. The only supported value is application/pdf. |
Lists the interconnects owned by the Amazon Web Services account or only the specified interconnect
Description
Lists the interconnects owned by the Amazon Web Services account or only the specified interconnect.
See https://www.paws-r-sdk.com/docs/directconnect_describe_interconnects/ for full documentation.
Usage
directconnect_describe_interconnects(interconnectId = NULL)
Arguments
interconnectId |
The ID of the interconnect. |
Describes all your link aggregation groups (LAG) or the specified LAG
Description
Describes all your link aggregation groups (LAG) or the specified LAG.
See https://www.paws-r-sdk.com/docs/directconnect_describe_lags/ for full documentation.
Usage
directconnect_describe_lags(lagId = NULL)
Arguments
lagId |
The ID of the LAG. |
Gets the LOA-CFA for a connection, interconnect, or link aggregation group (LAG)
Description
Gets the LOA-CFA for a connection, interconnect, or link aggregation group (LAG).
See https://www.paws-r-sdk.com/docs/directconnect_describe_loa/ for full documentation.
Usage
directconnect_describe_loa(
connectionId,
providerName = NULL,
loaContentType = NULL
)
Arguments
connectionId |
[required] The ID of a connection, LAG, or interconnect. |
providerName |
The name of the service provider who establishes connectivity on your behalf. If you specify this parameter, the LOA-CFA lists the provider name alongside your company name as the requester of the cross connect. |
loaContentType |
The standard media type for the LOA-CFA document. The only supported value is application/pdf. |
Lists the Direct Connect locations in the current Amazon Web Services Region
Description
Lists the Direct Connect locations in the current Amazon Web Services Region. These are the locations that can be selected when calling create_connection
or create_interconnect
.
See https://www.paws-r-sdk.com/docs/directconnect_describe_locations/ for full documentation.
Usage
directconnect_describe_locations()
Details about the router
Description
Details about the router.
See https://www.paws-r-sdk.com/docs/directconnect_describe_router_configuration/ for full documentation.
Usage
directconnect_describe_router_configuration(
virtualInterfaceId,
routerTypeIdentifier = NULL
)
Arguments
virtualInterfaceId |
[required] The ID of the virtual interface. |
routerTypeIdentifier |
Identifies the router by a combination of vendor, platform, and software
version. For example, |
Describes the tags associated with the specified Direct Connect resources
Description
Describes the tags associated with the specified Direct Connect resources.
See https://www.paws-r-sdk.com/docs/directconnect_describe_tags/ for full documentation.
Usage
directconnect_describe_tags(resourceArns)
Arguments
resourceArns |
[required] The Amazon Resource Names (ARNs) of the resources. |
Deprecated
Description
Deprecated. Use DescribeVpnGateways
instead. See DescribeVPNGateways in the Amazon Elastic Compute Cloud API Reference.
See https://www.paws-r-sdk.com/docs/directconnect_describe_virtual_gateways/ for full documentation.
Usage
directconnect_describe_virtual_gateways()
Displays all virtual interfaces for an Amazon Web Services account
Description
Displays all virtual interfaces for an Amazon Web Services account. Virtual interfaces deleted fewer than 15 minutes before you make the request are also returned. If you specify a connection ID, only the virtual interfaces associated with the connection are returned. If you specify a virtual interface ID, then only a single virtual interface is returned.
See https://www.paws-r-sdk.com/docs/directconnect_describe_virtual_interfaces/ for full documentation.
Usage
directconnect_describe_virtual_interfaces(
connectionId = NULL,
virtualInterfaceId = NULL
)
Arguments
connectionId |
The ID of the connection. |
virtualInterfaceId |
The ID of the virtual interface. |
Disassociates a connection from a link aggregation group (LAG)
Description
Disassociates a connection from a link aggregation group (LAG). The connection is interrupted and re-established as a standalone connection (the connection is not deleted; to delete the connection, use the delete_connection
request). If the LAG has associated virtual interfaces or hosted connections, they remain associated with the LAG. A disassociated connection owned by an Direct Connect Partner is automatically converted to an interconnect.
See https://www.paws-r-sdk.com/docs/directconnect_disassociate_connection_from_lag/ for full documentation.
Usage
directconnect_disassociate_connection_from_lag(connectionId, lagId)
Arguments
connectionId |
[required] The ID of the connection. |
lagId |
[required] The ID of the LAG. |
Removes the association between a MAC Security (MACsec) security key and an Direct Connect dedicated connection
Description
Removes the association between a MAC Security (MACsec) security key and an Direct Connect dedicated connection.
See https://www.paws-r-sdk.com/docs/directconnect_disassociate_mac_sec_key/ for full documentation.
Usage
directconnect_disassociate_mac_sec_key(connectionId, secretARN)
Arguments
connectionId |
[required] The ID of the dedicated connection (dxcon-xxxx), or the ID of the LAG (dxlag-xxxx). You can use |
secretARN |
[required] The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key. You can use |
Lists the virtual interface failover test history
Description
Lists the virtual interface failover test history.
See https://www.paws-r-sdk.com/docs/directconnect_list_virtual_interface_test_history/ for full documentation.
Usage
directconnect_list_virtual_interface_test_history(
testId = NULL,
virtualInterfaceId = NULL,
bgpPeers = NULL,
status = NULL,
maxResults = NULL,
nextToken = NULL
)
Arguments
testId |
The ID of the virtual interface failover test. |
virtualInterfaceId |
The ID of the virtual interface that was tested. |
bgpPeers |
The BGP peers that were placed in the DOWN state during the virtual interface failover test. |
status |
The status of the virtual interface failover test. |
maxResults |
The maximum number of results to return with a single call. To retrieve
the remaining results, make another call with the returned If |
nextToken |
The token for the next page of results. |
Starts the virtual interface failover test that verifies your configuration meets your resiliency requirements by placing the BGP peering session in the DOWN state
Description
Starts the virtual interface failover test that verifies your configuration meets your resiliency requirements by placing the BGP peering session in the DOWN state. You can then send traffic to verify that there are no outages.
See https://www.paws-r-sdk.com/docs/directconnect_start_bgp_failover_test/ for full documentation.
Usage
directconnect_start_bgp_failover_test(
virtualInterfaceId,
bgpPeers = NULL,
testDurationInMinutes = NULL
)
Arguments
virtualInterfaceId |
[required] The ID of the virtual interface you want to test. |
bgpPeers |
The BGP peers to place in the DOWN state. |
testDurationInMinutes |
The time in minutes that the virtual interface failover test will last. Maximum value: 4,320 minutes (72 hours). Default: 180 minutes (3 hours). |
Stops the virtual interface failover test
Description
Stops the virtual interface failover test.
See https://www.paws-r-sdk.com/docs/directconnect_stop_bgp_failover_test/ for full documentation.
Usage
directconnect_stop_bgp_failover_test(virtualInterfaceId)
Arguments
virtualInterfaceId |
[required] The ID of the virtual interface you no longer want to test. |
Adds the specified tags to the specified Direct Connect resource
Description
Adds the specified tags to the specified Direct Connect resource. Each resource can have a maximum of 50 tags.
See https://www.paws-r-sdk.com/docs/directconnect_tag_resource/ for full documentation.
Usage
directconnect_tag_resource(resourceArn, tags)
Arguments
resourceArn |
[required] The Amazon Resource Name (ARN) of the resource. |
tags |
[required] The tags to add. |
Removes one or more tags from the specified Direct Connect resource
Description
Removes one or more tags from the specified Direct Connect resource.
See https://www.paws-r-sdk.com/docs/directconnect_untag_resource/ for full documentation.
Usage
directconnect_untag_resource(resourceArn, tagKeys)
Arguments
resourceArn |
[required] The Amazon Resource Name (ARN) of the resource. |
tagKeys |
[required] The tag keys of the tags to remove. |
Updates the Direct Connect dedicated connection configuration
Description
Updates the Direct Connect dedicated connection configuration.
See https://www.paws-r-sdk.com/docs/directconnect_update_connection/ for full documentation.
Usage
directconnect_update_connection(
connectionId,
connectionName = NULL,
encryptionMode = NULL
)
Arguments
connectionId |
[required] The ID of the dedicated connection. You can use |
connectionName |
The name of the connection. |
encryptionMode |
The connection MAC Security (MACsec) encryption mode. The valid values are |
Updates the name of a current Direct Connect gateway
Description
Updates the name of a current Direct Connect gateway.
See https://www.paws-r-sdk.com/docs/directconnect_update_direct_connect_gateway/ for full documentation.
Usage
directconnect_update_direct_connect_gateway(
directConnectGatewayId,
newDirectConnectGatewayName
)
Arguments
directConnectGatewayId |
[required] The ID of the Direct Connect gateway to update. |
newDirectConnectGatewayName |
[required] The new name for the Direct Connect gateway. |
Updates the specified attributes of the Direct Connect gateway association
Description
Updates the specified attributes of the Direct Connect gateway association.
See https://www.paws-r-sdk.com/docs/directconnect_update_direct_connect_gateway_association/ for full documentation.
Usage
directconnect_update_direct_connect_gateway_association(
associationId = NULL,
addAllowedPrefixesToDirectConnectGateway = NULL,
removeAllowedPrefixesToDirectConnectGateway = NULL
)
Arguments
associationId |
The ID of the Direct Connect gateway association. |
addAllowedPrefixesToDirectConnectGateway |
The Amazon VPC prefixes to advertise to the Direct Connect gateway. |
removeAllowedPrefixesToDirectConnectGateway |
The Amazon VPC prefixes to no longer advertise to the Direct Connect gateway. |
Updates the attributes of the specified link aggregation group (LAG)
Description
Updates the attributes of the specified link aggregation group (LAG).
See https://www.paws-r-sdk.com/docs/directconnect_update_lag/ for full documentation.
Usage
directconnect_update_lag(
lagId,
lagName = NULL,
minimumLinks = NULL,
encryptionMode = NULL
)
Arguments
lagId |
[required] The ID of the LAG. |
lagName |
The name of the LAG. |
minimumLinks |
The minimum number of physical connections that must be operational for the LAG itself to be operational. |
encryptionMode |
The LAG MAC Security (MACsec) encryption mode. Amazon Web Services applies the value to all connections which are part of the LAG. |
Updates the specified attributes of the specified virtual private interface
Description
Updates the specified attributes of the specified virtual private interface.
See https://www.paws-r-sdk.com/docs/directconnect_update_virtual_interface_attributes/ for full documentation.
Usage
directconnect_update_virtual_interface_attributes(
virtualInterfaceId,
mtu = NULL,
enableSiteLink = NULL,
virtualInterfaceName = NULL
)
Arguments
virtualInterfaceId |
[required] The ID of the virtual private interface. |
mtu |
The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 8500. The default value is 1500. |
enableSiteLink |
Indicates whether to enable or disable SiteLink. |
virtualInterfaceName |
The name of the virtual private interface. |
Elastic Load Balancing
Description
A load balancer can distribute incoming traffic across your EC2 instances. This enables you to increase the availability of your application. The load balancer also monitors the health of its registered instances and ensures that it routes traffic only to healthy instances. You configure your load balancer to accept incoming traffic by specifying one or more listeners, which are configured with a protocol and port number for connections from clients to the load balancer and a protocol and port number for connections from the load balancer to the instances.
Elastic Load Balancing supports three types of load balancers: Application Load Balancers, Network Load Balancers, and Classic Load Balancers. You can select a load balancer based on your application needs. For more information, see the Elastic Load Balancing User Guide.
This reference covers the 2012-06-01 API, which supports Classic Load Balancers. The 2015-12-01 API supports Application Load Balancers and Network Load Balancers.
To get started, create a load balancer with one or more listeners using
create_load_balancer
. Register your
instances with the load balancer using
register_instances_with_load_balancer
.
All Elastic Load Balancing operations are idempotent, which means that they complete at most one time. If you repeat an operation, it succeeds with a 200 OK response code.
Usage
elb(config = list(), credentials = list(), endpoint = NULL, region = NULL)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...)
, where svc
is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- elb( config = list( credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string", close_connection = "logical", timeout = "numeric", s3_force_path_style = "logical", sts_regional_endpoint = "string" ), credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string" )
Operations
add_tags | Adds the specified tags to the specified load balancer |
apply_security_groups_to_load_balancer | Associates one or more security groups with your load balancer in a virtual private cloud (VPC) |
attach_load_balancer_to_subnets | Adds one or more subnets to the set of configured subnets for the specified load balancer |
configure_health_check | Specifies the health check settings to use when evaluating the health state of your EC2 instances |
create_app_cookie_stickiness_policy | Generates a stickiness policy with sticky session lifetimes that follow that of an application-generated cookie |
create_lb_cookie_stickiness_policy | Generates a stickiness policy with sticky session lifetimes controlled by the lifetime of the browser (user-agent) or a specified expiration period |
create_load_balancer | Creates a Classic Load Balancer |
create_load_balancer_listeners | Creates one or more listeners for the specified load balancer |
create_load_balancer_policy | Creates a policy with the specified attributes for the specified load balancer |
delete_load_balancer | Deletes the specified load balancer |
delete_load_balancer_listeners | Deletes the specified listeners from the specified load balancer |
delete_load_balancer_policy | Deletes the specified policy from the specified load balancer |
deregister_instances_from_load_balancer | Deregisters the specified instances from the specified load balancer |
describe_account_limits | Describes the current Elastic Load Balancing resource limits for your AWS account |
describe_instance_health | Describes the state of the specified instances with respect to the specified load balancer |
describe_load_balancer_attributes | Describes the attributes for the specified load balancer |
describe_load_balancer_policies | Describes the specified policies |
describe_load_balancer_policy_types | Describes the specified load balancer policy types or all load balancer policy types |
describe_load_balancers | Describes the specified the load balancers |
describe_tags | Describes the tags associated with the specified load balancers |
detach_load_balancer_from_subnets | Removes the specified subnets from the set of configured subnets for the load balancer |
disable_availability_zones_for_load_balancer | Removes the specified Availability Zones from the set of Availability Zones for the specified load balancer in EC2-Classic or a default VPC |
enable_availability_zones_for_load_balancer | Adds the specified Availability Zones to the set of Availability Zones for the specified load balancer in EC2-Classic or a default VPC |
modify_load_balancer_attributes | Modifies the attributes of the specified load balancer |
register_instances_with_load_balancer | Adds the specified instances to the specified load balancer |
remove_tags | Removes one or more tags from the specified load balancer |
set_load_balancer_listener_ssl_certificate | Sets the certificate that terminates the specified listener's SSL connections |
set_load_balancer_policies_for_backend_server | Replaces the set of policies associated with the specified port on which the EC2 instance is listening with a new set of policies |
set_load_balancer_policies_of_listener | Replaces the current set of policies for the specified load balancer port with the specified set of policies |
Examples
## Not run:
svc <- elb()
# This example adds two tags to the specified load balancer.
svc$add_tags(
LoadBalancerNames = list(
"my-load-balancer"
),
Tags = list(
list(
Key = "project",
Value = "lima"
),
list(
Key = "department",
Value = "digital-media"
)
)
)
## End(Not run)
Adds the specified tags to the specified load balancer
Description
Adds the specified tags to the specified load balancer. Each load balancer can have a maximum of 10 tags.
See https://www.paws-r-sdk.com/docs/elb_add_tags/ for full documentation.
Usage
elb_add_tags(LoadBalancerNames, Tags)
Arguments
LoadBalancerNames |
[required] The name of the load balancer. You can specify one load balancer only. |
Tags |
[required] The tags. |
Associates one or more security groups with your load balancer in a virtual private cloud (VPC)
Description
Associates one or more security groups with your load balancer in a virtual private cloud (VPC). The specified security groups override the previously associated security groups.
See https://www.paws-r-sdk.com/docs/elb_apply_security_groups_to_load_balancer/ for full documentation.
Usage
elb_apply_security_groups_to_load_balancer(LoadBalancerName, SecurityGroups)
Arguments
LoadBalancerName |
[required] The name of the load balancer. |
SecurityGroups |
[required] The IDs of the security groups to associate with the load balancer. Note that you cannot specify the name of the security group. |
Adds one or more subnets to the set of configured subnets for the specified load balancer
Description
Adds one or more subnets to the set of configured subnets for the specified load balancer.
See https://www.paws-r-sdk.com/docs/elb_attach_load_balancer_to_subnets/ for full documentation.
Usage
elb_attach_load_balancer_to_subnets(LoadBalancerName, Subnets)
Arguments
LoadBalancerName |
[required] The name of the load balancer. |
Subnets |
[required] The IDs of the subnets to add. You can add only one subnet per Availability Zone. |
Specifies the health check settings to use when evaluating the health state of your EC2 instances
Description
Specifies the health check settings to use when evaluating the health state of your EC2 instances.
See https://www.paws-r-sdk.com/docs/elb_configure_health_check/ for full documentation.
Usage
elb_configure_health_check(LoadBalancerName, HealthCheck)
Arguments
LoadBalancerName |
[required] The name of the load balancer. |
HealthCheck |
[required] The configuration information. |
Generates a stickiness policy with sticky session lifetimes that follow that of an application-generated cookie
Description
Generates a stickiness policy with sticky session lifetimes that follow that of an application-generated cookie. This policy can be associated only with HTTP/HTTPS listeners.
See https://www.paws-r-sdk.com/docs/elb_create_app_cookie_stickiness_policy/ for full documentation.
Usage
elb_create_app_cookie_stickiness_policy(
LoadBalancerName,
PolicyName,
CookieName
)
Arguments
LoadBalancerName |
[required] The name of the load balancer. |
PolicyName |
[required] The name of the policy being created. Policy names must consist of alphanumeric characters and dashes (-). This name must be unique within the set of policies for this load balancer. |
CookieName |
[required] The name of the application cookie used for stickiness. |
Generates a stickiness policy with sticky session lifetimes controlled by the lifetime of the browser (user-agent) or a specified expiration period
Description
Generates a stickiness policy with sticky session lifetimes controlled by the lifetime of the browser (user-agent) or a specified expiration period. This policy can be associated only with HTTP/HTTPS listeners.
See https://www.paws-r-sdk.com/docs/elb_create_lb_cookie_stickiness_policy/ for full documentation.
Usage
elb_create_lb_cookie_stickiness_policy(
LoadBalancerName,
PolicyName,
CookieExpirationPeriod = NULL
)
Arguments
LoadBalancerName |
[required] The name of the load balancer. |
PolicyName |
[required] The name of the policy being created. Policy names must consist of alphanumeric characters and dashes (-). This name must be unique within the set of policies for this load balancer. |
CookieExpirationPeriod |
The time period, in seconds, after which the cookie should be considered stale. If you do not specify this parameter, the default value is 0, which indicates that the sticky session should last for the duration of the browser session. |
Creates a Classic Load Balancer
Description
Creates a Classic Load Balancer.
See https://www.paws-r-sdk.com/docs/elb_create_load_balancer/ for full documentation.
Usage
elb_create_load_balancer(
LoadBalancerName,
Listeners,
AvailabilityZones = NULL,
Subnets = NULL,
SecurityGroups = NULL,
Scheme = NULL,
Tags = NULL
)
Arguments
LoadBalancerName |
[required] The name of the load balancer. This name must be unique within your set of load balancers for the region, must have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and cannot begin or end with a hyphen. |
Listeners |
[required] The listeners. For more information, see Listeners for Your Classic Load Balancer in the Classic Load Balancers Guide. |
AvailabilityZones |
One or more Availability Zones from the same region as the load balancer. You must specify at least one Availability Zone. You can add more Availability Zones after you create the load balancer
using
|
Subnets |
The IDs of the subnets in your VPC to attach to the load balancer.
Specify one subnet per Availability Zone specified in
|
SecurityGroups |
The IDs of the security groups to assign to the load balancer. |
Scheme |
The type of a load balancer. Valid only for load balancers in a VPC. By default, Elastic Load Balancing creates an Internet-facing load balancer with a DNS name that resolves to public IP addresses. For more information about Internet-facing and Internal load balancers, see Load Balancer Scheme in the Elastic Load Balancing User Guide. Specify |
Tags |
A list of tags to assign to the load balancer. For more information about tagging your load balancer, see Tag Your Classic Load Balancer in the Classic Load Balancers Guide. |
Creates one or more listeners for the specified load balancer
Description
Creates one or more listeners for the specified load balancer. If a listener with the specified port does not already exist, it is created; otherwise, the properties of the new listener must match the properties of the existing listener.
See https://www.paws-r-sdk.com/docs/elb_create_load_balancer_listeners/ for full documentation.
Usage
elb_create_load_balancer_listeners(LoadBalancerName, Listeners)
Arguments
LoadBalancerName |
[required] The name of the load balancer. |
Listeners |
[required] The listeners. |
Creates a policy with the specified attributes for the specified load balancer
Description
Creates a policy with the specified attributes for the specified load balancer.
See https://www.paws-r-sdk.com/docs/elb_create_load_balancer_policy/ for full documentation.
Usage
elb_create_load_balancer_policy(
LoadBalancerName,
PolicyName,
PolicyTypeName,
PolicyAttributes = NULL
)
Arguments
LoadBalancerName |
[required] The name of the load balancer. |
PolicyName |
[required] The name of the load balancer policy to be created. This name must be unique within the set of policies for this load balancer. |
PolicyTypeName |
[required] The name of the base policy type. To get the list of policy types, use
|
PolicyAttributes |
The policy attributes. |
Deletes the specified load balancer
Description
Deletes the specified load balancer.
See https://www.paws-r-sdk.com/docs/elb_delete_load_balancer/ for full documentation.
Usage
elb_delete_load_balancer(LoadBalancerName)
Arguments
LoadBalancerName |
[required] The name of the load balancer. |
Deletes the specified listeners from the specified load balancer
Description
Deletes the specified listeners from the specified load balancer.
See https://www.paws-r-sdk.com/docs/elb_delete_load_balancer_listeners/ for full documentation.
Usage
elb_delete_load_balancer_listeners(LoadBalancerName, LoadBalancerPorts)
Arguments
LoadBalancerName |
[required] The name of the load balancer. |
LoadBalancerPorts |
[required] The client port numbers of the listeners. |
Deletes the specified policy from the specified load balancer
Description
Deletes the specified policy from the specified load balancer. This policy must not be enabled for any listeners.
See https://www.paws-r-sdk.com/docs/elb_delete_load_balancer_policy/ for full documentation.
Usage
elb_delete_load_balancer_policy(LoadBalancerName, PolicyName)
Arguments
LoadBalancerName |
[required] The name of the load balancer. |
PolicyName |
[required] The name of the policy. |
Deregisters the specified instances from the specified load balancer
Description
Deregisters the specified instances from the specified load balancer. After the instance is deregistered, it no longer receives traffic from the load balancer.
See https://www.paws-r-sdk.com/docs/elb_deregister_instances_from_load_balancer/ for full documentation.
Usage
elb_deregister_instances_from_load_balancer(LoadBalancerName, Instances)
Arguments
LoadBalancerName |
[required] The name of the load balancer. |
Instances |
[required] The IDs of the instances. |
Describes the current Elastic Load Balancing resource limits for your AWS account
Description
Describes the current Elastic Load Balancing resource limits for your AWS account.
See https://www.paws-r-sdk.com/docs/elb_describe_account_limits/ for full documentation.
Usage
elb_describe_account_limits(Marker = NULL, PageSize = NULL)
Arguments
Marker |
The marker for the next set of results. (You received this marker from a previous call.) |
PageSize |
The maximum number of results to return with this call. |
Describes the state of the specified instances with respect to the specified load balancer
Description
Describes the state of the specified instances with respect to the specified load balancer. If no instances are specified, the call describes the state of all instances that are currently registered with the load balancer. If instances are specified, their state is returned even if they are no longer registered with the load balancer. The state of terminated instances is not returned.
See https://www.paws-r-sdk.com/docs/elb_describe_instance_health/ for full documentation.
Usage
elb_describe_instance_health(LoadBalancerName, Instances = NULL)
Arguments
LoadBalancerName |
[required] The name of the load balancer. |
Instances |
The IDs of the instances. |
Describes the attributes for the specified load balancer
Description
Describes the attributes for the specified load balancer.
See https://www.paws-r-sdk.com/docs/elb_describe_load_balancer_attributes/ for full documentation.
Usage
elb_describe_load_balancer_attributes(LoadBalancerName)
Arguments
LoadBalancerName |
[required] The name of the load balancer. |
Describes the specified policies
Description
Describes the specified policies.
See https://www.paws-r-sdk.com/docs/elb_describe_load_balancer_policies/ for full documentation.
Usage
elb_describe_load_balancer_policies(
LoadBalancerName = NULL,
PolicyNames = NULL
)
Arguments
LoadBalancerName |
The name of the load balancer. |
PolicyNames |
The names of the policies. |
Describes the specified load balancer policy types or all load balancer policy types
Description
Describes the specified load balancer policy types or all load balancer policy types.
See https://www.paws-r-sdk.com/docs/elb_describe_load_balancer_policy_types/ for full documentation.
Usage
elb_describe_load_balancer_policy_types(PolicyTypeNames = NULL)
Arguments
PolicyTypeNames |
The names of the policy types. If no names are specified, describes all policy types defined by Elastic Load Balancing. |
Describes the specified the load balancers
Description
Describes the specified the load balancers. If no load balancers are specified, the call describes all of your load balancers.
See https://www.paws-r-sdk.com/docs/elb_describe_load_balancers/ for full documentation.
Usage
elb_describe_load_balancers(
LoadBalancerNames = NULL,
Marker = NULL,
PageSize = NULL
)
Arguments
LoadBalancerNames |
The names of the load balancers. |
Marker |
The marker for the next set of results. (You received this marker from a previous call.) |
PageSize |
The maximum number of results to return with this call (a number from 1 to 400). The default is 400. |
Describes the tags associated with the specified load balancers
Description
Describes the tags associated with the specified load balancers.
See https://www.paws-r-sdk.com/docs/elb_describe_tags/ for full documentation.
Usage
elb_describe_tags(LoadBalancerNames)
Arguments
LoadBalancerNames |
[required] The names of the load balancers. |
Removes the specified subnets from the set of configured subnets for the load balancer
Description
Removes the specified subnets from the set of configured subnets for the load balancer.
See https://www.paws-r-sdk.com/docs/elb_detach_load_balancer_from_subnets/ for full documentation.
Usage
elb_detach_load_balancer_from_subnets(LoadBalancerName, Subnets)
Arguments
LoadBalancerName |
[required] The name of the load balancer. |
Subnets |
[required] The IDs of the subnets. |
Removes the specified Availability Zones from the set of Availability Zones for the specified load balancer in EC2-Classic or a default VPC
Description
Removes the specified Availability Zones from the set of Availability Zones for the specified load balancer in EC2-Classic or a default VPC.
See https://www.paws-r-sdk.com/docs/elb_disable_availability_zones_for_load_balancer/ for full documentation.
Usage
elb_disable_availability_zones_for_load_balancer(
LoadBalancerName,
AvailabilityZones
)
Arguments
LoadBalancerName |
[required] The name of the load balancer. |
AvailabilityZones |
[required] The Availability Zones. |
Adds the specified Availability Zones to the set of Availability Zones for the specified load balancer in EC2-Classic or a default VPC
Description
Adds the specified Availability Zones to the set of Availability Zones for the specified load balancer in EC2-Classic or a default VPC.
See https://www.paws-r-sdk.com/docs/elb_enable_availability_zones_for_load_balancer/ for full documentation.
Usage
elb_enable_availability_zones_for_load_balancer(
LoadBalancerName,
AvailabilityZones
)
Arguments
LoadBalancerName |
[required] The name of the load balancer. |
AvailabilityZones |
[required] The Availability Zones. These must be in the same region as the load balancer. |
Modifies the attributes of the specified load balancer
Description
Modifies the attributes of the specified load balancer.
See https://www.paws-r-sdk.com/docs/elb_modify_load_balancer_attributes/ for full documentation.
Usage
elb_modify_load_balancer_attributes(LoadBalancerName, LoadBalancerAttributes)
Arguments
LoadBalancerName |
[required] The name of the load balancer. |
LoadBalancerAttributes |
[required] The attributes for the load balancer. |
Adds the specified instances to the specified load balancer
Description
Adds the specified instances to the specified load balancer.
See https://www.paws-r-sdk.com/docs/elb_register_instances_with_load_balancer/ for full documentation.
Usage
elb_register_instances_with_load_balancer(LoadBalancerName, Instances)
Arguments
LoadBalancerName |
[required] The name of the load balancer. |
Instances |
[required] The IDs of the instances. |
Removes one or more tags from the specified load balancer
Description
Removes one or more tags from the specified load balancer.
See https://www.paws-r-sdk.com/docs/elb_remove_tags/ for full documentation.
Usage
elb_remove_tags(LoadBalancerNames, Tags)
Arguments
LoadBalancerNames |
[required] The name of the load balancer. You can specify a maximum of one load balancer name. |
Tags |
[required] The list of tag keys to remove. |
Sets the certificate that terminates the specified listener's SSL connections
Description
Sets the certificate that terminates the specified listener's SSL connections. The specified certificate replaces any prior certificate that was used on the same load balancer and port.
See https://www.paws-r-sdk.com/docs/elb_set_load_balancer_listener_ssl_certificate/ for full documentation.
Usage
elb_set_load_balancer_listener_ssl_certificate(
LoadBalancerName,
LoadBalancerPort,
SSLCertificateId
)
Arguments
LoadBalancerName |
[required] The name of the load balancer. |
LoadBalancerPort |
[required] The port that uses the specified SSL certificate. |
SSLCertificateId |
[required] The Amazon Resource Name (ARN) of the SSL certificate. |
Replaces the set of policies associated with the specified port on which the EC2 instance is listening with a new set of policies
Description
Replaces the set of policies associated with the specified port on which the EC2 instance is listening with a new set of policies. At this time, only the back-end server authentication policy type can be applied to the instance ports; this policy type is composed of multiple public key policies.
See https://www.paws-r-sdk.com/docs/elb_set_load_balancer_policies_for_backend_server/ for full documentation.
Usage
elb_set_load_balancer_policies_for_backend_server(
LoadBalancerName,
InstancePort,
PolicyNames
)
Arguments
LoadBalancerName |
[required] The name of the load balancer. |
InstancePort |
[required] The port number associated with the EC2 instance. |
PolicyNames |
[required] The names of the policies. If the list is empty, then all current polices are removed from the EC2 instance. |
Replaces the current set of policies for the specified load balancer port with the specified set of policies
Description
Replaces the current set of policies for the specified load balancer port with the specified set of policies.
See https://www.paws-r-sdk.com/docs/elb_set_load_balancer_policies_of_listener/ for full documentation.
Usage
elb_set_load_balancer_policies_of_listener(
LoadBalancerName,
LoadBalancerPort,
PolicyNames
)
Arguments
LoadBalancerName |
[required] The name of the load balancer. |
LoadBalancerPort |
[required] The external port of the load balancer. |
PolicyNames |
[required] The names of the policies. This list must include all policies to be enabled. If you omit a policy that is currently enabled, it is disabled. If the list is empty, all current policies are disabled. |
Elastic Load Balancing
Description
A load balancer distributes incoming traffic across targets, such as your EC2 instances. This enables you to increase the availability of your application. The load balancer also monitors the health of its registered targets and ensures that it routes traffic only to healthy targets. You configure your load balancer to accept incoming traffic by specifying one or more listeners, which are configured with a protocol and port number for connections from clients to the load balancer. You configure a target group with a protocol and port number for connections from the load balancer to the targets, and with health check settings to be used when checking the health status of the targets.
Elastic Load Balancing supports the following types of load balancers: Application Load Balancers, Network Load Balancers, Gateway Load Balancers, and Classic Load Balancers. This reference covers the following load balancer types:
Application Load Balancer - Operates at the application layer (layer 7) and supports HTTP and HTTPS.
Network Load Balancer - Operates at the transport layer (layer 4) and supports TCP, TLS, and UDP.
Gateway Load Balancer - Operates at the network layer (layer 3).
For more information, see the Elastic Load Balancing User Guide.
All Elastic Load Balancing operations are idempotent, which means that they complete at most one time. If you repeat an operation, it succeeds.
Usage
elbv2(config = list(), credentials = list(), endpoint = NULL, region = NULL)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...)
, where svc
is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- elbv2( config = list( credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string", close_connection = "logical", timeout = "numeric", s3_force_path_style = "logical", sts_regional_endpoint = "string" ), credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string" )
Operations
add_listener_certificates | Adds the specified SSL server certificate to the certificate list for the specified HTTPS or TLS listener |
add_tags | Adds the specified tags to the specified Elastic Load Balancing resource |
add_trust_store_revocations | Adds the specified revocation file to the specified trust store |
create_listener | Creates a listener for the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer |
create_load_balancer | Creates an Application Load Balancer, Network Load Balancer, or Gateway Load Balancer |
create_rule | Creates a rule for the specified listener |
create_target_group | Creates a target group |
create_trust_store | Creates a trust store |
delete_listener | Deletes the specified listener |
delete_load_balancer | Deletes the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer |
delete_rule | Deletes the specified rule |
delete_shared_trust_store_association | Deletes a shared trust store association |
delete_target_group | Deletes the specified target group |
delete_trust_store | Deletes a trust store |
deregister_targets | Deregisters the specified targets from the specified target group |
describe_account_limits | Describes the current Elastic Load Balancing resource limits for your Amazon Web Services account |
describe_capacity_reservation | Describes the capacity reservation status for the specified load balancer |
describe_listener_attributes | Describes the attributes for the specified listener |
describe_listener_certificates | Describes the default certificate and the certificate list for the specified HTTPS or TLS listener |
describe_listeners | Describes the specified listeners or the listeners for the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer |
describe_load_balancer_attributes | Describes the attributes for the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer |
describe_load_balancers | Describes the specified load balancers or all of your load balancers |
describe_rules | Describes the specified rules or the rules for the specified listener |
describe_ssl_policies | Describes the specified policies or all policies used for SSL negotiation |
describe_tags | Describes the tags for the specified Elastic Load Balancing resources |
describe_target_group_attributes | Describes the attributes for the specified target group |
describe_target_groups | Describes the specified target groups or all of your target groups |
describe_target_health | Describes the health of the specified targets or all of your targets |
describe_trust_store_associations | Describes all resources associated with the specified trust store |
describe_trust_store_revocations | Describes the revocation files in use by the specified trust store or revocation files |
describe_trust_stores | Describes all trust stores for the specified account |
get_resource_policy | Retrieves the resource policy for a specified resource |
get_trust_store_ca_certificates_bundle | Retrieves the ca certificate bundle |
get_trust_store_revocation_content | Retrieves the specified revocation file |
modify_capacity_reservation | Modifies the capacity reservation of the specified load balancer |
modify_listener | Replaces the specified properties of the specified listener |
modify_listener_attributes | Modifies the specified attributes of the specified listener |
modify_load_balancer_attributes | Modifies the specified attributes of the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer |
modify_rule | Replaces the specified properties of the specified rule |
modify_target_group | Modifies the health checks used when evaluating the health state of the targets in the specified target group |
modify_target_group_attributes | Modifies the specified attributes of the specified target group |
modify_trust_store | Update the ca certificate bundle for the specified trust store |
register_targets | Registers the specified targets with the specified target group |
remove_listener_certificates | Removes the specified certificate from the certificate list for the specified HTTPS or TLS listener |
remove_tags | Removes the specified tags from the specified Elastic Load Balancing resources |
remove_trust_store_revocations | Removes the specified revocation file from the specified trust store |
set_ip_address_type | Sets the type of IP addresses used by the subnets of the specified load balancer |
set_rule_priorities | Sets the priorities of the specified rules |
set_security_groups | Associates the specified security groups with the specified Application Load Balancer or Network Load Balancer |
set_subnets | Enables the Availability Zones for the specified public subnets for the specified Application Load Balancer, Network Load Balancer or Gateway Load Balancer |
Examples
## Not run:
svc <- elbv2()
# This example adds the specified tags to the specified load balancer.
svc$add_tags(
ResourceArns = list(
"arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/m..."
),
Tags = list(
list(
Key = "project",
Value = "lima"
),
list(
Key = "department",
Value = "digital-media"
)
)
)
## End(Not run)
Adds the specified SSL server certificate to the certificate list for the specified HTTPS or TLS listener
Description
Adds the specified SSL server certificate to the certificate list for the specified HTTPS or TLS listener.
See https://www.paws-r-sdk.com/docs/elbv2_add_listener_certificates/ for full documentation.
Usage
elbv2_add_listener_certificates(ListenerArn, Certificates)
Arguments
ListenerArn |
[required] The Amazon Resource Name (ARN) of the listener. |
Certificates |
[required] The certificate to add. You can specify one certificate per call. Set
|
Adds the specified tags to the specified Elastic Load Balancing resource
Description
Adds the specified tags to the specified Elastic Load Balancing resource. You can tag your Application Load Balancers, Network Load Balancers, Gateway Load Balancers, target groups, trust stores, listeners, and rules.
See https://www.paws-r-sdk.com/docs/elbv2_add_tags/ for full documentation.
Usage
elbv2_add_tags(ResourceArns, Tags)
Arguments
ResourceArns |
[required] The Amazon Resource Name (ARN) of the resource. |
Tags |
[required] The tags. |
Adds the specified revocation file to the specified trust store
Description
Adds the specified revocation file to the specified trust store.
See https://www.paws-r-sdk.com/docs/elbv2_add_trust_store_revocations/ for full documentation.
Usage
elbv2_add_trust_store_revocations(TrustStoreArn, RevocationContents = NULL)
Arguments
TrustStoreArn |
[required] The Amazon Resource Name (ARN) of the trust store. |
RevocationContents |
The revocation file to add. |
Creates a listener for the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer
Description
Creates a listener for the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.
See https://www.paws-r-sdk.com/docs/elbv2_create_listener/ for full documentation.
Usage
elbv2_create_listener(
LoadBalancerArn,
Protocol = NULL,
Port = NULL,
SslPolicy = NULL,
Certificates = NULL,
DefaultActions,
AlpnPolicy = NULL,
Tags = NULL,
MutualAuthentication = NULL
)
Arguments
LoadBalancerArn |
[required] The Amazon Resource Name (ARN) of the load balancer. |
Protocol |
The protocol for connections from clients to the load balancer. For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocols are TCP, TLS, UDP, and TCP_UDP. You can’t specify the UDP or TCP_UDP protocol if dual-stack mode is enabled. You can't specify a protocol for a Gateway Load Balancer. |
Port |
The port on which the load balancer is listening. You can't specify a port for a Gateway Load Balancer. |
SslPolicy |
[HTTPS and TLS listeners] The security policy that defines which protocols and ciphers are supported. For more information, see Security policies in the Application Load Balancers Guide and Security policies in the Network Load Balancers Guide. |
Certificates |
[HTTPS and TLS listeners] The default certificate for the listener.
You must provide exactly one certificate. Set |
DefaultActions |
[required] The actions for the default rule. |
AlpnPolicy |
[TLS listeners] The name of the Application-Layer Protocol Negotiation (ALPN) policy. You can specify one policy name. The following are the possible values:
For more information, see ALPN policies in the Network Load Balancers Guide. |
Tags |
The tags to assign to the listener. |
MutualAuthentication |
The mutual authentication configuration information. |
Creates an Application Load Balancer, Network Load Balancer, or Gateway Load Balancer
Description
Creates an Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.
See https://www.paws-r-sdk.com/docs/elbv2_create_load_balancer/ for full documentation.
Usage
elbv2_create_load_balancer(
Name,
Subnets = NULL,
SubnetMappings = NULL,
SecurityGroups = NULL,
Scheme = NULL,
Tags = NULL,
Type = NULL,
IpAddressType = NULL,
CustomerOwnedIpv4Pool = NULL,
EnablePrefixForIpv6SourceNat = NULL
)
Arguments
Name |
[required] The name of the load balancer. This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, must not begin or end with a hyphen, and must not begin with "internal-". |
Subnets |
The IDs of the subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both. To specify an Elastic IP address, specify subnet mappings instead of subnets. [Application Load Balancers] You must specify subnets from at least two Availability Zones. [Application Load Balancers on Outposts] You must specify one Outpost subnet. [Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones. [Network Load Balancers and Gateway Load Balancers] You can specify subnets from one or more Availability Zones. |
SubnetMappings |
The IDs of the subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both. [Application Load Balancers] You must specify subnets from at least two Availability Zones. You can't specify Elastic IP addresses for your subnets. [Application Load Balancers on Outposts] You must specify one Outpost subnet. [Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones. [Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet if you need static IP addresses for your internet-facing load balancer. For internal load balancers, you can specify one private IP address per subnet from the IPv4 range of the subnet. For internet-facing load balancer, you can specify one IPv6 address per subnet. [Gateway Load Balancers] You can specify subnets from one or more Availability Zones. You can't specify Elastic IP addresses for your subnets. |
SecurityGroups |
[Application Load Balancers and Network Load Balancers] The IDs of the security groups for the load balancer. |
Scheme |
The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet. The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can route requests only from clients with access to the VPC for the load balancer. The default is an Internet-facing load balancer. You can't specify a scheme for a Gateway Load Balancer. |
Tags |
The tags to assign to the load balancer. |
Type |
The type of load balancer. The default is |
IpAddressType |
The IP address type. Internal load balancers must use [Application Load Balancers] The possible values are [Network Load Balancers and Gateway Load Balancers] The possible
values are |
CustomerOwnedIpv4Pool |
[Application Load Balancers on Outposts] The ID of the customer-owned address pool (CoIP pool). |
EnablePrefixForIpv6SourceNat |
[Network Load Balancers with UDP listeners] Indicates whether to use
an IPv6 prefix from each subnet for source NAT. The IP address type must
be |
Creates a rule for the specified listener
Description
Creates a rule for the specified listener. The listener must be associated with an Application Load Balancer.
See https://www.paws-r-sdk.com/docs/elbv2_create_rule/ for full documentation.
Usage
elbv2_create_rule(ListenerArn, Conditions, Priority, Actions, Tags = NULL)
Arguments
ListenerArn |
[required] The Amazon Resource Name (ARN) of the listener. |
Conditions |
[required] The conditions. |
Priority |
[required] The rule priority. A listener can't have multiple rules with the same priority. |
Actions |
[required] The actions. |
Tags |
The tags to assign to the rule. |
Creates a target group
Description
Creates a target group.
See https://www.paws-r-sdk.com/docs/elbv2_create_target_group/ for full documentation.
Usage
elbv2_create_target_group(
Name,
Protocol = NULL,
ProtocolVersion = NULL,
Port = NULL,
VpcId = NULL,
HealthCheckProtocol = NULL,
HealthCheckPort = NULL,
HealthCheckEnabled = NULL,
HealthCheckPath = NULL,
HealthCheckIntervalSeconds = NULL,
HealthCheckTimeoutSeconds = NULL,
HealthyThresholdCount = NULL,
UnhealthyThresholdCount = NULL,
Matcher = NULL,
TargetType = NULL,
Tags = NULL,
IpAddressType = NULL
)
Arguments
Name |
[required] The name of the target group. This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and must not begin or end with a hyphen. |
Protocol |
The protocol to use for routing traffic to the targets. For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocols are TCP, TLS, UDP, or TCP_UDP. For Gateway Load Balancers, the supported protocol is GENEVE. A TCP_UDP listener must be associated with a TCP_UDP target group. If the target is a Lambda function, this parameter does not apply. |
ProtocolVersion |
[HTTP/HTTPS protocol] The protocol version. Specify |
Port |
The port on which the targets receive traffic. This port is used unless you specify a port override when registering the target. If the target is a Lambda function, this parameter does not apply. If the protocol is GENEVE, the supported port is 6081. |
VpcId |
The identifier of the virtual private cloud (VPC). If the target is a Lambda function, this parameter does not apply. Otherwise, this parameter is required. |
HealthCheckProtocol |
The protocol the load balancer uses when performing health checks on targets. For Application Load Balancers, the default is HTTP. For Network Load Balancers and Gateway Load Balancers, the default is TCP. The TCP protocol is not supported for health checks if the protocol of the target group is HTTP or HTTPS. The GENEVE, TLS, UDP, and TCP_UDP protocols are not supported for health checks. |
HealthCheckPort |
The port the load balancer uses when performing health checks on
targets. If the protocol is HTTP, HTTPS, TCP, TLS, UDP, or TCP_UDP, the
default is |
HealthCheckEnabled |
Indicates whether health checks are enabled. If the target type is
|
HealthCheckPath |
[HTTP/HTTPS health checks] The destination for health checks on the targets. [HTTP1 or HTTP2 protocol version] The ping path. The default is /. [GRPC protocol version] The path of a custom health check method with the format /package.service/method. The default is /Amazon Web Services.ALB/healthcheck. |
HealthCheckIntervalSeconds |
The approximate amount of time, in seconds, between health checks of an
individual target. The range is 5-300. If the target group protocol is
TCP, TLS, UDP, TCP_UDP, HTTP or HTTPS, the default is 30 seconds. If the
target group protocol is GENEVE, the default is 10 seconds. If the
target type is |
HealthCheckTimeoutSeconds |
The amount of time, in seconds, during which no response from a target
means a failed health check. The range is 2–120 seconds. For target
groups with a protocol of HTTP, the default is 6 seconds. For target
groups with a protocol of TCP, TLS or HTTPS, the default is 10 seconds.
For target groups with a protocol of GENEVE, the default is 5 seconds.
If the target type is |
HealthyThresholdCount |
The number of consecutive health check successes required before
considering a target healthy. The range is 2-10. If the target group
protocol is TCP, TCP_UDP, UDP, TLS, HTTP or HTTPS, the default is 5. For
target groups with a protocol of GENEVE, the default is 5. If the target
type is |
UnhealthyThresholdCount |
The number of consecutive health check failures required before
considering a target unhealthy. The range is 2-10. If the target group
protocol is TCP, TCP_UDP, UDP, TLS, HTTP or HTTPS, the default is 2. For
target groups with a protocol of GENEVE, the default is 2. If the target
type is |
Matcher |
[HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target. For target groups with a protocol of TCP, TCP_UDP, UDP or TLS the range is 200-599. For target groups with a protocol of HTTP or HTTPS, the range is 200-499. For target groups with a protocol of GENEVE, the range is 200-399. |
TargetType |
The type of target that you must specify when registering targets with this target group. You can't specify targets for a target group using more than one target type.
|
Tags |
The tags to assign to the target group. |
IpAddressType |
The IP address type. The default value is |
Creates a trust store
Description
Creates a trust store.
See https://www.paws-r-sdk.com/docs/elbv2_create_trust_store/ for full documentation.
Usage
elbv2_create_trust_store(
Name,
CaCertificatesBundleS3Bucket,
CaCertificatesBundleS3Key,
CaCertificatesBundleS3ObjectVersion = NULL,
Tags = NULL
)
Arguments
Name |
[required] The name of the trust store. This name must be unique per region and can't be changed after creation. |
CaCertificatesBundleS3Bucket |
[required] The Amazon S3 bucket for the ca certificates bundle. |
CaCertificatesBundleS3Key |
[required] The Amazon S3 path for the ca certificates bundle. |
CaCertificatesBundleS3ObjectVersion |
The Amazon S3 object version for the ca certificates bundle. If undefined the current version is used. |
Tags |
The tags to assign to the trust store. |
Deletes the specified listener
Description
Deletes the specified listener.
See https://www.paws-r-sdk.com/docs/elbv2_delete_listener/ for full documentation.
Usage
elbv2_delete_listener(ListenerArn)
Arguments
ListenerArn |
[required] The Amazon Resource Name (ARN) of the listener. |
Deletes the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer
Description
Deletes the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer. Deleting a load balancer also deletes its listeners.
See https://www.paws-r-sdk.com/docs/elbv2_delete_load_balancer/ for full documentation.
Usage
elbv2_delete_load_balancer(LoadBalancerArn)
Arguments
LoadBalancerArn |
[required] The Amazon Resource Name (ARN) of the load balancer. |
Deletes the specified rule
Description
Deletes the specified rule.
See https://www.paws-r-sdk.com/docs/elbv2_delete_rule/ for full documentation.
Usage
elbv2_delete_rule(RuleArn)
Arguments
RuleArn |
[required] The Amazon Resource Name (ARN) of the rule. |
Deletes a shared trust store association
Description
Deletes a shared trust store association.
See https://www.paws-r-sdk.com/docs/elbv2_delete_shared_trust_store_association/ for full documentation.
Usage
elbv2_delete_shared_trust_store_association(TrustStoreArn, ResourceArn)
Arguments
TrustStoreArn |
[required] The Amazon Resource Name (ARN) of the trust store. |
ResourceArn |
[required] The Amazon Resource Name (ARN) of the resource. |
Deletes the specified target group
Description
Deletes the specified target group.
See https://www.paws-r-sdk.com/docs/elbv2_delete_target_group/ for full documentation.
Usage
elbv2_delete_target_group(TargetGroupArn)
Arguments
TargetGroupArn |
[required] The Amazon Resource Name (ARN) of the target group. |
Deletes a trust store
Description
Deletes a trust store.
See https://www.paws-r-sdk.com/docs/elbv2_delete_trust_store/ for full documentation.
Usage
elbv2_delete_trust_store(TrustStoreArn)
Arguments
TrustStoreArn |
[required] The Amazon Resource Name (ARN) of the trust store. |
Deregisters the specified targets from the specified target group
Description
Deregisters the specified targets from the specified target group. After the targets are deregistered, they no longer receive traffic from the load balancer.
See https://www.paws-r-sdk.com/docs/elbv2_deregister_targets/ for full documentation.
Usage
elbv2_deregister_targets(TargetGroupArn, Targets)
Arguments
TargetGroupArn |
[required] The Amazon Resource Name (ARN) of the target group. |
Targets |
[required] The targets. If you specified a port override when you registered a target, you must specify both the target ID and the port when you deregister it. |
Describes the current Elastic Load Balancing resource limits for your Amazon Web Services account
Description
Describes the current Elastic Load Balancing resource limits for your Amazon Web Services account.
See https://www.paws-r-sdk.com/docs/elbv2_describe_account_limits/ for full documentation.
Usage
elbv2_describe_account_limits(Marker = NULL, PageSize = NULL)
Arguments
Marker |
The marker for the next set of results. (You received this marker from a previous call.) |
PageSize |
The maximum number of results to return with this call. |
Describes the capacity reservation status for the specified load balancer
Description
Describes the capacity reservation status for the specified load balancer.
See https://www.paws-r-sdk.com/docs/elbv2_describe_capacity_reservation/ for full documentation.
Usage
elbv2_describe_capacity_reservation(LoadBalancerArn)
Arguments
LoadBalancerArn |
[required] The Amazon Resource Name (ARN) of the load balancer. |
Describes the attributes for the specified listener
Description
Describes the attributes for the specified listener.
See https://www.paws-r-sdk.com/docs/elbv2_describe_listener_attributes/ for full documentation.
Usage
elbv2_describe_listener_attributes(ListenerArn)
Arguments
ListenerArn |
[required] The Amazon Resource Name (ARN) of the listener. |
Describes the default certificate and the certificate list for the specified HTTPS or TLS listener
Description
Describes the default certificate and the certificate list for the specified HTTPS or TLS listener.
See https://www.paws-r-sdk.com/docs/elbv2_describe_listener_certificates/ for full documentation.
Usage
elbv2_describe_listener_certificates(
ListenerArn,
Marker = NULL,
PageSize = NULL
)
Arguments
ListenerArn |
[required] The Amazon Resource Names (ARN) of the listener. |
Marker |
The marker for the next set of results. (You received this marker from a previous call.) |
PageSize |
The maximum number of results to return with this call. |
Describes the specified listeners or the listeners for the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer
Description
Describes the specified listeners or the listeners for the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer. You must specify either a load balancer or one or more listeners.
See https://www.paws-r-sdk.com/docs/elbv2_describe_listeners/ for full documentation.
Usage
elbv2_describe_listeners(
LoadBalancerArn = NULL,
ListenerArns = NULL,
Marker = NULL,
PageSize = NULL
)
Arguments
LoadBalancerArn |
The Amazon Resource Name (ARN) of the load balancer. |
ListenerArns |
The Amazon Resource Names (ARN) of the listeners. |
Marker |
The marker for the next set of results. (You received this marker from a previous call.) |
PageSize |
The maximum number of results to return with this call. |
Describes the attributes for the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer
Description
Describes the attributes for the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.
See https://www.paws-r-sdk.com/docs/elbv2_describe_load_balancer_attributes/ for full documentation.
Usage
elbv2_describe_load_balancer_attributes(LoadBalancerArn)
Arguments
LoadBalancerArn |
[required] The Amazon Resource Name (ARN) of the load balancer. |
Describes the specified load balancers or all of your load balancers
Description
Describes the specified load balancers or all of your load balancers.
See https://www.paws-r-sdk.com/docs/elbv2_describe_load_balancers/ for full documentation.
Usage
elbv2_describe_load_balancers(
LoadBalancerArns = NULL,
Names = NULL,
Marker = NULL,
PageSize = NULL
)
Arguments
LoadBalancerArns |
The Amazon Resource Names (ARN) of the load balancers. You can specify up to 20 load balancers in a single call. |
Names |
The names of the load balancers. |
Marker |
The marker for the next set of results. (You received this marker from a previous call.) |
PageSize |
The maximum number of results to return with this call. |
Describes the specified rules or the rules for the specified listener
Description
Describes the specified rules or the rules for the specified listener. You must specify either a listener or one or more rules.
See https://www.paws-r-sdk.com/docs/elbv2_describe_rules/ for full documentation.
Usage
elbv2_describe_rules(
ListenerArn = NULL,
RuleArns = NULL,
Marker = NULL,
PageSize = NULL
)
Arguments
ListenerArn |
The Amazon Resource Name (ARN) of the listener. |
RuleArns |
The Amazon Resource Names (ARN) of the rules. |
Marker |
The marker for the next set of results. (You received this marker from a previous call.) |
PageSize |
The maximum number of results to return with this call. |
Describes the specified policies or all policies used for SSL negotiation
Description
Describes the specified policies or all policies used for SSL negotiation.
See https://www.paws-r-sdk.com/docs/elbv2_describe_ssl_policies/ for full documentation.
Usage
elbv2_describe_ssl_policies(
Names = NULL,
Marker = NULL,
PageSize = NULL,
LoadBalancerType = NULL
)
Arguments
Names |
The names of the policies. |
Marker |
The marker for the next set of results. (You received this marker from a previous call.) |
PageSize |
The maximum number of results to return with this call. |
LoadBalancerType |
The type of load balancer. The default lists the SSL policies for all load balancers. |
Describes the tags for the specified Elastic Load Balancing resources
Description
Describes the tags for the specified Elastic Load Balancing resources. You can describe the tags for one or more Application Load Balancers, Network Load Balancers, Gateway Load Balancers, target groups, listeners, or rules.
See https://www.paws-r-sdk.com/docs/elbv2_describe_tags/ for full documentation.
Usage
elbv2_describe_tags(ResourceArns)
Arguments
ResourceArns |
[required] The Amazon Resource Names (ARN) of the resources. You can specify up to 20 resources in a single call. |
Describes the attributes for the specified target group
Description
Describes the attributes for the specified target group.
See https://www.paws-r-sdk.com/docs/elbv2_describe_target_group_attributes/ for full documentation.
Usage
elbv2_describe_target_group_attributes(TargetGroupArn)
Arguments
TargetGroupArn |
[required] The Amazon Resource Name (ARN) of the target group. |
Describes the specified target groups or all of your target groups
Description
Describes the specified target groups or all of your target groups. By default, all target groups are described. Alternatively, you can specify one of the following to filter the results: the ARN of the load balancer, the names of one or more target groups, or the ARNs of one or more target groups.
See https://www.paws-r-sdk.com/docs/elbv2_describe_target_groups/ for full documentation.
Usage
elbv2_describe_target_groups(
LoadBalancerArn = NULL,
TargetGroupArns = NULL,
Names = NULL,
Marker = NULL,
PageSize = NULL
)
Arguments
LoadBalancerArn |
The Amazon Resource Name (ARN) of the load balancer. |
TargetGroupArns |
The Amazon Resource Names (ARN) of the target groups. |
Names |
The names of the target groups. |
Marker |
The marker for the next set of results. (You received this marker from a previous call.) |
PageSize |
The maximum number of results to return with this call. |
Describes the health of the specified targets or all of your targets
Description
Describes the health of the specified targets or all of your targets.
See https://www.paws-r-sdk.com/docs/elbv2_describe_target_health/ for full documentation.
Usage
elbv2_describe_target_health(TargetGroupArn, Targets = NULL, Include = NULL)
Arguments
TargetGroupArn |
[required] The Amazon Resource Name (ARN) of the target group. |
Targets |
The targets. |
Include |
Used to include anomaly detection information. |
Describes all resources associated with the specified trust store
Description
Describes all resources associated with the specified trust store.
See https://www.paws-r-sdk.com/docs/elbv2_describe_trust_store_associations/ for full documentation.
Usage
elbv2_describe_trust_store_associations(
TrustStoreArn,
Marker = NULL,
PageSize = NULL
)
Arguments
TrustStoreArn |
[required] The Amazon Resource Name (ARN) of the trust store. |
Marker |
The marker for the next set of results. (You received this marker from a previous call.) |
PageSize |
The maximum number of results to return with this call. |
Describes the revocation files in use by the specified trust store or revocation files
Description
Describes the revocation files in use by the specified trust store or revocation files.
See https://www.paws-r-sdk.com/docs/elbv2_describe_trust_store_revocations/ for full documentation.
Usage
elbv2_describe_trust_store_revocations(
TrustStoreArn,
RevocationIds = NULL,
Marker = NULL,
PageSize = NULL
)
Arguments
TrustStoreArn |
[required] The Amazon Resource Name (ARN) of the trust store. |
RevocationIds |
The revocation IDs of the revocation files you want to describe. |
Marker |
The marker for the next set of results. (You received this marker from a previous call.) |
PageSize |
The maximum number of results to return with this call. |
Describes all trust stores for the specified account
Description
Describes all trust stores for the specified account.
See https://www.paws-r-sdk.com/docs/elbv2_describe_trust_stores/ for full documentation.
Usage
elbv2_describe_trust_stores(
TrustStoreArns = NULL,
Names = NULL,
Marker = NULL,
PageSize = NULL
)
Arguments
TrustStoreArns |
The Amazon Resource Name (ARN) of the trust store. |
Names |
The names of the trust stores. |
Marker |
The marker for the next set of results. (You received this marker from a previous call.) |
PageSize |
The maximum number of results to return with this call. |
Retrieves the resource policy for a specified resource
Description
Retrieves the resource policy for a specified resource.
See https://www.paws-r-sdk.com/docs/elbv2_get_resource_policy/ for full documentation.
Usage
elbv2_get_resource_policy(ResourceArn)
Arguments
ResourceArn |
[required] The Amazon Resource Name (ARN) of the resource. |
Retrieves the ca certificate bundle
Description
Retrieves the ca certificate bundle.
See https://www.paws-r-sdk.com/docs/elbv2_get_trust_store_ca_certificates_bundle/ for full documentation.
Usage
elbv2_get_trust_store_ca_certificates_bundle(TrustStoreArn)
Arguments
TrustStoreArn |
[required] The Amazon Resource Name (ARN) of the trust store. |
Retrieves the specified revocation file
Description
Retrieves the specified revocation file.
See https://www.paws-r-sdk.com/docs/elbv2_get_trust_store_revocation_content/ for full documentation.
Usage
elbv2_get_trust_store_revocation_content(TrustStoreArn, RevocationId)
Arguments
TrustStoreArn |
[required] The Amazon Resource Name (ARN) of the trust store. |
RevocationId |
[required] The revocation ID of the revocation file. |
Modifies the capacity reservation of the specified load balancer
Description
Modifies the capacity reservation of the specified load balancer.
See https://www.paws-r-sdk.com/docs/elbv2_modify_capacity_reservation/ for full documentation.
Usage
elbv2_modify_capacity_reservation(
LoadBalancerArn,
MinimumLoadBalancerCapacity = NULL,
ResetCapacityReservation = NULL
)
Arguments
LoadBalancerArn |
[required] The Amazon Resource Name (ARN) of the load balancer. |
MinimumLoadBalancerCapacity |
The minimum load balancer capacity reserved. |
ResetCapacityReservation |
Resets the capacity reservation. |
Replaces the specified properties of the specified listener
Description
Replaces the specified properties of the specified listener. Any properties that you do not specify remain unchanged.
See https://www.paws-r-sdk.com/docs/elbv2_modify_listener/ for full documentation.
Usage
elbv2_modify_listener(
ListenerArn,
Port = NULL,
Protocol = NULL,
SslPolicy = NULL,
Certificates = NULL,
DefaultActions = NULL,
AlpnPolicy = NULL,
MutualAuthentication = NULL
)
Arguments
ListenerArn |
[required] The Amazon Resource Name (ARN) of the listener. |
Port |
The port for connections from clients to the load balancer. You can't specify a port for a Gateway Load Balancer. |
Protocol |
The protocol for connections from clients to the load balancer. Application Load Balancers support the HTTP and HTTPS protocols. Network Load Balancers support the TCP, TLS, UDP, and TCP_UDP protocols. You can’t change the protocol to UDP or TCP_UDP if dual-stack mode is enabled. You can't specify a protocol for a Gateway Load Balancer. |
SslPolicy |
[HTTPS and TLS listeners] The security policy that defines which protocols and ciphers are supported. For more information, see Security policies in the Application Load Balancers Guide or Security policies in the Network Load Balancers Guide. |
Certificates |
[HTTPS and TLS listeners] The default certificate for the listener.
You must provide exactly one certificate. Set |
DefaultActions |
The actions for the default rule. |
AlpnPolicy |
[TLS listeners] The name of the Application-Layer Protocol Negotiation (ALPN) policy. You can specify one policy name. The following are the possible values:
For more information, see ALPN policies in the Network Load Balancers Guide. |
MutualAuthentication |
The mutual authentication configuration information. |
Modifies the specified attributes of the specified listener
Description
Modifies the specified attributes of the specified listener.
See https://www.paws-r-sdk.com/docs/elbv2_modify_listener_attributes/ for full documentation.
Usage
elbv2_modify_listener_attributes(ListenerArn, Attributes)
Arguments
ListenerArn |
[required] The Amazon Resource Name (ARN) of the listener. |
Attributes |
[required] The listener attributes. |
Modifies the specified attributes of the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer
Description
Modifies the specified attributes of the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.
See https://www.paws-r-sdk.com/docs/elbv2_modify_load_balancer_attributes/ for full documentation.
Usage
elbv2_modify_load_balancer_attributes(LoadBalancerArn, Attributes)
Arguments
LoadBalancerArn |
[required] The Amazon Resource Name (ARN) of the load balancer. |
Attributes |
[required] The load balancer attributes. |
Replaces the specified properties of the specified rule
Description
Replaces the specified properties of the specified rule. Any properties that you do not specify are unchanged.
See https://www.paws-r-sdk.com/docs/elbv2_modify_rule/ for full documentation.
Usage
elbv2_modify_rule(RuleArn, Conditions = NULL, Actions = NULL)
Arguments
RuleArn |
[required] The Amazon Resource Name (ARN) of the rule. |
Conditions |
The conditions. |
Actions |
The actions. |
Modifies the health checks used when evaluating the health state of the targets in the specified target group
Description
Modifies the health checks used when evaluating the health state of the targets in the specified target group.
See https://www.paws-r-sdk.com/docs/elbv2_modify_target_group/ for full documentation.
Usage
elbv2_modify_target_group(
TargetGroupArn,
HealthCheckProtocol = NULL,
HealthCheckPort = NULL,
HealthCheckPath = NULL,
HealthCheckEnabled = NULL,
HealthCheckIntervalSeconds = NULL,
HealthCheckTimeoutSeconds = NULL,
HealthyThresholdCount = NULL,
UnhealthyThresholdCount = NULL,
Matcher = NULL
)
Arguments
TargetGroupArn |
[required] The Amazon Resource Name (ARN) of the target group. |
HealthCheckProtocol |
The protocol the load balancer uses when performing health checks on targets. For Application Load Balancers, the default is HTTP. For Network Load Balancers and Gateway Load Balancers, the default is TCP. The TCP protocol is not supported for health checks if the protocol of the target group is HTTP or HTTPS. It is supported for health checks only if the protocol of the target group is TCP, TLS, UDP, or TCP_UDP. The GENEVE, TLS, UDP, and TCP_UDP protocols are not supported for health checks. |
HealthCheckPort |
The port the load balancer uses when performing health checks on targets. |
HealthCheckPath |
[HTTP/HTTPS health checks] The destination for health checks on the targets. [HTTP1 or HTTP2 protocol version] The ping path. The default is /. [GRPC protocol version] The path of a custom health check method with the format /package.service/method. The default is /Amazon Web Services.ALB/healthcheck. |
HealthCheckEnabled |
Indicates whether health checks are enabled. |
HealthCheckIntervalSeconds |
The approximate amount of time, in seconds, between health checks of an individual target. |
HealthCheckTimeoutSeconds |
[HTTP/HTTPS health checks] The amount of time, in seconds, during which no response means a failed health check. |
HealthyThresholdCount |
The number of consecutive health checks successes required before considering an unhealthy target healthy. |
UnhealthyThresholdCount |
The number of consecutive health check failures required before considering the target unhealthy. |
Matcher |
[HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target. For target groups with a protocol of TCP, TCP_UDP, UDP or TLS the range is 200-599. For target groups with a protocol of HTTP or HTTPS, the range is 200-499. For target groups with a protocol of GENEVE, the range is 200-399. |
Modifies the specified attributes of the specified target group
Description
Modifies the specified attributes of the specified target group.
See https://www.paws-r-sdk.com/docs/elbv2_modify_target_group_attributes/ for full documentation.
Usage
elbv2_modify_target_group_attributes(TargetGroupArn, Attributes)
Arguments
TargetGroupArn |
[required] The Amazon Resource Name (ARN) of the target group. |
Attributes |
[required] The target group attributes. |
Update the ca certificate bundle for the specified trust store
Description
Update the ca certificate bundle for the specified trust store.
See https://www.paws-r-sdk.com/docs/elbv2_modify_trust_store/ for full documentation.
Usage
elbv2_modify_trust_store(
TrustStoreArn,
CaCertificatesBundleS3Bucket,
CaCertificatesBundleS3Key,
CaCertificatesBundleS3ObjectVersion = NULL
)
Arguments
TrustStoreArn |
[required] The Amazon Resource Name (ARN) of the trust store. |
CaCertificatesBundleS3Bucket |
[required] The Amazon S3 bucket for the ca certificates bundle. |
CaCertificatesBundleS3Key |
[required] The Amazon S3 path for the ca certificates bundle. |
CaCertificatesBundleS3ObjectVersion |
The Amazon S3 object version for the ca certificates bundle. If undefined the current version is used. |
Registers the specified targets with the specified target group
Description
Registers the specified targets with the specified target group.
See https://www.paws-r-sdk.com/docs/elbv2_register_targets/ for full documentation.
Usage
elbv2_register_targets(TargetGroupArn, Targets)
Arguments
TargetGroupArn |
[required] The Amazon Resource Name (ARN) of the target group. |
Targets |
[required] The targets. |
Removes the specified certificate from the certificate list for the specified HTTPS or TLS listener
Description
Removes the specified certificate from the certificate list for the specified HTTPS or TLS listener.
See https://www.paws-r-sdk.com/docs/elbv2_remove_listener_certificates/ for full documentation.
Usage
elbv2_remove_listener_certificates(ListenerArn, Certificates)
Arguments
ListenerArn |
[required] The Amazon Resource Name (ARN) of the listener. |
Certificates |
[required] The certificate to remove. You can specify one certificate per call. Set
|
Removes the specified tags from the specified Elastic Load Balancing resources
Description
Removes the specified tags from the specified Elastic Load Balancing resources. You can remove the tags for one or more Application Load Balancers, Network Load Balancers, Gateway Load Balancers, target groups, listeners, or rules.
See https://www.paws-r-sdk.com/docs/elbv2_remove_tags/ for full documentation.
Usage
elbv2_remove_tags(ResourceArns, TagKeys)
Arguments
ResourceArns |
[required] The Amazon Resource Name (ARN) of the resource. |
TagKeys |
[required] The tag keys for the tags to remove. |
Removes the specified revocation file from the specified trust store
Description
Removes the specified revocation file from the specified trust store.
See https://www.paws-r-sdk.com/docs/elbv2_remove_trust_store_revocations/ for full documentation.
Usage
elbv2_remove_trust_store_revocations(TrustStoreArn, RevocationIds)
Arguments
TrustStoreArn |
[required] The Amazon Resource Name (ARN) of the trust store. |
RevocationIds |
[required] The revocation IDs of the revocation files you want to remove. |
Sets the type of IP addresses used by the subnets of the specified load balancer
Description
Sets the type of IP addresses used by the subnets of the specified load balancer.
See https://www.paws-r-sdk.com/docs/elbv2_set_ip_address_type/ for full documentation.
Usage
elbv2_set_ip_address_type(LoadBalancerArn, IpAddressType)
Arguments
LoadBalancerArn |
[required] The Amazon Resource Name (ARN) of the load balancer. |
IpAddressType |
[required] The IP address type. Internal load balancers must use [Application Load Balancers] The possible values are Application Load Balancer authentication supports IPv4 addresses only when connecting to an Identity Provider (IdP) or Amazon Cognito endpoint. Without a public IPv4 address the load balancer can't complete the authentication process, resulting in HTTP 500 errors. [Network Load Balancers and Gateway Load Balancers] The possible
values are |
Sets the priorities of the specified rules
Description
Sets the priorities of the specified rules.
See https://www.paws-r-sdk.com/docs/elbv2_set_rule_priorities/ for full documentation.
Usage
elbv2_set_rule_priorities(RulePriorities)
Arguments
RulePriorities |
[required] The rule priorities. |
Associates the specified security groups with the specified Application Load Balancer or Network Load Balancer
Description
Associates the specified security groups with the specified Application Load Balancer or Network Load Balancer. The specified security groups override the previously associated security groups.
See https://www.paws-r-sdk.com/docs/elbv2_set_security_groups/ for full documentation.
Usage
elbv2_set_security_groups(
LoadBalancerArn,
SecurityGroups,
EnforceSecurityGroupInboundRulesOnPrivateLinkTraffic = NULL
)
Arguments
LoadBalancerArn |
[required] The Amazon Resource Name (ARN) of the load balancer. |
SecurityGroups |
[required] The IDs of the security groups. |
EnforceSecurityGroupInboundRulesOnPrivateLinkTraffic |
Indicates whether to evaluate inbound security group rules for traffic
sent to a Network Load Balancer through Amazon Web Services PrivateLink.
The default is |
Enables the Availability Zones for the specified public subnets for the specified Application Load Balancer, Network Load Balancer or Gateway Load Balancer
Description
Enables the Availability Zones for the specified public subnets for the specified Application Load Balancer, Network Load Balancer or Gateway Load Balancer. The specified subnets replace the previously enabled subnets.
See https://www.paws-r-sdk.com/docs/elbv2_set_subnets/ for full documentation.
Usage
elbv2_set_subnets(
LoadBalancerArn,
Subnets = NULL,
SubnetMappings = NULL,
IpAddressType = NULL,
EnablePrefixForIpv6SourceNat = NULL
)
Arguments
LoadBalancerArn |
[required] The Amazon Resource Name (ARN) of the load balancer. |
Subnets |
The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings. [Application Load Balancers] You must specify subnets from at least two Availability Zones. [Application Load Balancers on Outposts] You must specify one Outpost subnet. [Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones. [Network Load Balancers and Gateway Load Balancers] You can specify subnets from one or more Availability Zones. |
SubnetMappings |
The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings. [Application Load Balancers] You must specify subnets from at least two Availability Zones. You can't specify Elastic IP addresses for your subnets. [Application Load Balancers on Outposts] You must specify one Outpost subnet. [Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones. [Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet if you need static IP addresses for your internet-facing load balancer. For internal load balancers, you can specify one private IP address per subnet from the IPv4 range of the subnet. For internet-facing load balancer, you can specify one IPv6 address per subnet. [Gateway Load Balancers] You can specify subnets from one or more Availability Zones. |
IpAddressType |
The IP address type. [Application Load Balancers] The possible values are [Network Load Balancers and Gateway Load Balancers] The possible
values are |
EnablePrefixForIpv6SourceNat |
[Network Load Balancers with UDP listeners] Indicates whether to use
an IPv6 prefix from each subnet for source NAT. The IP address type must
be |
AWS Global Accelerator
Description
Global Accelerator
This is the Global Accelerator API Reference. This guide is for developers who need detailed information about Global Accelerator API actions, data types, and errors. For more information about Global Accelerator features, see the Global Accelerator Developer Guide.
Global Accelerator is a service in which you create accelerators to improve the performance of your applications for local and global users. Depending on the type of accelerator you choose, you can gain additional benefits.
By using a standard accelerator, you can improve availability of your internet applications that are used by a global audience. With a standard accelerator, Global Accelerator directs traffic to optimal endpoints over the Amazon Web Services global network.
For other scenarios, you might choose a custom routing accelerator. With a custom routing accelerator, you can use application logic to directly map one or more users to a specific endpoint among many endpoints.
Global Accelerator is a global service that supports endpoints in
multiple Amazon Web Services Regions but you must specify the US West
(Oregon) Region to create, update, or otherwise work with accelerators.
That is, for example, specify --region us-west-2
on Amazon Web
Services CLI commands.
By default, Global Accelerator provides you with static IP addresses that you associate with your accelerator. The static IP addresses are anycast from the Amazon Web Services edge network. For IPv4, Global Accelerator provides two static IPv4 addresses. For dual-stack, Global Accelerator provides a total of four addresses: two static IPv4 addresses and two static IPv6 addresses. With a standard accelerator for IPv4, instead of using the addresses that Global Accelerator provides, you can configure these entry points to be IPv4 addresses from your own IP address ranges that you bring to Global Accelerator (BYOIP).
For a standard accelerator, they distribute incoming application traffic across multiple endpoint resources in multiple Amazon Web Services Regions , which increases the availability of your applications. Endpoints for standard accelerators can be Network Load Balancers, Application Load Balancers, Amazon EC2 instances, or Elastic IP addresses that are located in one Amazon Web Services Region or multiple Amazon Web Services Regions. For custom routing accelerators, you map traffic that arrives to the static IP addresses to specific Amazon EC2 servers in endpoints that are virtual private cloud (VPC) subnets.
The static IP addresses remain assigned to your accelerator for as long as it exists, even if you disable the accelerator and it no longer accepts or routes traffic. However, when you delete an accelerator, you lose the static IP addresses that are assigned to it, so you can no longer route traffic by using them. You can use IAM policies like tag-based permissions with Global Accelerator to limit the users who have permissions to delete an accelerator. For more information, see Tag-based policies.
For standard accelerators, Global Accelerator uses the Amazon Web Services global network to route traffic to the optimal regional endpoint based on health, client location, and policies that you configure. The service reacts instantly to changes in health or configuration to ensure that internet traffic from clients is always directed to healthy endpoints.
For more information about understanding and using Global Accelerator, see the Global Accelerator Developer Guide.
Usage
globalaccelerator(
config = list(),
credentials = list(),
endpoint = NULL,
region = NULL
)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...)
, where svc
is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- globalaccelerator( config = list( credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string", close_connection = "logical", timeout = "numeric", s3_force_path_style = "logical", sts_regional_endpoint = "string" ), credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string" )
Operations
add_custom_routing_endpoints | Associate a virtual private cloud (VPC) subnet endpoint with your custom routing accelerator |
add_endpoints | Add endpoints to an endpoint group |
advertise_byoip_cidr | Advertises an IPv4 address range that is provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) |
allow_custom_routing_traffic | Specify the Amazon EC2 instance (destination) IP addresses and ports for a VPC subnet endpoint that can receive traffic for a custom routing accelerator |
create_accelerator | Create an accelerator |
create_cross_account_attachment | Create a cross-account attachment in Global Accelerator |
create_custom_routing_accelerator | Create a custom routing accelerator |
create_custom_routing_endpoint_group | Create an endpoint group for the specified listener for a custom routing accelerator |
create_custom_routing_listener | Create a listener to process inbound connections from clients to a custom routing accelerator |
create_endpoint_group | Create an endpoint group for the specified listener |
create_listener | Create a listener to process inbound connections from clients to an accelerator |
delete_accelerator | Delete an accelerator |
delete_cross_account_attachment | Delete a cross-account attachment |
delete_custom_routing_accelerator | Delete a custom routing accelerator |
delete_custom_routing_endpoint_group | Delete an endpoint group from a listener for a custom routing accelerator |
delete_custom_routing_listener | Delete a listener for a custom routing accelerator |
delete_endpoint_group | Delete an endpoint group from a listener |
delete_listener | Delete a listener from an accelerator |
deny_custom_routing_traffic | Specify the Amazon EC2 instance (destination) IP addresses and ports for a VPC subnet endpoint that cannot receive traffic for a custom routing accelerator |
deprovision_byoip_cidr | Releases the specified address range that you provisioned to use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and deletes the corresponding address pool |
describe_accelerator | Describe an accelerator |
describe_accelerator_attributes | Describe the attributes of an accelerator |
describe_cross_account_attachment | Gets configuration information about a cross-account attachment |
describe_custom_routing_accelerator | Describe a custom routing accelerator |
describe_custom_routing_accelerator_attributes | Describe the attributes of a custom routing accelerator |
describe_custom_routing_endpoint_group | Describe an endpoint group for a custom routing accelerator |
describe_custom_routing_listener | The description of a listener for a custom routing accelerator |
describe_endpoint_group | Describe an endpoint group |
describe_listener | Describe a listener |
list_accelerators | List the accelerators for an Amazon Web Services account |
list_byoip_cidrs | Lists the IP address ranges that were specified in calls to ProvisionByoipCidr, including the current state and a history of state changes |
list_cross_account_attachments | List the cross-account attachments that have been created in Global Accelerator |
list_cross_account_resource_accounts | List the accounts that have cross-account resources |
list_cross_account_resources | List the cross-account resources available to work with |
list_custom_routing_accelerators | List the custom routing accelerators for an Amazon Web Services account |
list_custom_routing_endpoint_groups | List the endpoint groups that are associated with a listener for a custom routing accelerator |
list_custom_routing_listeners | List the listeners for a custom routing accelerator |
list_custom_routing_port_mappings | Provides a complete mapping from the public accelerator IP address and port to destination EC2 instance IP addresses and ports in the virtual public cloud (VPC) subnet endpoint for a custom routing accelerator |
list_custom_routing_port_mappings_by_destination | List the port mappings for a specific EC2 instance (destination) in a VPC subnet endpoint |
list_endpoint_groups | List the endpoint groups that are associated with a listener |
list_listeners | List the listeners for an accelerator |
list_tags_for_resource | List all tags for an accelerator |
provision_byoip_cidr | Provisions an IP address range to use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and creates a corresponding address pool |
remove_custom_routing_endpoints | Remove endpoints from a custom routing accelerator |
remove_endpoints | Remove endpoints from an endpoint group |
tag_resource | Add tags to an accelerator resource |
untag_resource | Remove tags from a Global Accelerator resource |
update_accelerator | Update an accelerator to make changes, such as the following: |
update_accelerator_attributes | Update the attributes for an accelerator |
update_cross_account_attachment | Update a cross-account attachment to add or remove principals or resources |
update_custom_routing_accelerator | Update a custom routing accelerator |
update_custom_routing_accelerator_attributes | Update the attributes for a custom routing accelerator |
update_custom_routing_listener | Update a listener for a custom routing accelerator |
update_endpoint_group | Update an endpoint group |
update_listener | Update a listener |
withdraw_byoip_cidr | Stops advertising an address range that is provisioned as an address pool |
Examples
## Not run:
svc <- globalaccelerator()
svc$add_custom_routing_endpoints(
Foo = 123
)
## End(Not run)
Associate a virtual private cloud (VPC) subnet endpoint with your custom routing accelerator
Description
Associate a virtual private cloud (VPC) subnet endpoint with your custom routing accelerator.
See https://www.paws-r-sdk.com/docs/globalaccelerator_add_custom_routing_endpoints/ for full documentation.
Usage
globalaccelerator_add_custom_routing_endpoints(
EndpointConfigurations,
EndpointGroupArn
)
Arguments
EndpointConfigurations |
[required] The list of endpoint objects to add to a custom routing accelerator. |
EndpointGroupArn |
[required] The Amazon Resource Name (ARN) of the endpoint group for the custom routing endpoint. |
Add endpoints to an endpoint group
Description
Add endpoints to an endpoint group. The add_endpoints
API operation is the recommended option for adding endpoints. The alternative options are to add endpoints when you create an endpoint group (with the create_endpoint_group
API) or when you update an endpoint group (with the update_endpoint_group
API).
See https://www.paws-r-sdk.com/docs/globalaccelerator_add_endpoints/ for full documentation.
Usage
globalaccelerator_add_endpoints(EndpointConfigurations, EndpointGroupArn)
Arguments
EndpointConfigurations |
[required] The list of endpoint objects. |
EndpointGroupArn |
[required] The Amazon Resource Name (ARN) of the endpoint group. |
Advertises an IPv4 address range that is provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP)
Description
Advertises an IPv4 address range that is provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP). It can take a few minutes before traffic to the specified addresses starts routing to Amazon Web Services because of propagation delays.
See https://www.paws-r-sdk.com/docs/globalaccelerator_advertise_byoip_cidr/ for full documentation.
Usage
globalaccelerator_advertise_byoip_cidr(Cidr)
Arguments
Cidr |
[required] The address range, in CIDR notation. This must be the exact range that you provisioned. You can't advertise only a portion of the provisioned range. For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide. |
Specify the Amazon EC2 instance (destination) IP addresses and ports for a VPC subnet endpoint that can receive traffic for a custom routing accelerator
Description
Specify the Amazon EC2 instance (destination) IP addresses and ports for a VPC subnet endpoint that can receive traffic for a custom routing accelerator. You can allow traffic to all destinations in the subnet endpoint, or allow traffic to a specified list of destination IP addresses and ports in the subnet. Note that you cannot specify IP addresses or ports outside of the range that you configured for the endpoint group.
See https://www.paws-r-sdk.com/docs/globalaccelerator_allow_custom_routing_traffic/ for full documentation.
Usage
globalaccelerator_allow_custom_routing_traffic(
EndpointGroupArn,
EndpointId,
DestinationAddresses = NULL,
DestinationPorts = NULL,
AllowAllTrafficToEndpoint = NULL
)
Arguments
EndpointGroupArn |
[required] The Amazon Resource Name (ARN) of the endpoint group. |
EndpointId |
[required] An ID for the endpoint. For custom routing accelerators, this is the virtual private cloud (VPC) subnet ID. |
DestinationAddresses |
A list of specific Amazon EC2 instance IP addresses (destination addresses) in a subnet that you want to allow to receive traffic. The IP addresses must be a subset of the IP addresses that you specified for the endpoint group.
|
DestinationPorts |
A list of specific Amazon EC2 instance ports (destination ports) that you want to allow to receive traffic. |
AllowAllTrafficToEndpoint |
Indicates whether all destination IP addresses and ports for a specified VPC subnet endpoint can receive traffic from a custom routing accelerator. The value is TRUE or FALSE. When set to TRUE, all destinations in the custom routing VPC subnet can receive traffic. Note that you cannot specify destination IP addresses and ports when the value is set to TRUE. When set to FALSE (or not specified), you must specify a list of destination IP addresses that are allowed to receive traffic. A list of ports is optional. If you don't specify a list of ports, the ports that can accept traffic is the same as the ports configured for the endpoint group. The default value is FALSE. |
Create an accelerator
Description
Create an accelerator. An accelerator includes one or more listeners that process inbound connections and direct traffic to one or more endpoint groups, each of which includes endpoints, such as Network Load Balancers.
See https://www.paws-r-sdk.com/docs/globalaccelerator_create_accelerator/ for full documentation.
Usage
globalaccelerator_create_accelerator(
Name,
IpAddressType = NULL,
IpAddresses = NULL,
Enabled = NULL,
IdempotencyToken,
Tags = NULL
)
Arguments
Name |
[required] The name of the accelerator. The name can have a maximum of 64 characters, must contain only alphanumeric characters, periods (.), or hyphens (-), and must not begin or end with a hyphen or period. |
IpAddressType |
The IP address type that an accelerator supports. For a standard accelerator, the value can be IPV4 or DUAL_STACK. |
IpAddresses |
Optionally, if you've added your own IP address pool to Global Accelerator (BYOIP), you can choose an IPv4 address from your own pool to use for the accelerator's static IPv4 address when you create an accelerator. After you bring an address range to Amazon Web Services, it appears in your account as an address pool. When you create an accelerator, you can assign one IPv4 address from your range to it. Global Accelerator assigns you a second static IPv4 address from an Amazon IP address range. If you bring two IPv4 address ranges to Amazon Web Services, you can assign one IPv4 address from each range to your accelerator. This restriction is because Global Accelerator assigns each address range to a different network zone, for high availability. You can specify one or two addresses, separated by a space. Do not include the /32 suffix. Note that you can't update IP addresses for an existing accelerator. To change them, you must create a new accelerator with the new addresses. For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide. |
Enabled |
Indicates whether an accelerator is enabled. The value is true or false. The default value is true. If the value is set to true, an accelerator cannot be deleted. If set to false, the accelerator can be deleted. |
IdempotencyToken |
[required] A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of an accelerator. |
Tags |
Create tags for an accelerator. For more information, see Tagging in Global Accelerator in the Global Accelerator Developer Guide. |
Create a cross-account attachment in Global Accelerator
Description
Create a cross-account attachment in Global Accelerator. You create a cross-account attachment to specify the principals who have permission to work with resources in accelerators in their own account. You specify, in the same attachment, the resources that are shared.
See https://www.paws-r-sdk.com/docs/globalaccelerator_create_cross_account_attachment/ for full documentation.
Usage
globalaccelerator_create_cross_account_attachment(
Name,
Principals = NULL,
Resources = NULL,
IdempotencyToken,
Tags = NULL
)
Arguments
Name |
[required] The name of the cross-account attachment. |
Principals |
The principals to include in the cross-account attachment. A principal can be an Amazon Web Services account number or the Amazon Resource Name (ARN) for an accelerator. |
Resources |
The Amazon Resource Names (ARNs) for the resources to include in the cross-account attachment. A resource can be any supported Amazon Web Services resource type for Global Accelerator or a CIDR range for a bring your own IP address (BYOIP) address pool. |
IdempotencyToken |
[required] A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request. |
Tags |
Add tags for a cross-account attachment. For more information, see Tagging in Global Accelerator in the Global Accelerator Developer Guide. |
Create a custom routing accelerator
Description
Create a custom routing accelerator. A custom routing accelerator directs traffic to one of possibly thousands of Amazon EC2 instance destinations running in a single or multiple virtual private clouds (VPC) subnet endpoints.
See https://www.paws-r-sdk.com/docs/globalaccelerator_create_custom_routing_accelerator/ for full documentation.
Usage
globalaccelerator_create_custom_routing_accelerator(
Name,
IpAddressType = NULL,
IpAddresses = NULL,
Enabled = NULL,
IdempotencyToken,
Tags = NULL
)
Arguments
Name |
[required] The name of a custom routing accelerator. The name can have a maximum of 64 characters, must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen. |
IpAddressType |
The IP address type that an accelerator supports. For a custom routing accelerator, the value must be IPV4. |
IpAddresses |
Optionally, if you've added your own IP address pool to Global Accelerator (BYOIP), you can choose an IPv4 address from your own pool to use for the accelerator's static IPv4 address when you create an accelerator. After you bring an address range to Amazon Web Services, it appears in your account as an address pool. When you create an accelerator, you can assign one IPv4 address from your range to it. Global Accelerator assigns you a second static IPv4 address from an Amazon IP address range. If you bring two IPv4 address ranges to Amazon Web Services, you can assign one IPv4 address from each range to your accelerator. This restriction is because Global Accelerator assigns each address range to a different network zone, for high availability. You can specify one or two addresses, separated by a space. Do not include the /32 suffix. Note that you can't update IP addresses for an existing accelerator. To change them, you must create a new accelerator with the new addresses. For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide. |
Enabled |
Indicates whether an accelerator is enabled. The value is true or false. The default value is true. If the value is set to true, an accelerator cannot be deleted. If set to false, the accelerator can be deleted. |
IdempotencyToken |
[required] A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request. |
Tags |
Create tags for an accelerator. For more information, see Tagging in Global Accelerator in the Global Accelerator Developer Guide. |
Create an endpoint group for the specified listener for a custom routing accelerator
Description
Create an endpoint group for the specified listener for a custom routing accelerator. An endpoint group is a collection of endpoints in one Amazon Web Services Region.
See https://www.paws-r-sdk.com/docs/globalaccelerator_create_custom_routing_endpoint_group/ for full documentation.
Usage
globalaccelerator_create_custom_routing_endpoint_group(
ListenerArn,
EndpointGroupRegion,
DestinationConfigurations,
IdempotencyToken
)
Arguments
ListenerArn |
[required] The Amazon Resource Name (ARN) of the listener for a custom routing endpoint. |
EndpointGroupRegion |
[required] The Amazon Web Services Region where the endpoint group is located. A listener can have only one endpoint group in a specific Region. |
DestinationConfigurations |
[required] Sets the port range and protocol for all endpoints (virtual private cloud subnets) in a custom routing endpoint group to accept client traffic on. |
IdempotencyToken |
[required] A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request. |
Create a listener to process inbound connections from clients to a custom routing accelerator
Description
Create a listener to process inbound connections from clients to a custom routing accelerator. Connections arrive to assigned static IP addresses on the port range that you specify.
See https://www.paws-r-sdk.com/docs/globalaccelerator_create_custom_routing_listener/ for full documentation.
Usage
globalaccelerator_create_custom_routing_listener(
AcceleratorArn,
PortRanges,
IdempotencyToken
)
Arguments
AcceleratorArn |
[required] The Amazon Resource Name (ARN) of the accelerator for a custom routing listener. |
PortRanges |
[required] The port range to support for connections from clients to your accelerator. Separately, you set port ranges for endpoints. For more information, see About endpoints for custom routing accelerators. |
IdempotencyToken |
[required] A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request. |
Create an endpoint group for the specified listener
Description
Create an endpoint group for the specified listener. An endpoint group is a collection of endpoints in one Amazon Web Services Region. A resource must be valid and active when you add it as an endpoint.
See https://www.paws-r-sdk.com/docs/globalaccelerator_create_endpoint_group/ for full documentation.
Usage
globalaccelerator_create_endpoint_group(
ListenerArn,
EndpointGroupRegion,
EndpointConfigurations = NULL,
TrafficDialPercentage = NULL,
HealthCheckPort = NULL,
HealthCheckProtocol = NULL,
HealthCheckPath = NULL,
HealthCheckIntervalSeconds = NULL,
ThresholdCount = NULL,
IdempotencyToken,
PortOverrides = NULL
)
Arguments
ListenerArn |
[required] The Amazon Resource Name (ARN) of the listener. |
EndpointGroupRegion |
[required] The Amazon Web Services Region where the endpoint group is located. A listener can have only one endpoint group in a specific Region. |
EndpointConfigurations |
The list of endpoint objects. |
TrafficDialPercentage |
The percentage of traffic to send to an Amazon Web Services Region. Additional traffic is distributed to other endpoint groups for this listener. Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing. The default value is 100. |
HealthCheckPort |
The port that Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default port is the listener port that this endpoint group is associated with. If listener port is a list of ports, Global Accelerator uses the first port in the list. |
HealthCheckProtocol |
The protocol that Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default value is TCP. |
HealthCheckPath |
If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The default value is slash (/). |
HealthCheckIntervalSeconds |
The time—10 seconds or 30 seconds—between each health check for an endpoint. The default value is 30. |
ThresholdCount |
The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3. |
IdempotencyToken |
[required] A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request. |
PortOverrides |
Override specific listener ports used to route traffic to endpoints that are part of this endpoint group. For example, you can create a port override in which the listener receives user traffic on ports 80 and 443, but your accelerator routes that traffic to ports 1080 and 1443, respectively, on the endpoints. For more information, see Overriding listener ports in the Global Accelerator Developer Guide. |
Create a listener to process inbound connections from clients to an accelerator
Description
Create a listener to process inbound connections from clients to an accelerator. Connections arrive to assigned static IP addresses on a port, port range, or list of port ranges that you specify.
See https://www.paws-r-sdk.com/docs/globalaccelerator_create_listener/ for full documentation.
Usage
globalaccelerator_create_listener(
AcceleratorArn,
PortRanges,
Protocol,
ClientAffinity = NULL,
IdempotencyToken
)
Arguments
AcceleratorArn |
[required] The Amazon Resource Name (ARN) of your accelerator. |
PortRanges |
[required] The list of port ranges to support for connections from clients to your accelerator. |
Protocol |
[required] The protocol for connections from clients to your accelerator. |
ClientAffinity |
Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications, regardless of the port and protocol of the client request. Client affinity gives you control over whether to always route each client to the same specific endpoint. Global Accelerator uses a consistent-flow hashing algorithm to choose
the optimal endpoint for a connection. If client affinity is If you want a given client to always be routed to the same endpoint, set
client affinity to The default value is |
IdempotencyToken |
[required] A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request. |
Delete an accelerator
Description
Delete an accelerator. Before you can delete an accelerator, you must disable it and remove all dependent resources (listeners and endpoint groups). To disable the accelerator, update the accelerator to set Enabled
to false.
See https://www.paws-r-sdk.com/docs/globalaccelerator_delete_accelerator/ for full documentation.
Usage
globalaccelerator_delete_accelerator(AcceleratorArn)
Arguments
AcceleratorArn |
[required] The Amazon Resource Name (ARN) of an accelerator. |
Delete a cross-account attachment
Description
Delete a cross-account attachment. When you delete an attachment, Global Accelerator revokes the permission to use the resources in the attachment from all principals in the list of principals. Global Accelerator revokes the permission for specific resources.
See https://www.paws-r-sdk.com/docs/globalaccelerator_delete_cross_account_attachment/ for full documentation.
Usage
globalaccelerator_delete_cross_account_attachment(AttachmentArn)
Arguments
AttachmentArn |
[required] The Amazon Resource Name (ARN) for the cross-account attachment to delete. |
Delete a custom routing accelerator
Description
Delete a custom routing accelerator. Before you can delete an accelerator, you must disable it and remove all dependent resources (listeners and endpoint groups). To disable the accelerator, update the accelerator to set Enabled
to false.
See https://www.paws-r-sdk.com/docs/globalaccelerator_delete_custom_routing_accelerator/ for full documentation.
Usage
globalaccelerator_delete_custom_routing_accelerator(AcceleratorArn)
Arguments
AcceleratorArn |
[required] The Amazon Resource Name (ARN) of the custom routing accelerator to delete. |
Delete an endpoint group from a listener for a custom routing accelerator
Description
Delete an endpoint group from a listener for a custom routing accelerator.
See https://www.paws-r-sdk.com/docs/globalaccelerator_delete_custom_routing_endpoint_group/ for full documentation.
Usage
globalaccelerator_delete_custom_routing_endpoint_group(EndpointGroupArn)
Arguments
EndpointGroupArn |
[required] The Amazon Resource Name (ARN) of the endpoint group to delete. |
Delete a listener for a custom routing accelerator
Description
Delete a listener for a custom routing accelerator.
See https://www.paws-r-sdk.com/docs/globalaccelerator_delete_custom_routing_listener/ for full documentation.
Usage
globalaccelerator_delete_custom_routing_listener(ListenerArn)
Arguments
ListenerArn |
[required] The Amazon Resource Name (ARN) of the listener to delete. |
Delete an endpoint group from a listener
Description
Delete an endpoint group from a listener.
See https://www.paws-r-sdk.com/docs/globalaccelerator_delete_endpoint_group/ for full documentation.
Usage
globalaccelerator_delete_endpoint_group(EndpointGroupArn)
Arguments
EndpointGroupArn |
[required] The Amazon Resource Name (ARN) of the endpoint group to delete. |
Delete a listener from an accelerator
Description
Delete a listener from an accelerator.
See https://www.paws-r-sdk.com/docs/globalaccelerator_delete_listener/ for full documentation.
Usage
globalaccelerator_delete_listener(ListenerArn)
Arguments
ListenerArn |
[required] The Amazon Resource Name (ARN) of the listener. |
Specify the Amazon EC2 instance (destination) IP addresses and ports for a VPC subnet endpoint that cannot receive traffic for a custom routing accelerator
Description
Specify the Amazon EC2 instance (destination) IP addresses and ports for a VPC subnet endpoint that cannot receive traffic for a custom routing accelerator. You can deny traffic to all destinations in the VPC endpoint, or deny traffic to a specified list of destination IP addresses and ports. Note that you cannot specify IP addresses or ports outside of the range that you configured for the endpoint group.
See https://www.paws-r-sdk.com/docs/globalaccelerator_deny_custom_routing_traffic/ for full documentation.
Usage
globalaccelerator_deny_custom_routing_traffic(
EndpointGroupArn,
EndpointId,
DestinationAddresses = NULL,
DestinationPorts = NULL,
DenyAllTrafficToEndpoint = NULL
)
Arguments
EndpointGroupArn |
[required] The Amazon Resource Name (ARN) of the endpoint group. |
EndpointId |
[required] An ID for the endpoint. For custom routing accelerators, this is the virtual private cloud (VPC) subnet ID. |
DestinationAddresses |
A list of specific Amazon EC2 instance IP addresses (destination addresses) in a subnet that you want to prevent from receiving traffic. The IP addresses must be a subset of the IP addresses allowed for the VPC subnet associated with the endpoint group. |
DestinationPorts |
A list of specific Amazon EC2 instance ports (destination ports) in a subnet endpoint that you want to prevent from receiving traffic. |
DenyAllTrafficToEndpoint |
Indicates whether all destination IP addresses and ports for a specified VPC subnet endpoint cannot receive traffic from a custom routing accelerator. The value is TRUE or FALSE. When set to TRUE, no destinations in the custom routing VPC subnet can receive traffic. Note that you cannot specify destination IP addresses and ports when the value is set to TRUE. When set to FALSE (or not specified), you must specify a list of destination IP addresses that cannot receive traffic. A list of ports is optional. If you don't specify a list of ports, the ports that can accept traffic is the same as the ports configured for the endpoint group. The default value is FALSE. |
Releases the specified address range that you provisioned to use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and deletes the corresponding address pool
Description
Releases the specified address range that you provisioned to use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and deletes the corresponding address pool.
See https://www.paws-r-sdk.com/docs/globalaccelerator_deprovision_byoip_cidr/ for full documentation.
Usage
globalaccelerator_deprovision_byoip_cidr(Cidr)
Arguments
Cidr |
[required] The address range, in CIDR notation. The prefix must be the same prefix that you specified when you provisioned the address range. For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide. |
Describe an accelerator
Description
Describe an accelerator.
See https://www.paws-r-sdk.com/docs/globalaccelerator_describe_accelerator/ for full documentation.
Usage
globalaccelerator_describe_accelerator(AcceleratorArn)
Arguments
AcceleratorArn |
[required] The Amazon Resource Name (ARN) of the accelerator to describe. |
Describe the attributes of an accelerator
Description
Describe the attributes of an accelerator.
See https://www.paws-r-sdk.com/docs/globalaccelerator_describe_accelerator_attributes/ for full documentation.
Usage
globalaccelerator_describe_accelerator_attributes(AcceleratorArn)
Arguments
AcceleratorArn |
[required] The Amazon Resource Name (ARN) of the accelerator with the attributes that you want to describe. |
Gets configuration information about a cross-account attachment
Description
Gets configuration information about a cross-account attachment.
See https://www.paws-r-sdk.com/docs/globalaccelerator_describe_cross_account_attachment/ for full documentation.
Usage
globalaccelerator_describe_cross_account_attachment(AttachmentArn)
Arguments
AttachmentArn |
[required] The Amazon Resource Name (ARN) for the cross-account attachment to describe. |
Describe a custom routing accelerator
Description
Describe a custom routing accelerator.
See https://www.paws-r-sdk.com/docs/globalaccelerator_describe_custom_routing_accelerator/ for full documentation.
Usage
globalaccelerator_describe_custom_routing_accelerator(AcceleratorArn)
Arguments
AcceleratorArn |
[required] The Amazon Resource Name (ARN) of the accelerator to describe. |
Describe the attributes of a custom routing accelerator
Description
Describe the attributes of a custom routing accelerator.
See https://www.paws-r-sdk.com/docs/globalaccelerator_describe_custom_routing_accelerator_attributes/ for full documentation.
Usage
globalaccelerator_describe_custom_routing_accelerator_attributes(
AcceleratorArn
)
Arguments
AcceleratorArn |
[required] The Amazon Resource Name (ARN) of the custom routing accelerator to describe the attributes for. |
Describe an endpoint group for a custom routing accelerator
Description
Describe an endpoint group for a custom routing accelerator.
See https://www.paws-r-sdk.com/docs/globalaccelerator_describe_custom_routing_endpoint_group/ for full documentation.
Usage
globalaccelerator_describe_custom_routing_endpoint_group(EndpointGroupArn)
Arguments
EndpointGroupArn |
[required] The Amazon Resource Name (ARN) of the endpoint group to describe. |
The description of a listener for a custom routing accelerator
Description
The description of a listener for a custom routing accelerator.
See https://www.paws-r-sdk.com/docs/globalaccelerator_describe_custom_routing_listener/ for full documentation.
Usage
globalaccelerator_describe_custom_routing_listener(ListenerArn)
Arguments
ListenerArn |
[required] The Amazon Resource Name (ARN) of the listener to describe. |
Describe an endpoint group
Description
Describe an endpoint group.
See https://www.paws-r-sdk.com/docs/globalaccelerator_describe_endpoint_group/ for full documentation.
Usage
globalaccelerator_describe_endpoint_group(EndpointGroupArn)
Arguments
EndpointGroupArn |
[required] The Amazon Resource Name (ARN) of the endpoint group to describe. |
Describe a listener
Description
Describe a listener.
See https://www.paws-r-sdk.com/docs/globalaccelerator_describe_listener/ for full documentation.
Usage
globalaccelerator_describe_listener(ListenerArn)
Arguments
ListenerArn |
[required] The Amazon Resource Name (ARN) of the listener to describe. |
List the accelerators for an Amazon Web Services account
Description
List the accelerators for an Amazon Web Services account.
See https://www.paws-r-sdk.com/docs/globalaccelerator_list_accelerators/ for full documentation.
Usage
globalaccelerator_list_accelerators(MaxResults = NULL, NextToken = NULL)
Arguments
MaxResults |
The number of Global Accelerator objects that you want to return with this call. The default value is 10. |
NextToken |
The token for the next set of results. You receive this token from a previous call. |
Lists the IP address ranges that were specified in calls to ProvisionByoipCidr, including the current state and a history of state changes
Description
Lists the IP address ranges that were specified in calls to provision_byoip_cidr
, including the current state and a history of state changes.
See https://www.paws-r-sdk.com/docs/globalaccelerator_list_byoip_cidrs/ for full documentation.
Usage
globalaccelerator_list_byoip_cidrs(MaxResults = NULL, NextToken = NULL)
Arguments
MaxResults |
The maximum number of results to return with a single call. To retrieve
the remaining results, make another call with the returned |
NextToken |
The token for the next page of results. |
List the cross-account attachments that have been created in Global Accelerator
Description
List the cross-account attachments that have been created in Global Accelerator.
See https://www.paws-r-sdk.com/docs/globalaccelerator_list_cross_account_attachments/ for full documentation.
Usage
globalaccelerator_list_cross_account_attachments(
MaxResults = NULL,
NextToken = NULL
)
Arguments
MaxResults |
The number of cross-account attachment objects that you want to return with this call. The default value is 10. |
NextToken |
The token for the next set of results. You receive this token from a previous call. |
List the accounts that have cross-account resources
Description
List the accounts that have cross-account resources.
See https://www.paws-r-sdk.com/docs/globalaccelerator_list_cross_account_resource_accounts/ for full documentation.
Usage
globalaccelerator_list_cross_account_resource_accounts()
List the cross-account resources available to work with
Description
List the cross-account resources available to work with.
See https://www.paws-r-sdk.com/docs/globalaccelerator_list_cross_account_resources/ for full documentation.
Usage
globalaccelerator_list_cross_account_resources(
AcceleratorArn = NULL,
ResourceOwnerAwsAccountId,
MaxResults = NULL,
NextToken = NULL
)
Arguments
AcceleratorArn |
The Amazon Resource Name (ARN) of an accelerator in a cross-account attachment. |
ResourceOwnerAwsAccountId |
[required] The account ID of a resource owner in a cross-account attachment. |
MaxResults |
The number of cross-account resource objects that you want to return with this call. The default value is 10. |
NextToken |
The token for the next set of results. You receive this token from a previous call. |
List the custom routing accelerators for an Amazon Web Services account
Description
List the custom routing accelerators for an Amazon Web Services account.
See https://www.paws-r-sdk.com/docs/globalaccelerator_list_custom_routing_accelerators/ for full documentation.
Usage
globalaccelerator_list_custom_routing_accelerators(
MaxResults = NULL,
NextToken = NULL
)
Arguments
MaxResults |
The number of custom routing Global Accelerator objects that you want to return with this call. The default value is 10. |
NextToken |
The token for the next set of results. You receive this token from a previous call. |
List the endpoint groups that are associated with a listener for a custom routing accelerator
Description
List the endpoint groups that are associated with a listener for a custom routing accelerator.
See https://www.paws-r-sdk.com/docs/globalaccelerator_list_custom_routing_endpoint_groups/ for full documentation.
Usage
globalaccelerator_list_custom_routing_endpoint_groups(
ListenerArn,
MaxResults = NULL,
NextToken = NULL
)
Arguments
ListenerArn |
[required] The Amazon Resource Name (ARN) of the listener to list endpoint groups for. |
MaxResults |
The number of endpoint group objects that you want to return with this call. The default value is 10. |
NextToken |
The token for the next set of results. You receive this token from a previous call. |
List the listeners for a custom routing accelerator
Description
List the listeners for a custom routing accelerator.
See https://www.paws-r-sdk.com/docs/globalaccelerator_list_custom_routing_listeners/ for full documentation.
Usage
globalaccelerator_list_custom_routing_listeners(
AcceleratorArn,
MaxResults = NULL,
NextToken = NULL
)
Arguments
AcceleratorArn |
[required] The Amazon Resource Name (ARN) of the accelerator to list listeners for. |
MaxResults |
The number of listener objects that you want to return with this call. The default value is 10. |
NextToken |
The token for the next set of results. You receive this token from a previous call. |
Provides a complete mapping from the public accelerator IP address and port to destination EC2 instance IP addresses and ports in the virtual public cloud (VPC) subnet endpoint for a custom routing accelerator
Description
Provides a complete mapping from the public accelerator IP address and port to destination EC2 instance IP addresses and ports in the virtual public cloud (VPC) subnet endpoint for a custom routing accelerator. For each subnet endpoint that you add, Global Accelerator creates a new static port mapping for the accelerator. The port mappings don't change after Global Accelerator generates them, so you can retrieve and cache the full mapping on your servers.
See https://www.paws-r-sdk.com/docs/globalaccelerator_list_custom_routing_port_mappings/ for full documentation.
Usage
globalaccelerator_list_custom_routing_port_mappings(
AcceleratorArn,
EndpointGroupArn = NULL,
MaxResults = NULL,
NextToken = NULL
)
Arguments
AcceleratorArn |
[required] The Amazon Resource Name (ARN) of the accelerator to list the custom routing port mappings for. |
EndpointGroupArn |
The Amazon Resource Name (ARN) of the endpoint group to list the custom routing port mappings for. |
MaxResults |
The number of destination port mappings that you want to return with this call. The default value is 10. |
NextToken |
The token for the next set of results. You receive this token from a previous call. |
List the port mappings for a specific EC2 instance (destination) in a VPC subnet endpoint
Description
List the port mappings for a specific EC2 instance (destination) in a VPC subnet endpoint. The response is the mappings for one destination IP address. This is useful when your subnet endpoint has mappings that span multiple custom routing accelerators in your account, or for scenarios where you only want to list the port mappings for a specific destination instance.
See https://www.paws-r-sdk.com/docs/globalaccelerator_list_custom_routing_port_mappings_by_destination/ for full documentation.
Usage
globalaccelerator_list_custom_routing_port_mappings_by_destination(
EndpointId,
DestinationAddress,
MaxResults = NULL,
NextToken = NULL
)
Arguments
EndpointId |
[required] The ID for the virtual private cloud (VPC) subnet. |
DestinationAddress |
[required] The endpoint IP address in a virtual private cloud (VPC) subnet for which you want to receive back port mappings. |
MaxResults |
The number of destination port mappings that you want to return with this call. The default value is 10. |
NextToken |
The token for the next set of results. You receive this token from a previous call. |
List the endpoint groups that are associated with a listener
Description
List the endpoint groups that are associated with a listener.
See https://www.paws-r-sdk.com/docs/globalaccelerator_list_endpoint_groups/ for full documentation.
Usage
globalaccelerator_list_endpoint_groups(
ListenerArn,
MaxResults = NULL,
NextToken = NULL
)
Arguments
ListenerArn |
[required] The Amazon Resource Name (ARN) of the listener. |
MaxResults |
The number of endpoint group objects that you want to return with this call. The default value is 10. |
NextToken |
The token for the next set of results. You receive this token from a previous call. |
List the listeners for an accelerator
Description
List the listeners for an accelerator.
See https://www.paws-r-sdk.com/docs/globalaccelerator_list_listeners/ for full documentation.
Usage
globalaccelerator_list_listeners(
AcceleratorArn,
MaxResults = NULL,
NextToken = NULL
)
Arguments
AcceleratorArn |
[required] The Amazon Resource Name (ARN) of the accelerator for which you want to list listener objects. |
MaxResults |
The number of listener objects that you want to return with this call. The default value is 10. |
NextToken |
The token for the next set of results. You receive this token from a previous call. |
List all tags for an accelerator
Description
List all tags for an accelerator.
See https://www.paws-r-sdk.com/docs/globalaccelerator_list_tags_for_resource/ for full documentation.
Usage
globalaccelerator_list_tags_for_resource(ResourceArn)
Arguments
ResourceArn |
[required] The Amazon Resource Name (ARN) of the accelerator to list tags for. An ARN uniquely identifies an accelerator. |
Provisions an IP address range to use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and creates a corresponding address pool
Description
Provisions an IP address range to use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and creates a corresponding address pool. After the address range is provisioned, it is ready to be advertised using AdvertiseByoipCidr.
See https://www.paws-r-sdk.com/docs/globalaccelerator_provision_byoip_cidr/ for full documentation.
Usage
globalaccelerator_provision_byoip_cidr(Cidr, CidrAuthorizationContext)
Arguments
Cidr |
[required] The public IPv4 address range, in CIDR notation. The most specific IP prefix that you can specify is /24. The address range cannot overlap with another address range that you've brought to this Amazon Web Services Region or another Region. For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide. |
CidrAuthorizationContext |
[required] A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP. |
Remove endpoints from a custom routing accelerator
Description
Remove endpoints from a custom routing accelerator.
See https://www.paws-r-sdk.com/docs/globalaccelerator_remove_custom_routing_endpoints/ for full documentation.
Usage
globalaccelerator_remove_custom_routing_endpoints(
EndpointIds,
EndpointGroupArn
)
Arguments
EndpointIds |
[required] The IDs for the endpoints. For custom routing accelerators, endpoint IDs are the virtual private cloud (VPC) subnet IDs. |
EndpointGroupArn |
[required] The Amazon Resource Name (ARN) of the endpoint group to remove endpoints from. |
Remove endpoints from an endpoint group
Description
Remove endpoints from an endpoint group.
See https://www.paws-r-sdk.com/docs/globalaccelerator_remove_endpoints/ for full documentation.
Usage
globalaccelerator_remove_endpoints(EndpointIdentifiers, EndpointGroupArn)
Arguments
EndpointIdentifiers |
[required] The identifiers of the endpoints that you want to remove. |
EndpointGroupArn |
[required] The Amazon Resource Name (ARN) of the endpoint group. |
Add tags to an accelerator resource
Description
Add tags to an accelerator resource.
See https://www.paws-r-sdk.com/docs/globalaccelerator_tag_resource/ for full documentation.
Usage
globalaccelerator_tag_resource(ResourceArn, Tags)
Arguments
ResourceArn |
[required] The Amazon Resource Name (ARN) of the Global Accelerator resource to add tags to. An ARN uniquely identifies a resource. |
Tags |
[required] The tags to add to a resource. A tag consists of a key and a value that you define. |
Remove tags from a Global Accelerator resource
Description
Remove tags from a Global Accelerator resource. When you specify a tag key, the action removes both that key and its associated value. The operation succeeds even if you attempt to remove tags from an accelerator that was already removed.
See https://www.paws-r-sdk.com/docs/globalaccelerator_untag_resource/ for full documentation.
Usage
globalaccelerator_untag_resource(ResourceArn, TagKeys)
Arguments
ResourceArn |
[required] The Amazon Resource Name (ARN) of the Global Accelerator resource to remove tags from. An ARN uniquely identifies a resource. |
TagKeys |
[required] The tag key pairs that you want to remove from the specified resources. |
Update an accelerator to make changes, such as the following:
Description
Update an accelerator to make changes, such as the following:
See https://www.paws-r-sdk.com/docs/globalaccelerator_update_accelerator/ for full documentation.
Usage
globalaccelerator_update_accelerator(
AcceleratorArn,
Name = NULL,
IpAddressType = NULL,
IpAddresses = NULL,
Enabled = NULL
)
Arguments
AcceleratorArn |
[required] The Amazon Resource Name (ARN) of the accelerator to update. |
Name |
The name of the accelerator. The name can have a maximum of 64 characters, must contain only alphanumeric characters, periods (.), or hyphens (-), and must not begin or end with a hyphen or period. |
IpAddressType |
The IP address type that an accelerator supports. For a standard accelerator, the value can be IPV4 or DUAL_STACK. |
IpAddresses |
The IP addresses for an accelerator. |
Enabled |
Indicates whether an accelerator is enabled. The value is true or false. The default value is true. If the value is set to true, the accelerator cannot be deleted. If set to false, the accelerator can be deleted. |
Update the attributes for an accelerator
Description
Update the attributes for an accelerator.
See https://www.paws-r-sdk.com/docs/globalaccelerator_update_accelerator_attributes/ for full documentation.
Usage
globalaccelerator_update_accelerator_attributes(
AcceleratorArn,
FlowLogsEnabled = NULL,
FlowLogsS3Bucket = NULL,
FlowLogsS3Prefix = NULL
)
Arguments
AcceleratorArn |
[required] The Amazon Resource Name (ARN) of the accelerator that you want to update. |
FlowLogsEnabled |
Update whether flow logs are enabled. The default value is false. If the
value is true, For more information, see Flow Logs in the Global Accelerator Developer Guide. |
FlowLogsS3Bucket |
The name of the Amazon S3 bucket for the flow logs. Attribute is
required if |
FlowLogsS3Prefix |
Update the prefix for the location in the Amazon S3 bucket for the flow
logs. Attribute is required if If you specify slash (/) for the S3 bucket prefix, the log file bucket folder structure will include a double slash (//), like the following: s3-bucket_name//AWSLogs/aws_account_id |
Update a cross-account attachment to add or remove principals or resources
Description
Update a cross-account attachment to add or remove principals or resources. When you update an attachment to remove a principal (account ID or accelerator) or a resource, Global Accelerator revokes the permission for specific resources.
See https://www.paws-r-sdk.com/docs/globalaccelerator_update_cross_account_attachment/ for full documentation.
Usage
globalaccelerator_update_cross_account_attachment(
AttachmentArn,
Name = NULL,
AddPrincipals = NULL,
RemovePrincipals = NULL,
AddResources = NULL,
RemoveResources = NULL
)
Arguments
AttachmentArn |
[required] The Amazon Resource Name (ARN) of the cross-account attachment to update. |
Name |
The name of the cross-account attachment. |
AddPrincipals |
The principals to add to the cross-account attachment. A principal is an account or the Amazon Resource Name (ARN) of an accelerator that the attachment gives permission to work with resources from another account. The resources are also listed in the attachment. To add more than one principal, separate the account numbers or accelerator ARNs, or both, with commas. |
RemovePrincipals |
The principals to remove from the cross-account attachment. A principal is an account or the Amazon Resource Name (ARN) of an accelerator that the attachment gives permission to work with resources from another account. The resources are also listed in the attachment. To remove more than one principal, separate the account numbers or accelerator ARNs, or both, with commas. |
AddResources |
The resources to add to the cross-account attachment. A resource listed in a cross-account attachment can be used with an accelerator by the principals that are listed in the attachment. To add more than one resource, separate the resource ARNs with commas. |
RemoveResources |
The resources to remove from the cross-account attachment. A resource listed in a cross-account attachment can be used with an accelerator by the principals that are listed in the attachment. To remove more than one resource, separate the resource ARNs with commas. |
Update a custom routing accelerator
Description
Update a custom routing accelerator.
See https://www.paws-r-sdk.com/docs/globalaccelerator_update_custom_routing_accelerator/ for full documentation.
Usage
globalaccelerator_update_custom_routing_accelerator(
AcceleratorArn,
Name = NULL,
IpAddressType = NULL,
IpAddresses = NULL,
Enabled = NULL
)
Arguments
AcceleratorArn |
[required] The Amazon Resource Name (ARN) of the accelerator to update. |
Name |
The name of the accelerator. The name can have a maximum of 64 characters, must contain only alphanumeric characters, periods (.), or hyphens (-), and must not begin or end with a hyphen or period. |
IpAddressType |
The IP address type that an accelerator supports. For a custom routing accelerator, the value must be IPV4. |
IpAddresses |
The IP addresses for an accelerator. |
Enabled |
Indicates whether an accelerator is enabled. The value is true or false. The default value is true. If the value is set to true, the accelerator cannot be deleted. If set to false, the accelerator can be deleted. |
Update the attributes for a custom routing accelerator
Description
Update the attributes for a custom routing accelerator.
See https://www.paws-r-sdk.com/docs/globalaccelerator_update_custom_routing_accelerator_attributes/ for full documentation.
Usage
globalaccelerator_update_custom_routing_accelerator_attributes(
AcceleratorArn,
FlowLogsEnabled = NULL,
FlowLogsS3Bucket = NULL,
FlowLogsS3Prefix = NULL
)
Arguments
AcceleratorArn |
[required] The Amazon Resource Name (ARN) of the custom routing accelerator to update attributes for. |
FlowLogsEnabled |
Update whether flow logs are enabled. The default value is false. If the
value is true, For more information, see Flow logs in the Global Accelerator Developer Guide. |
FlowLogsS3Bucket |
The name of the Amazon S3 bucket for the flow logs. Attribute is
required if |
FlowLogsS3Prefix |
Update the prefix for the location in the Amazon S3 bucket for the flow
logs. Attribute is required if If you don’t specify a prefix, the flow logs are stored in the root of the bucket. If you specify slash (/) for the S3 bucket prefix, the log file bucket folder structure will include a double slash (//), like the following: DOC-EXAMPLE-BUCKET//AWSLogs/aws_account_id |
Update a listener for a custom routing accelerator
Description
Update a listener for a custom routing accelerator.
See https://www.paws-r-sdk.com/docs/globalaccelerator_update_custom_routing_listener/ for full documentation.
Usage
globalaccelerator_update_custom_routing_listener(ListenerArn, PortRanges)
Arguments
ListenerArn |
[required] The Amazon Resource Name (ARN) of the listener to update. |
PortRanges |
[required] The updated port range to support for connections from clients to your accelerator. If you remove ports that are currently being used by a subnet endpoint, the call fails. Separately, you set port ranges for endpoints. For more information, see About endpoints for custom routing accelerators. |
Update an endpoint group
Description
Update an endpoint group. A resource must be valid and active when you add it as an endpoint.
See https://www.paws-r-sdk.com/docs/globalaccelerator_update_endpoint_group/ for full documentation.
Usage
globalaccelerator_update_endpoint_group(
EndpointGroupArn,
EndpointConfigurations = NULL,
TrafficDialPercentage = NULL,
HealthCheckPort = NULL,
HealthCheckProtocol = NULL,
HealthCheckPath = NULL,
HealthCheckIntervalSeconds = NULL,
ThresholdCount = NULL,
PortOverrides = NULL
)
Arguments
EndpointGroupArn |
[required] The Amazon Resource Name (ARN) of the endpoint group. |
EndpointConfigurations |
The list of endpoint objects. A resource must be valid and active when you add it as an endpoint. |
TrafficDialPercentage |
The percentage of traffic to send to an Amazon Web Services Region. Additional traffic is distributed to other endpoint groups for this listener. Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing. The default value is 100. |
HealthCheckPort |
The port that Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default port is the listener port that this endpoint group is associated with. If the listener port is a list of ports, Global Accelerator uses the first port in the list. |
HealthCheckProtocol |
The protocol that Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default value is TCP. |
HealthCheckPath |
If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The default value is slash (/). |
HealthCheckIntervalSeconds |
The time—10 seconds or 30 seconds—between each health check for an endpoint. The default value is 30. |
ThresholdCount |
The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3. |
PortOverrides |
Override specific listener ports used to route traffic to endpoints that are part of this endpoint group. For example, you can create a port override in which the listener receives user traffic on ports 80 and 443, but your accelerator routes that traffic to ports 1080 and 1443, respectively, on the endpoints. For more information, see Overriding listener ports in the Global Accelerator Developer Guide. |
Update a listener
Description
Update a listener.
See https://www.paws-r-sdk.com/docs/globalaccelerator_update_listener/ for full documentation.
Usage
globalaccelerator_update_listener(
ListenerArn,
PortRanges = NULL,
Protocol = NULL,
ClientAffinity = NULL
)
Arguments
ListenerArn |
[required] The Amazon Resource Name (ARN) of the listener to update. |
PortRanges |
The updated list of port ranges for the connections from clients to the accelerator. |
Protocol |
The updated protocol for the connections from clients to the accelerator. |
ClientAffinity |
Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications, regardless of the port and protocol of the client request. Client affinity gives you control over whether to always route each client to the same specific endpoint. Global Accelerator uses a consistent-flow hashing algorithm to choose
the optimal endpoint for a connection. If client affinity is If you want a given client to always be routed to the same endpoint, set
client affinity to The default value is |
Stops advertising an address range that is provisioned as an address pool
Description
Stops advertising an address range that is provisioned as an address pool. You can perform this operation at most once every 10 seconds, even if you specify different address ranges each time.
See https://www.paws-r-sdk.com/docs/globalaccelerator_withdraw_byoip_cidr/ for full documentation.
Usage
globalaccelerator_withdraw_byoip_cidr(Cidr)
Arguments
Cidr |
[required] The address range, in CIDR notation. For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide. |
AWS Network Firewall
Description
This is the API Reference for Network Firewall. This guide is for developers who need detailed information about the Network Firewall API actions, data types, and errors.
The REST API requires you to handle connection details, such as calculating signatures, handling request retries, and error handling. For general information about using the Amazon Web Services REST APIs, see Amazon Web Services APIs.
To view the complete list of Amazon Web Services Regions where Network Firewall is available, see Service endpoints and quotas in the Amazon Web Services General Reference.
To access Network Firewall using the IPv4 REST API endpoint:
https://network-firewall.<region>.amazonaws.com
To access Network Firewall using the Dualstack (IPv4 and IPv6) REST API
endpoint: https://network-firewall.<region>.aws.api
Alternatively, you can use one of the Amazon Web Services SDKs to access an API that's tailored to the programming language or platform that you're using. For more information, see Amazon Web Services SDKs.
For descriptions of Network Firewall features, including and step-by-step instructions on how to use them through the Network Firewall console, see the Network Firewall Developer Guide.
Network Firewall is a stateful, managed, network firewall and intrusion detection and prevention service for Amazon Virtual Private Cloud (Amazon VPC). With Network Firewall, you can filter traffic at the perimeter of your VPC. This includes filtering traffic going to and coming from an internet gateway, NAT gateway, or over VPN or Direct Connect. Network Firewall uses rules that are compatible with Suricata, a free, open source network analysis and threat detection engine. Network Firewall supports Suricata version 7.0.3. For information about Suricata, see the Suricata website and the Suricata User Guide.
You can use Network Firewall to monitor and protect your VPC traffic in a number of ways. The following are just a few examples:
Allow domains or IP addresses for known Amazon Web Services service endpoints, such as Amazon S3, and block all other forms of traffic.
Use custom lists of known bad domains to limit the types of domain names that your applications can access.
Perform deep packet inspection on traffic entering or leaving your VPC.
Use stateful protocol detection to filter protocols like HTTPS, regardless of the port used.
To enable Network Firewall for your VPCs, you perform steps in both Amazon VPC and in Network Firewall. For information about using Amazon VPC, see Amazon VPC User Guide.
To start using Network Firewall, do the following:
(Optional) If you don't already have a VPC that you want to protect, create it in Amazon VPC.
In Amazon VPC, in each Availability Zone where you want to have a firewall endpoint, create a subnet for the sole use of Network Firewall.
In Network Firewall, create stateless and stateful rule groups, to define the components of the network traffic filtering behavior that you want your firewall to have.
In Network Firewall, create a firewall policy that uses your rule groups and specifies additional default traffic filtering behavior.
In Network Firewall, create a firewall and specify your new firewall policy and VPC subnets. Network Firewall creates a firewall endpoint in each subnet that you specify, with the behavior that's defined in the firewall policy.
In Amazon VPC, use ingress routing enhancements to route traffic through the new firewall endpoints.
Usage
networkfirewall(
config = list(),
credentials = list(),
endpoint = NULL,
region = NULL
)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...)
, where svc
is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- networkfirewall( config = list( credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string", close_connection = "logical", timeout = "numeric", s3_force_path_style = "logical", sts_regional_endpoint = "string" ), credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string" )
Operations
associate_firewall_policy | Associates a FirewallPolicy to a Firewall |
associate_subnets | Associates the specified subnets in the Amazon VPC to the firewall |
create_firewall | Creates an Network Firewall Firewall and accompanying FirewallStatus for a VPC |
create_firewall_policy | Creates the firewall policy for the firewall according to the specifications |
create_rule_group | Creates the specified stateless or stateful rule group, which includes the rules for network traffic inspection, a capacity setting, and tags |
create_tls_inspection_configuration | Creates an Network Firewall TLS inspection configuration |
delete_firewall | Deletes the specified Firewall and its FirewallStatus |
delete_firewall_policy | Deletes the specified FirewallPolicy |
delete_resource_policy | Deletes a resource policy that you created in a PutResourcePolicy request |
delete_rule_group | Deletes the specified RuleGroup |
delete_tls_inspection_configuration | Deletes the specified TLSInspectionConfiguration |
describe_firewall | Returns the data objects for the specified firewall |
describe_firewall_policy | Returns the data objects for the specified firewall policy |
describe_logging_configuration | Returns the logging configuration for the specified firewall |
describe_resource_policy | Retrieves a resource policy that you created in a PutResourcePolicy request |
describe_rule_group | Returns the data objects for the specified rule group |
describe_rule_group_metadata | High-level information about a rule group, returned by operations like create and describe |
describe_tls_inspection_configuration | Returns the data objects for the specified TLS inspection configuration |
disassociate_subnets | Removes the specified subnet associations from the firewall |
get_analysis_report_results | The results of a COMPLETED analysis report generated with StartAnalysisReport |
list_analysis_reports | Returns a list of all traffic analysis reports generated within the last 30 days |
list_firewall_policies | Retrieves the metadata for the firewall policies that you have defined |
list_firewalls | Retrieves the metadata for the firewalls that you have defined |
list_rule_groups | Retrieves the metadata for the rule groups that you have defined |
list_tags_for_resource | Retrieves the tags associated with the specified resource |
list_tls_inspection_configurations | Retrieves the metadata for the TLS inspection configurations that you have defined |
put_resource_policy | Creates or updates an IAM policy for your rule group or firewall policy |
start_analysis_report | Generates a traffic analysis report for the timeframe and traffic type you specify |
tag_resource | Adds the specified tags to the specified resource |
untag_resource | Removes the tags with the specified keys from the specified resource |
update_firewall_analysis_settings | Enables specific types of firewall analysis on a specific firewall you define |
update_firewall_delete_protection | Modifies the flag, DeleteProtection, which indicates whether it is possible to delete the firewall |
update_firewall_description | Modifies the description for the specified firewall |
update_firewall_encryption_configuration | A complex type that contains settings for encryption of your firewall resources |
update_firewall_policy | Updates the properties of the specified firewall policy |
update_firewall_policy_change_protection | Modifies the flag, ChangeProtection, which indicates whether it is possible to change the firewall |
update_logging_configuration | Sets the logging configuration for the specified firewall |
update_rule_group | Updates the rule settings for the specified rule group |
update_subnet_change_protection | Update subnet change protection |
update_tls_inspection_configuration | Updates the TLS inspection configuration settings for the specified TLS inspection configuration |
Examples
## Not run:
svc <- networkfirewall()
svc$associate_firewall_policy(
Foo = 123
)
## End(Not run)
Associates a FirewallPolicy to a Firewall
Description
Associates a FirewallPolicy to a Firewall.
See https://www.paws-r-sdk.com/docs/networkfirewall_associate_firewall_policy/ for full documentation.
Usage
networkfirewall_associate_firewall_policy(
UpdateToken = NULL,
FirewallArn = NULL,
FirewallName = NULL,
FirewallPolicyArn
)
Arguments
UpdateToken |
An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request. To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it. To make a conditional change to the firewall, provide the token in your
update request. Network Firewall uses the token to ensure that the
firewall hasn't changed since you last retrieved it. If it has changed,
the operation fails with an |
FirewallArn |
The Amazon Resource Name (ARN) of the firewall. You must specify the ARN or the name, and you can specify both. |
FirewallName |
The descriptive name of the firewall. You can't change the name of a firewall after you create it. You must specify the ARN or the name, and you can specify both. |
FirewallPolicyArn |
[required] The Amazon Resource Name (ARN) of the firewall policy. |
Associates the specified subnets in the Amazon VPC to the firewall
Description
Associates the specified subnets in the Amazon VPC to the firewall. You can specify one subnet for each of the Availability Zones that the VPC spans.
See https://www.paws-r-sdk.com/docs/networkfirewall_associate_subnets/ for full documentation.
Usage
networkfirewall_associate_subnets(
UpdateToken = NULL,
FirewallArn = NULL,
FirewallName = NULL,
SubnetMappings
)
Arguments
UpdateToken |
An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request. To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it. To make a conditional change to the firewall, provide the token in your
update request. Network Firewall uses the token to ensure that the
firewall hasn't changed since you last retrieved it. If it has changed,
the operation fails with an |
FirewallArn |
The Amazon Resource Name (ARN) of the firewall. You must specify the ARN or the name, and you can specify both. |
FirewallName |
The descriptive name of the firewall. You can't change the name of a firewall after you create it. You must specify the ARN or the name, and you can specify both. |
SubnetMappings |
[required] The IDs of the subnets that you want to associate with the firewall. |
Creates an Network Firewall Firewall and accompanying FirewallStatus for a VPC
Description
Creates an Network Firewall Firewall and accompanying FirewallStatus for a VPC.
See https://www.paws-r-sdk.com/docs/networkfirewall_create_firewall/ for full documentation.
Usage
networkfirewall_create_firewall(
FirewallName,
FirewallPolicyArn,
VpcId = NULL,
SubnetMappings = NULL,
DeleteProtection = NULL,
SubnetChangeProtection = NULL,
FirewallPolicyChangeProtection = NULL,
Description = NULL,
Tags = NULL,
EncryptionConfiguration = NULL,
EnabledAnalysisTypes = NULL
)
Arguments
FirewallName |
[required] The descriptive name of the firewall. You can't change the name of a firewall after you create it. |
FirewallPolicyArn |
[required] The Amazon Resource Name (ARN) of the FirewallPolicy that you want to use for the firewall. |
VpcId |
The unique identifier of the VPC where Network Firewall should create the firewall. You can't change this setting after you create the firewall. |
SubnetMappings |
The public subnets to use for your Network Firewall firewalls. Each subnet must belong to a different Availability Zone in the VPC. Network Firewall creates a firewall endpoint in each subnet. |
DeleteProtection |
A flag indicating whether it is possible to delete the firewall. A
setting of |
SubnetChangeProtection |
A setting indicating whether the firewall is protected against changes
to the subnet associations. Use this setting to protect against
accidentally modifying the subnet associations for a firewall that is in
use. When you create a firewall, the operation initializes this setting
to |
FirewallPolicyChangeProtection |
A setting indicating whether the firewall is protected against a change
to the firewall policy association. Use this setting to protect against
accidentally modifying the firewall policy for a firewall that is in
use. When you create a firewall, the operation initializes this setting
to |
Description |
A description of the firewall. |
Tags |
The key:value pairs to associate with the resource. |
EncryptionConfiguration |
A complex type that contains settings for encryption of your firewall resources. |
EnabledAnalysisTypes |
An optional setting indicating the specific traffic analysis types to enable on the firewall. |
Creates the firewall policy for the firewall according to the specifications
Description
Creates the firewall policy for the firewall according to the specifications.
See https://www.paws-r-sdk.com/docs/networkfirewall_create_firewall_policy/ for full documentation.
Usage
networkfirewall_create_firewall_policy(
FirewallPolicyName,
FirewallPolicy,
Description = NULL,
Tags = NULL,
DryRun = NULL,
EncryptionConfiguration = NULL
)
Arguments
FirewallPolicyName |
[required] The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it. |
FirewallPolicy |
[required] The rule groups and policy actions to use in the firewall policy. |
Description |
A description of the firewall policy. |
Tags |
The key:value pairs to associate with the resource. |
DryRun |
Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request. If set to If set to |
EncryptionConfiguration |
A complex type that contains settings for encryption of your firewall policy resources. |
Creates the specified stateless or stateful rule group, which includes the rules for network traffic inspection, a capacity setting, and tags
Description
Creates the specified stateless or stateful rule group, which includes the rules for network traffic inspection, a capacity setting, and tags.
See https://www.paws-r-sdk.com/docs/networkfirewall_create_rule_group/ for full documentation.
Usage
networkfirewall_create_rule_group(
RuleGroupName,
RuleGroup = NULL,
Rules = NULL,
Type,
Description = NULL,
Capacity,
Tags = NULL,
DryRun = NULL,
EncryptionConfiguration = NULL,
SourceMetadata = NULL,
AnalyzeRuleGroup = NULL
)
Arguments
RuleGroupName |
[required] The descriptive name of the rule group. You can't change the name of a rule group after you create it. |
RuleGroup |
An object that defines the rule group rules. You must provide either this rule group setting or a |
Rules |
A string containing stateful rule group rules specifications in Suricata flat format, with one rule per line. Use this to import your existing Suricata compatible rule groups. You must provide either this rules setting or a populated You can provide your rule group specification in Suricata flat format through this setting when you create or update your rule group. The call response returns a RuleGroup object that Network Firewall has populated from your string. |
Type |
[required] Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules. |
Description |
A description of the rule group. |
Capacity |
[required] The maximum operating resources that this rule group can use. Rule group capacity is fixed at creation. When you update a rule group, you are limited to this capacity. When you reference a rule group from a firewall policy, Network Firewall reserves this capacity for the rule group. You can retrieve the capacity that would be required for a rule group
before you create the rule group by calling
You can't change or exceed this capacity when you update the rule group, so leave room for your rule group to grow. Capacity for a stateless rule group For a stateless rule group, the capacity required is the sum of the capacity requirements of the individual rules that you expect to have in the rule group. To calculate the capacity requirement of a single rule, multiply the capacity requirement values of each of the rule's match settings:
A rule with no criteria specified in any of its match settings has a capacity requirement of 1. A rule with protocol setting ["UDP","TCP"], source setting ["10.0.0.0/24","10.0.0.1/24","10.0.0.2/24"], and a single specification or no specification for each of the other match settings has a capacity requirement of 6. Capacity for a stateful rule group For a stateful rule group, the minimum capacity required is the number of individual rules that you expect to have in the rule group. |
Tags |
The key:value pairs to associate with the resource. |
DryRun |
Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request. If set to If set to |
EncryptionConfiguration |
A complex type that contains settings for encryption of your rule group resources. |
SourceMetadata |
A complex type that contains metadata about the rule group that your own rule group is copied from. You can use the metadata to keep track of updates made to the originating rule group. |
AnalyzeRuleGroup |
Indicates whether you want Network Firewall to analyze the stateless
rules in the rule group for rule behavior such as asymmetric routing. If
set to |
Creates an Network Firewall TLS inspection configuration
Description
Creates an Network Firewall TLS inspection configuration. Network Firewall uses TLS inspection configurations to decrypt your firewall's inbound and outbound SSL/TLS traffic. After decryption, Network Firewall inspects the traffic according to your firewall policy's stateful rules, and then re-encrypts it before sending it to its destination. You can enable inspection of your firewall's inbound traffic, outbound traffic, or both. To use TLS inspection with your firewall, you must first import or provision certificates using ACM, create a TLS inspection configuration, add that configuration to a new firewall policy, and then associate that policy with your firewall.
See https://www.paws-r-sdk.com/docs/networkfirewall_create_tls_inspection_configuration/ for full documentation.
Usage
networkfirewall_create_tls_inspection_configuration(
TLSInspectionConfigurationName,
TLSInspectionConfiguration,
Description = NULL,
Tags = NULL,
EncryptionConfiguration = NULL
)
Arguments
TLSInspectionConfigurationName |
[required] The descriptive name of the TLS inspection configuration. You can't change the name of a TLS inspection configuration after you create it. |
TLSInspectionConfiguration |
[required] The object that defines a TLS inspection configuration. This, along with
TLSInspectionConfigurationResponse, define the TLS inspection
configuration. You can retrieve all objects for a TLS inspection
configuration by calling
Network Firewall uses a TLS inspection configuration to decrypt traffic. Network Firewall re-encrypts the traffic before sending it to its destination. To use a TLS inspection configuration, you add it to a new Network Firewall firewall policy, then you apply the firewall policy to a firewall. Network Firewall acts as a proxy service to decrypt and inspect the traffic traveling through your firewalls. You can reference a TLS inspection configuration from more than one firewall policy, and you can use a firewall policy in more than one firewall. For more information about using TLS inspection configurations, see Inspecting SSL/TLS traffic with TLS inspection configurations in the Network Firewall Developer Guide. |
Description |
A description of the TLS inspection configuration. |
Tags |
The key:value pairs to associate with the resource. |
EncryptionConfiguration |
Deletes the specified Firewall and its FirewallStatus
Description
Deletes the specified Firewall and its FirewallStatus. This operation requires the firewall's DeleteProtection
flag to be FALSE
. You can't revert this operation.
See https://www.paws-r-sdk.com/docs/networkfirewall_delete_firewall/ for full documentation.
Usage
networkfirewall_delete_firewall(FirewallName = NULL, FirewallArn = NULL)
Arguments
FirewallName |
The descriptive name of the firewall. You can't change the name of a firewall after you create it. You must specify the ARN or the name, and you can specify both. |
FirewallArn |
The Amazon Resource Name (ARN) of the firewall. You must specify the ARN or the name, and you can specify both. |
Deletes the specified FirewallPolicy
Description
Deletes the specified FirewallPolicy.
See https://www.paws-r-sdk.com/docs/networkfirewall_delete_firewall_policy/ for full documentation.
Usage
networkfirewall_delete_firewall_policy(
FirewallPolicyName = NULL,
FirewallPolicyArn = NULL
)
Arguments
FirewallPolicyName |
The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it. You must specify the ARN or the name, and you can specify both. |
FirewallPolicyArn |
The Amazon Resource Name (ARN) of the firewall policy. You must specify the ARN or the name, and you can specify both. |
Deletes a resource policy that you created in a PutResourcePolicy request
Description
Deletes a resource policy that you created in a put_resource_policy
request.
See https://www.paws-r-sdk.com/docs/networkfirewall_delete_resource_policy/ for full documentation.
Usage
networkfirewall_delete_resource_policy(ResourceArn)
Arguments
ResourceArn |
[required] The Amazon Resource Name (ARN) of the rule group or firewall policy whose resource policy you want to delete. |
Deletes the specified RuleGroup
Description
Deletes the specified RuleGroup.
See https://www.paws-r-sdk.com/docs/networkfirewall_delete_rule_group/ for full documentation.
Usage
networkfirewall_delete_rule_group(
RuleGroupName = NULL,
RuleGroupArn = NULL,
Type = NULL
)
Arguments
RuleGroupName |
The descriptive name of the rule group. You can't change the name of a rule group after you create it. You must specify the ARN or the name, and you can specify both. |
RuleGroupArn |
The Amazon Resource Name (ARN) of the rule group. You must specify the ARN or the name, and you can specify both. |
Type |
Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules. This setting is required for requests that do not include the
|
Deletes the specified TLSInspectionConfiguration
Description
Deletes the specified TLSInspectionConfiguration.
See https://www.paws-r-sdk.com/docs/networkfirewall_delete_tls_inspection_configuration/ for full documentation.
Usage
networkfirewall_delete_tls_inspection_configuration(
TLSInspectionConfigurationArn = NULL,
TLSInspectionConfigurationName = NULL
)
Arguments
TLSInspectionConfigurationArn |
The Amazon Resource Name (ARN) of the TLS inspection configuration. You must specify the ARN or the name, and you can specify both. |
TLSInspectionConfigurationName |
The descriptive name of the TLS inspection configuration. You can't change the name of a TLS inspection configuration after you create it. You must specify the ARN or the name, and you can specify both. |
Returns the data objects for the specified firewall
Description
Returns the data objects for the specified firewall.
See https://www.paws-r-sdk.com/docs/networkfirewall_describe_firewall/ for full documentation.
Usage
networkfirewall_describe_firewall(FirewallName = NULL, FirewallArn = NULL)
Arguments
FirewallName |
The descriptive name of the firewall. You can't change the name of a firewall after you create it. You must specify the ARN or the name, and you can specify both. |
FirewallArn |
The Amazon Resource Name (ARN) of the firewall. You must specify the ARN or the name, and you can specify both. |
Returns the data objects for the specified firewall policy
Description
Returns the data objects for the specified firewall policy.
See https://www.paws-r-sdk.com/docs/networkfirewall_describe_firewall_policy/ for full documentation.
Usage
networkfirewall_describe_firewall_policy(
FirewallPolicyName = NULL,
FirewallPolicyArn = NULL
)
Arguments
FirewallPolicyName |
The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it. You must specify the ARN or the name, and you can specify both. |
FirewallPolicyArn |
The Amazon Resource Name (ARN) of the firewall policy. You must specify the ARN or the name, and you can specify both. |
Returns the logging configuration for the specified firewall
Description
Returns the logging configuration for the specified firewall.
See https://www.paws-r-sdk.com/docs/networkfirewall_describe_logging_configuration/ for full documentation.
Usage
networkfirewall_describe_logging_configuration(
FirewallArn = NULL,
FirewallName = NULL
)
Arguments
FirewallArn |
The Amazon Resource Name (ARN) of the firewall. You must specify the ARN or the name, and you can specify both. |
FirewallName |
The descriptive name of the firewall. You can't change the name of a firewall after you create it. You must specify the ARN or the name, and you can specify both. |
Retrieves a resource policy that you created in a PutResourcePolicy request
Description
Retrieves a resource policy that you created in a put_resource_policy
request.
See https://www.paws-r-sdk.com/docs/networkfirewall_describe_resource_policy/ for full documentation.
Usage
networkfirewall_describe_resource_policy(ResourceArn)
Arguments
ResourceArn |
[required] The Amazon Resource Name (ARN) of the rule group or firewall policy whose resource policy you want to retrieve. |
Returns the data objects for the specified rule group
Description
Returns the data objects for the specified rule group.
See https://www.paws-r-sdk.com/docs/networkfirewall_describe_rule_group/ for full documentation.
Usage
networkfirewall_describe_rule_group(
RuleGroupName = NULL,
RuleGroupArn = NULL,
Type = NULL,
AnalyzeRuleGroup = NULL
)
Arguments
RuleGroupName |
The descriptive name of the rule group. You can't change the name of a rule group after you create it. You must specify the ARN or the name, and you can specify both. |
RuleGroupArn |
The Amazon Resource Name (ARN) of the rule group. You must specify the ARN or the name, and you can specify both. |
Type |
Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules. This setting is required for requests that do not include the
|
AnalyzeRuleGroup |
Indicates whether you want Network Firewall to analyze the stateless
rules in the rule group for rule behavior such as asymmetric routing. If
set to |
High-level information about a rule group, returned by operations like create and describe
Description
High-level information about a rule group, returned by operations like create and describe. You can use the information provided in the metadata to retrieve and manage a rule group. You can retrieve all objects for a rule group by calling describe_rule_group
.
See https://www.paws-r-sdk.com/docs/networkfirewall_describe_rule_group_metadata/ for full documentation.
Usage
networkfirewall_describe_rule_group_metadata(
RuleGroupName = NULL,
RuleGroupArn = NULL,
Type = NULL
)
Arguments
RuleGroupName |
The descriptive name of the rule group. You can't change the name of a rule group after you create it. You must specify the ARN or the name, and you can specify both. |
RuleGroupArn |
The descriptive name of the rule group. You can't change the name of a rule group after you create it. You must specify the ARN or the name, and you can specify both. |
Type |
Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules. This setting is required for requests that do not include the
|
Returns the data objects for the specified TLS inspection configuration
Description
Returns the data objects for the specified TLS inspection configuration.
See https://www.paws-r-sdk.com/docs/networkfirewall_describe_tls_inspection_configuration/ for full documentation.
Usage
networkfirewall_describe_tls_inspection_configuration(
TLSInspectionConfigurationArn = NULL,
TLSInspectionConfigurationName = NULL
)
Arguments
TLSInspectionConfigurationArn |
The Amazon Resource Name (ARN) of the TLS inspection configuration. You must specify the ARN or the name, and you can specify both. |
TLSInspectionConfigurationName |
The descriptive name of the TLS inspection configuration. You can't change the name of a TLS inspection configuration after you create it. You must specify the ARN or the name, and you can specify both. |
Removes the specified subnet associations from the firewall
Description
Removes the specified subnet associations from the firewall. This removes the firewall endpoints from the subnets and removes any network filtering protections that the endpoints were providing.
See https://www.paws-r-sdk.com/docs/networkfirewall_disassociate_subnets/ for full documentation.
Usage
networkfirewall_disassociate_subnets(
UpdateToken = NULL,
FirewallArn = NULL,
FirewallName = NULL,
SubnetIds
)
Arguments
UpdateToken |
An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request. To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it. To make a conditional change to the firewall, provide the token in your
update request. Network Firewall uses the token to ensure that the
firewall hasn't changed since you last retrieved it. If it has changed,
the operation fails with an |
FirewallArn |
The Amazon Resource Name (ARN) of the firewall. You must specify the ARN or the name, and you can specify both. |
FirewallName |
The descriptive name of the firewall. You can't change the name of a firewall after you create it. You must specify the ARN or the name, and you can specify both. |
SubnetIds |
[required] The unique identifiers for the subnets that you want to disassociate. |
The results of a COMPLETED analysis report generated with StartAnalysisReport
Description
The results of a COMPLETED
analysis report generated with start_analysis_report
.
See https://www.paws-r-sdk.com/docs/networkfirewall_get_analysis_report_results/ for full documentation.
Usage
networkfirewall_get_analysis_report_results(
FirewallName = NULL,
AnalysisReportId,
FirewallArn = NULL,
NextToken = NULL,
MaxResults = NULL
)
Arguments
FirewallName |
The descriptive name of the firewall. You can't change the name of a firewall after you create it. You must specify the ARN or the name, and you can specify both. |
AnalysisReportId |
[required] The unique ID of the query that ran when you requested an analysis report. |
FirewallArn |
The Amazon Resource Name (ARN) of the firewall. You must specify the ARN or the name, and you can specify both. |
NextToken |
When you request a list of objects with a |
MaxResults |
The maximum number of objects that you want Network Firewall to return
for this request. If more objects are available, in the response,
Network Firewall provides a |
Returns a list of all traffic analysis reports generated within the last 30 days
Description
Returns a list of all traffic analysis reports generated within the last 30 days.
See https://www.paws-r-sdk.com/docs/networkfirewall_list_analysis_reports/ for full documentation.
Usage
networkfirewall_list_analysis_reports(
FirewallName = NULL,
FirewallArn = NULL,
NextToken = NULL,
MaxResults = NULL
)
Arguments
FirewallName |
The descriptive name of the firewall. You can't change the name of a firewall after you create it. You must specify the ARN or the name, and you can specify both. |
FirewallArn |
The Amazon Resource Name (ARN) of the firewall. You must specify the ARN or the name, and you can specify both. |
NextToken |
When you request a list of objects with a |
MaxResults |
The maximum number of objects that you want Network Firewall to return
for this request. If more objects are available, in the response,
Network Firewall provides a |
Retrieves the metadata for the firewall policies that you have defined
Description
Retrieves the metadata for the firewall policies that you have defined. Depending on your setting for max results and the number of firewall policies, a single call might not return the full list.
See https://www.paws-r-sdk.com/docs/networkfirewall_list_firewall_policies/ for full documentation.
Usage
networkfirewall_list_firewall_policies(NextToken = NULL, MaxResults = NULL)
Arguments
NextToken |
When you request a list of objects with a |
MaxResults |
The maximum number of objects that you want Network Firewall to return
for this request. If more objects are available, in the response,
Network Firewall provides a |
Retrieves the metadata for the firewalls that you have defined
Description
Retrieves the metadata for the firewalls that you have defined. If you provide VPC identifiers in your request, this returns only the firewalls for those VPCs.
See https://www.paws-r-sdk.com/docs/networkfirewall_list_firewalls/ for full documentation.
Usage
networkfirewall_list_firewalls(
NextToken = NULL,
VpcIds = NULL,
MaxResults = NULL
)
Arguments
NextToken |
When you request a list of objects with a |
VpcIds |
The unique identifiers of the VPCs that you want Network Firewall to retrieve the firewalls for. Leave this blank to retrieve all firewalls that you have defined. |
MaxResults |
The maximum number of objects that you want Network Firewall to return
for this request. If more objects are available, in the response,
Network Firewall provides a |
Retrieves the metadata for the rule groups that you have defined
Description
Retrieves the metadata for the rule groups that you have defined. Depending on your setting for max results and the number of rule groups, a single call might not return the full list.
See https://www.paws-r-sdk.com/docs/networkfirewall_list_rule_groups/ for full documentation.
Usage
networkfirewall_list_rule_groups(
NextToken = NULL,
MaxResults = NULL,
Scope = NULL,
ManagedType = NULL,
Type = NULL
)
Arguments
NextToken |
When you request a list of objects with a |
MaxResults |
The maximum number of objects that you want Network Firewall to return
for this request. If more objects are available, in the response,
Network Firewall provides a |
Scope |
The scope of the request. The default setting of |
ManagedType |
Indicates the general category of the Amazon Web Services managed rule group. |
Type |
Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules. |
Retrieves the tags associated with the specified resource
Description
Retrieves the tags associated with the specified resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.
See https://www.paws-r-sdk.com/docs/networkfirewall_list_tags_for_resource/ for full documentation.
Usage
networkfirewall_list_tags_for_resource(
NextToken = NULL,
MaxResults = NULL,
ResourceArn
)
Arguments
NextToken |
When you request a list of objects with a |
MaxResults |
The maximum number of objects that you want Network Firewall to return
for this request. If more objects are available, in the response,
Network Firewall provides a |
ResourceArn |
[required] The Amazon Resource Name (ARN) of the resource. |
Retrieves the metadata for the TLS inspection configurations that you have defined
Description
Retrieves the metadata for the TLS inspection configurations that you have defined. Depending on your setting for max results and the number of TLS inspection configurations, a single call might not return the full list.
See https://www.paws-r-sdk.com/docs/networkfirewall_list_tls_inspection_configurations/ for full documentation.
Usage
networkfirewall_list_tls_inspection_configurations(
NextToken = NULL,
MaxResults = NULL
)
Arguments
NextToken |
When you request a list of objects with a |
MaxResults |
The maximum number of objects that you want Network Firewall to return
for this request. If more objects are available, in the response,
Network Firewall provides a |
Creates or updates an IAM policy for your rule group or firewall policy
Description
Creates or updates an IAM policy for your rule group or firewall policy. Use this to share rule groups and firewall policies between accounts. This operation works in conjunction with the Amazon Web Services Resource Access Manager (RAM) service to manage resource sharing for Network Firewall.
See https://www.paws-r-sdk.com/docs/networkfirewall_put_resource_policy/ for full documentation.
Usage
networkfirewall_put_resource_policy(ResourceArn, Policy)
Arguments
ResourceArn |
[required] The Amazon Resource Name (ARN) of the account that you want to share rule groups and firewall policies with. |
Policy |
[required] The IAM policy statement that lists the accounts that you want to share your rule group or firewall policy with and the operations that you want the accounts to be able to perform. For a rule group resource, you can specify the following operations in the Actions section of the statement:
For a firewall policy resource, you can specify the following operations in the Actions section of the statement:
In the Resource section of the statement, you specify the ARNs for the
rule groups and firewall policies that you want to share with the
account that you specified in |
Generates a traffic analysis report for the timeframe and traffic type you specify
Description
Generates a traffic analysis report for the timeframe and traffic type you specify.
See https://www.paws-r-sdk.com/docs/networkfirewall_start_analysis_report/ for full documentation.
Usage
networkfirewall_start_analysis_report(
FirewallName = NULL,
FirewallArn = NULL,
AnalysisType
)
Arguments
FirewallName |
The descriptive name of the firewall. You can't change the name of a firewall after you create it. You must specify the ARN or the name, and you can specify both. |
FirewallArn |
The Amazon Resource Name (ARN) of the firewall. You must specify the ARN or the name, and you can specify both. |
AnalysisType |
[required] The type of traffic that will be used to generate a report. |
Adds the specified tags to the specified resource
Description
Adds the specified tags to the specified resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.
See https://www.paws-r-sdk.com/docs/networkfirewall_tag_resource/ for full documentation.
Usage
networkfirewall_tag_resource(ResourceArn, Tags)
Arguments
ResourceArn |
[required] The Amazon Resource Name (ARN) of the resource. |
Tags |
[required] |
Removes the tags with the specified keys from the specified resource
Description
Removes the tags with the specified keys from the specified resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.
See https://www.paws-r-sdk.com/docs/networkfirewall_untag_resource/ for full documentation.
Usage
networkfirewall_untag_resource(ResourceArn, TagKeys)
Arguments
ResourceArn |
[required] The Amazon Resource Name (ARN) of the resource. |
TagKeys |
[required] |
Enables specific types of firewall analysis on a specific firewall you define
Description
Enables specific types of firewall analysis on a specific firewall you define.
See https://www.paws-r-sdk.com/docs/networkfirewall_update_firewall_analysis_settings/ for full documentation.
Usage
networkfirewall_update_firewall_analysis_settings(
EnabledAnalysisTypes = NULL,
FirewallArn = NULL,
FirewallName = NULL,
UpdateToken = NULL
)
Arguments
EnabledAnalysisTypes |
An optional setting indicating the specific traffic analysis types to enable on the firewall. |
FirewallArn |
The Amazon Resource Name (ARN) of the firewall. You must specify the ARN or the name, and you can specify both. |
FirewallName |
The descriptive name of the firewall. You can't change the name of a firewall after you create it. You must specify the ARN or the name, and you can specify both. |
UpdateToken |
An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request. To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it. To make a conditional change to the firewall, provide the token in your
update request. Network Firewall uses the token to ensure that the
firewall hasn't changed since you last retrieved it. If it has changed,
the operation fails with an |
Modifies the flag, DeleteProtection, which indicates whether it is possible to delete the firewall
Description
Modifies the flag, DeleteProtection
, which indicates whether it is possible to delete the firewall. If the flag is set to TRUE
, the firewall is protected against deletion. This setting helps protect against accidentally deleting a firewall that's in use.
See https://www.paws-r-sdk.com/docs/networkfirewall_update_firewall_delete_protection/ for full documentation.
Usage
networkfirewall_update_firewall_delete_protection(
UpdateToken = NULL,
FirewallArn = NULL,
FirewallName = NULL,
DeleteProtection
)
Arguments
UpdateToken |
An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request. To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it. To make a conditional change to the firewall, provide the token in your
update request. Network Firewall uses the token to ensure that the
firewall hasn't changed since you last retrieved it. If it has changed,
the operation fails with an |
FirewallArn |
The Amazon Resource Name (ARN) of the firewall. You must specify the ARN or the name, and you can specify both. |
FirewallName |
The descriptive name of the firewall. You can't change the name of a firewall after you create it. You must specify the ARN or the name, and you can specify both. |
DeleteProtection |
[required] A flag indicating whether it is possible to delete the firewall. A
setting of |
Modifies the description for the specified firewall
Description
Modifies the description for the specified firewall. Use the description to help you identify the firewall when you're working with it.
See https://www.paws-r-sdk.com/docs/networkfirewall_update_firewall_description/ for full documentation.
Usage
networkfirewall_update_firewall_description(
UpdateToken = NULL,
FirewallArn = NULL,
FirewallName = NULL,
Description = NULL
)
Arguments
UpdateToken |
An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request. To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it. To make a conditional change to the firewall, provide the token in your
update request. Network Firewall uses the token to ensure that the
firewall hasn't changed since you last retrieved it. If it has changed,
the operation fails with an |
FirewallArn |
The Amazon Resource Name (ARN) of the firewall. You must specify the ARN or the name, and you can specify both. |
FirewallName |
The descriptive name of the firewall. You can't change the name of a firewall after you create it. You must specify the ARN or the name, and you can specify both. |
Description |
The new description for the firewall. If you omit this setting, Network Firewall removes the description for the firewall. |
A complex type that contains settings for encryption of your firewall resources
Description
A complex type that contains settings for encryption of your firewall resources.
See https://www.paws-r-sdk.com/docs/networkfirewall_update_firewall_encryption_configuration/ for full documentation.
Usage
networkfirewall_update_firewall_encryption_configuration(
UpdateToken = NULL,
FirewallArn = NULL,
FirewallName = NULL,
EncryptionConfiguration = NULL
)
Arguments
UpdateToken |
An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request. To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it. To make a conditional change to the firewall, provide the token in your
update request. Network Firewall uses the token to ensure that the
firewall hasn't changed since you last retrieved it. If it has changed,
the operation fails with an |
FirewallArn |
The Amazon Resource Name (ARN) of the firewall. |
FirewallName |
The descriptive name of the firewall. You can't change the name of a firewall after you create it. |
EncryptionConfiguration |
Updates the properties of the specified firewall policy
Description
Updates the properties of the specified firewall policy.
See https://www.paws-r-sdk.com/docs/networkfirewall_update_firewall_policy/ for full documentation.
Usage
networkfirewall_update_firewall_policy(
UpdateToken,
FirewallPolicyArn = NULL,
FirewallPolicyName = NULL,
FirewallPolicy,
Description = NULL,
DryRun = NULL,
EncryptionConfiguration = NULL
)
Arguments
UpdateToken |
[required] A token used for optimistic locking. Network Firewall returns a token to your requests that access the firewall policy. The token marks the state of the policy resource at the time of the request. To make changes to the policy, you provide the token in your request.
Network Firewall uses the token to ensure that the policy hasn't changed
since you last retrieved it. If it has changed, the operation fails with
an |
FirewallPolicyArn |
The Amazon Resource Name (ARN) of the firewall policy. You must specify the ARN or the name, and you can specify both. |
FirewallPolicyName |
The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it. You must specify the ARN or the name, and you can specify both. |
FirewallPolicy |
[required] The updated firewall policy to use for the firewall. You can't add or
remove a TLSInspectionConfiguration after you create a firewall policy.
However, you can replace an existing TLS inspection configuration with
another |
Description |
A description of the firewall policy. |
DryRun |
Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request. If set to If set to |
EncryptionConfiguration |
A complex type that contains settings for encryption of your firewall policy resources. |
Modifies the flag, ChangeProtection, which indicates whether it is possible to change the firewall
Description
Modifies the flag, ChangeProtection
, which indicates whether it is possible to change the firewall. If the flag is set to TRUE
, the firewall is protected from changes. This setting helps protect against accidentally changing a firewall that's in use.
See https://www.paws-r-sdk.com/docs/networkfirewall_update_firewall_policy_change_protection/ for full documentation.
Usage
networkfirewall_update_firewall_policy_change_protection(
UpdateToken = NULL,
FirewallArn = NULL,
FirewallName = NULL,
FirewallPolicyChangeProtection
)
Arguments
UpdateToken |
An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request. To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it. To make a conditional change to the firewall, provide the token in your
update request. Network Firewall uses the token to ensure that the
firewall hasn't changed since you last retrieved it. If it has changed,
the operation fails with an |
FirewallArn |
The Amazon Resource Name (ARN) of the firewall. You must specify the ARN or the name, and you can specify both. |
FirewallName |
The descriptive name of the firewall. You can't change the name of a firewall after you create it. You must specify the ARN or the name, and you can specify both. |
FirewallPolicyChangeProtection |
[required] A setting indicating whether the firewall is protected against a change
to the firewall policy association. Use this setting to protect against
accidentally modifying the firewall policy for a firewall that is in
use. When you create a firewall, the operation initializes this setting
to |
Sets the logging configuration for the specified firewall
Description
Sets the logging configuration for the specified firewall.
See https://www.paws-r-sdk.com/docs/networkfirewall_update_logging_configuration/ for full documentation.
Usage
networkfirewall_update_logging_configuration(
FirewallArn = NULL,
FirewallName = NULL,
LoggingConfiguration = NULL
)
Arguments
FirewallArn |
The Amazon Resource Name (ARN) of the firewall. You must specify the ARN or the name, and you can specify both. |
FirewallName |
The descriptive name of the firewall. You can't change the name of a firewall after you create it. You must specify the ARN or the name, and you can specify both. |
LoggingConfiguration |
Defines how Network Firewall performs logging for a firewall. If you omit this setting, Network Firewall disables logging for the firewall. |
Updates the rule settings for the specified rule group
Description
Updates the rule settings for the specified rule group. You use a rule group by reference in one or more firewall policies. When you modify a rule group, you modify all firewall policies that use the rule group.
See https://www.paws-r-sdk.com/docs/networkfirewall_update_rule_group/ for full documentation.
Usage
networkfirewall_update_rule_group(
UpdateToken,
RuleGroupArn = NULL,
RuleGroupName = NULL,
RuleGroup = NULL,
Rules = NULL,
Type = NULL,
Description = NULL,
DryRun = NULL,
EncryptionConfiguration = NULL,
SourceMetadata = NULL,
AnalyzeRuleGroup = NULL
)
Arguments
UpdateToken |
[required] A token used for optimistic locking. Network Firewall returns a token to your requests that access the rule group. The token marks the state of the rule group resource at the time of the request. To make changes to the rule group, you provide the token in your
request. Network Firewall uses the token to ensure that the rule group
hasn't changed since you last retrieved it. If it has changed, the
operation fails with an |
RuleGroupArn |
The Amazon Resource Name (ARN) of the rule group. You must specify the ARN or the name, and you can specify both. |
RuleGroupName |
The descriptive name of the rule group. You can't change the name of a rule group after you create it. You must specify the ARN or the name, and you can specify both. |
RuleGroup |
An object that defines the rule group rules. You must provide either this rule group setting or a |
Rules |
A string containing stateful rule group rules specifications in Suricata flat format, with one rule per line. Use this to import your existing Suricata compatible rule groups. You must provide either this rules setting or a populated You can provide your rule group specification in Suricata flat format through this setting when you create or update your rule group. The call response returns a RuleGroup object that Network Firewall has populated from your string. |
Type |
Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules. This setting is required for requests that do not include the
|
Description |
A description of the rule group. |
DryRun |
Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request. If set to If set to |
EncryptionConfiguration |
A complex type that contains settings for encryption of your rule group resources. |
SourceMetadata |
A complex type that contains metadata about the rule group that your own rule group is copied from. You can use the metadata to keep track of updates made to the originating rule group. |
AnalyzeRuleGroup |
Indicates whether you want Network Firewall to analyze the stateless
rules in the rule group for rule behavior such as asymmetric routing. If
set to |
Update subnet change protection
Description
Update subnet change protection
See https://www.paws-r-sdk.com/docs/networkfirewall_update_subnet_change_protection/ for full documentation.
Usage
networkfirewall_update_subnet_change_protection(
UpdateToken = NULL,
FirewallArn = NULL,
FirewallName = NULL,
SubnetChangeProtection
)
Arguments
UpdateToken |
An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request. To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it. To make a conditional change to the firewall, provide the token in your
update request. Network Firewall uses the token to ensure that the
firewall hasn't changed since you last retrieved it. If it has changed,
the operation fails with an |
FirewallArn |
The Amazon Resource Name (ARN) of the firewall. You must specify the ARN or the name, and you can specify both. |
FirewallName |
The descriptive name of the firewall. You can't change the name of a firewall after you create it. You must specify the ARN or the name, and you can specify both. |
SubnetChangeProtection |
[required] A setting indicating whether the firewall is protected against changes
to the subnet associations. Use this setting to protect against
accidentally modifying the subnet associations for a firewall that is in
use. When you create a firewall, the operation initializes this setting
to |
Updates the TLS inspection configuration settings for the specified TLS inspection configuration
Description
Updates the TLS inspection configuration settings for the specified TLS inspection configuration. You use a TLS inspection configuration by referencing it in one or more firewall policies. When you modify a TLS inspection configuration, you modify all firewall policies that use the TLS inspection configuration.
See https://www.paws-r-sdk.com/docs/networkfirewall_update_tls_inspection_configuration/ for full documentation.
Usage
networkfirewall_update_tls_inspection_configuration(
TLSInspectionConfigurationArn = NULL,
TLSInspectionConfigurationName = NULL,
TLSInspectionConfiguration,
Description = NULL,
EncryptionConfiguration = NULL,
UpdateToken
)
Arguments
TLSInspectionConfigurationArn |
The Amazon Resource Name (ARN) of the TLS inspection configuration. |
TLSInspectionConfigurationName |
The descriptive name of the TLS inspection configuration. You can't change the name of a TLS inspection configuration after you create it. |
TLSInspectionConfiguration |
[required] The object that defines a TLS inspection configuration. This, along with
TLSInspectionConfigurationResponse, define the TLS inspection
configuration. You can retrieve all objects for a TLS inspection
configuration by calling
Network Firewall uses a TLS inspection configuration to decrypt traffic. Network Firewall re-encrypts the traffic before sending it to its destination. To use a TLS inspection configuration, you add it to a new Network Firewall firewall policy, then you apply the firewall policy to a firewall. Network Firewall acts as a proxy service to decrypt and inspect the traffic traveling through your firewalls. You can reference a TLS inspection configuration from more than one firewall policy, and you can use a firewall policy in more than one firewall. For more information about using TLS inspection configurations, see Inspecting SSL/TLS traffic with TLS inspection configurations in the Network Firewall Developer Guide. |
Description |
A description of the TLS inspection configuration. |
EncryptionConfiguration |
A complex type that contains the Amazon Web Services KMS encryption configuration settings for your TLS inspection configuration. |
UpdateToken |
[required] A token used for optimistic locking. Network Firewall returns a token to your requests that access the TLS inspection configuration. The token marks the state of the TLS inspection configuration resource at the time of the request. To make changes to the TLS inspection configuration, you provide the
token in your request. Network Firewall uses the token to ensure that
the TLS inspection configuration hasn't changed since you last retrieved
it. If it has changed, the operation fails with an
|
AWS Network Manager
Description
Amazon Web Services enables you to centrally manage your Amazon Web Services Cloud WAN core network and your Transit Gateway network across Amazon Web Services accounts, Regions, and on-premises locations.
Usage
networkmanager(
config = list(),
credentials = list(),
endpoint = NULL,
region = NULL
)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...)
, where svc
is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- networkmanager( config = list( credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string", close_connection = "logical", timeout = "numeric", s3_force_path_style = "logical", sts_regional_endpoint = "string" ), credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string" )
Operations
accept_attachment | Accepts a core network attachment request |
associate_connect_peer | Associates a core network Connect peer with a device and optionally, with a link |
associate_customer_gateway | Associates a customer gateway with a device and optionally, with a link |
associate_link | Associates a link to a device |
associate_transit_gateway_connect_peer | Associates a transit gateway Connect peer with a device, and optionally, with a link |
create_connect_attachment | Creates a core network Connect attachment from a specified core network attachment |
create_connection | Creates a connection between two devices |
create_connect_peer | Creates a core network Connect peer for a specified core network connect attachment between a core network and an appliance |
create_core_network | Creates a core network as part of your global network, and optionally, with a core network policy |
create_device | Creates a new device in a global network |
create_direct_connect_gateway_attachment | Creates an Amazon Web Services Direct Connect gateway attachment |
create_global_network | Creates a new, empty global network |
create_link | Creates a new link for a specified site |
create_site | Creates a new site in a global network |
create_site_to_site_vpn_attachment | Creates an Amazon Web Services site-to-site VPN attachment on an edge location of a core network |
create_transit_gateway_peering | Creates a transit gateway peering connection |
create_transit_gateway_route_table_attachment | Creates a transit gateway route table attachment |
create_vpc_attachment | Creates a VPC attachment on an edge location of a core network |
delete_attachment | Deletes an attachment |
delete_connection | Deletes the specified connection in your global network |
delete_connect_peer | Deletes a Connect peer |
delete_core_network | Deletes a core network along with all core network policies |
delete_core_network_policy_version | Deletes a policy version from a core network |
delete_device | Deletes an existing device |
delete_global_network | Deletes an existing global network |
delete_link | Deletes an existing link |
delete_peering | Deletes an existing peering connection |
delete_resource_policy | Deletes a resource policy for the specified resource |
delete_site | Deletes an existing site |
deregister_transit_gateway | Deregisters a transit gateway from your global network |
describe_global_networks | Describes one or more global networks |
disassociate_connect_peer | Disassociates a core network Connect peer from a device and a link |
disassociate_customer_gateway | Disassociates a customer gateway from a device and a link |
disassociate_link | Disassociates an existing device from a link |
disassociate_transit_gateway_connect_peer | Disassociates a transit gateway Connect peer from a device and link |
execute_core_network_change_set | Executes a change set on your core network |
get_connect_attachment | Returns information about a core network Connect attachment |
get_connections | Gets information about one or more of your connections in a global network |
get_connect_peer | Returns information about a core network Connect peer |
get_connect_peer_associations | Returns information about a core network Connect peer associations |
get_core_network | Returns information about the LIVE policy for a core network |
get_core_network_change_events | Returns information about a core network change event |
get_core_network_change_set | Returns a change set between the LIVE core network policy and a submitted policy |
get_core_network_policy | Returns details about a core network policy |
get_customer_gateway_associations | Gets the association information for customer gateways that are associated with devices and links in your global network |
get_devices | Gets information about one or more of your devices in a global network |
get_direct_connect_gateway_attachment | Returns information about a specific Amazon Web Services Direct Connect gateway attachment |
get_link_associations | Gets the link associations for a device or a link |
get_links | Gets information about one or more links in a specified global network |
get_network_resource_counts | Gets the count of network resources, by resource type, for the specified global network |
get_network_resource_relationships | Gets the network resource relationships for the specified global network |
get_network_resources | Describes the network resources for the specified global network |
get_network_routes | Gets the network routes of the specified global network |
get_network_telemetry | Gets the network telemetry of the specified global network |
get_resource_policy | Returns information about a resource policy |
get_route_analysis | Gets information about the specified route analysis |
get_sites | Gets information about one or more of your sites in a global network |
get_site_to_site_vpn_attachment | Returns information about a site-to-site VPN attachment |
get_transit_gateway_connect_peer_associations | Gets information about one or more of your transit gateway Connect peer associations in a global network |
get_transit_gateway_peering | Returns information about a transit gateway peer |
get_transit_gateway_registrations | Gets information about the transit gateway registrations in a specified global network |
get_transit_gateway_route_table_attachment | Returns information about a transit gateway route table attachment |
get_vpc_attachment | Returns information about a VPC attachment |
list_attachments | Returns a list of core network attachments |
list_connect_peers | Returns a list of core network Connect peers |
list_core_network_policy_versions | Returns a list of core network policy versions |
list_core_networks | Returns a list of owned and shared core networks |
list_organization_service_access_status | Gets the status of the Service Linked Role (SLR) deployment for the accounts in a given Amazon Web Services Organization |
list_peerings | Lists the peerings for a core network |
list_tags_for_resource | Lists the tags for a specified resource |
put_core_network_policy | Creates a new, immutable version of a core network policy |
put_resource_policy | Creates or updates a resource policy |
register_transit_gateway | Registers a transit gateway in your global network |
reject_attachment | Rejects a core network attachment request |
restore_core_network_policy_version | Restores a previous policy version as a new, immutable version of a core network policy |
start_organization_service_access_update | Enables the Network Manager service for an Amazon Web Services Organization |
start_route_analysis | Starts analyzing the routing path between the specified source and destination |
tag_resource | Tags a specified resource |
untag_resource | Removes tags from a specified resource |
update_connection | Updates the information for an existing connection |
update_core_network | Updates the description of a core network |
update_device | Updates the details for an existing device |
update_direct_connect_gateway_attachment | Updates the edge locations associated with an Amazon Web Services Direct Connect gateway attachment |
update_global_network | Updates an existing global network |
update_link | Updates the details for an existing link |
update_network_resource_metadata | Updates the resource metadata for the specified global network |
update_site | Updates the information for an existing site |
update_vpc_attachment | Updates a VPC attachment |
Examples
## Not run:
svc <- networkmanager()
svc$accept_attachment(
Foo = 123
)
## End(Not run)
Accepts a core network attachment request
Description
Accepts a core network attachment request.
See https://www.paws-r-sdk.com/docs/networkmanager_accept_attachment/ for full documentation.
Usage
networkmanager_accept_attachment(AttachmentId)
Arguments
AttachmentId |
[required] The ID of the attachment. |
Associates a core network Connect peer with a device and optionally, with a link
Description
Associates a core network Connect peer with a device and optionally, with a link.
See https://www.paws-r-sdk.com/docs/networkmanager_associate_connect_peer/ for full documentation.
Usage
networkmanager_associate_connect_peer(
GlobalNetworkId,
ConnectPeerId,
DeviceId,
LinkId = NULL
)
Arguments
GlobalNetworkId |
[required] The ID of your global network. |
ConnectPeerId |
[required] The ID of the Connect peer. |
DeviceId |
[required] The ID of the device. |
LinkId |
The ID of the link. |
Associates a customer gateway with a device and optionally, with a link
Description
Associates a customer gateway with a device and optionally, with a link. If you specify a link, it must be associated with the specified device.
See https://www.paws-r-sdk.com/docs/networkmanager_associate_customer_gateway/ for full documentation.
Usage
networkmanager_associate_customer_gateway(
CustomerGatewayArn,
GlobalNetworkId,
DeviceId,
LinkId = NULL
)
Arguments
CustomerGatewayArn |
[required] The Amazon Resource Name (ARN) of the customer gateway. |
GlobalNetworkId |
[required] The ID of the global network. |
DeviceId |
[required] The ID of the device. |
LinkId |
The ID of the link. |
Associates a link to a device
Description
Associates a link to a device. A device can be associated to multiple links and a link can be associated to multiple devices. The device and link must be in the same global network and the same site.
See https://www.paws-r-sdk.com/docs/networkmanager_associate_link/ for full documentation.
Usage
networkmanager_associate_link(GlobalNetworkId, DeviceId, LinkId)
Arguments
GlobalNetworkId |
[required] The ID of the global network. |
DeviceId |
[required] The ID of the device. |
LinkId |
[required] The ID of the link. |
Associates a transit gateway Connect peer with a device, and optionally, with a link
Description
Associates a transit gateway Connect peer with a device, and optionally, with a link. If you specify a link, it must be associated with the specified device.
See https://www.paws-r-sdk.com/docs/networkmanager_associate_transit_gateway_connect_peer/ for full documentation.
Usage
networkmanager_associate_transit_gateway_connect_peer(
GlobalNetworkId,
TransitGatewayConnectPeerArn,
DeviceId,
LinkId = NULL
)
Arguments
GlobalNetworkId |
[required] The ID of the global network. |
TransitGatewayConnectPeerArn |
[required] The Amazon Resource Name (ARN) of the Connect peer. |
DeviceId |
[required] The ID of the device. |
LinkId |
The ID of the link. |
Creates a core network Connect attachment from a specified core network attachment
Description
Creates a core network Connect attachment from a specified core network attachment.
See https://www.paws-r-sdk.com/docs/networkmanager_create_connect_attachment/ for full documentation.
Usage
networkmanager_create_connect_attachment(
CoreNetworkId,
EdgeLocation,
TransportAttachmentId,
Options,
Tags = NULL,
ClientToken = NULL
)
Arguments
CoreNetworkId |
[required] The ID of a core network where you want to create the attachment. |
EdgeLocation |
[required] The Region where the edge is located. |
TransportAttachmentId |
[required] The ID of the attachment between the two connections. |
Options |
[required] Options for creating an attachment. |
Tags |
The list of key-value tags associated with the request. |
ClientToken |
The client token associated with the request. |
Creates a core network Connect peer for a specified core network connect attachment between a core network and an appliance
Description
Creates a core network Connect peer for a specified core network connect attachment between a core network and an appliance. The peer address and transit gateway address must be the same IP address family (IPv4 or IPv6).
See https://www.paws-r-sdk.com/docs/networkmanager_create_connect_peer/ for full documentation.
Usage
networkmanager_create_connect_peer(
ConnectAttachmentId,
CoreNetworkAddress = NULL,
PeerAddress,
BgpOptions = NULL,
InsideCidrBlocks = NULL,
Tags = NULL,
ClientToken = NULL,
SubnetArn = NULL
)
Arguments
ConnectAttachmentId |
[required] The ID of the connection attachment. |
CoreNetworkAddress |
A Connect peer core network address. This only applies only when the
protocol is |
PeerAddress |
[required] The Connect peer address. |
BgpOptions |
The Connect peer BGP options. This only applies only when the protocol
is |
InsideCidrBlocks |
The inside IP addresses used for BGP peering. |
Tags |
The tags associated with the peer request. |
ClientToken |
The client token associated with the request. |
SubnetArn |
The subnet ARN for the Connect peer. This only applies only when the protocol is NO_ENCAP. |
Creates a connection between two devices
Description
Creates a connection between two devices. The devices can be a physical or virtual appliance that connects to a third-party appliance in a VPC, or a physical appliance that connects to another physical appliance in an on-premises network.
See https://www.paws-r-sdk.com/docs/networkmanager_create_connection/ for full documentation.
Usage
networkmanager_create_connection(
GlobalNetworkId,
DeviceId,
ConnectedDeviceId,
LinkId = NULL,
ConnectedLinkId = NULL,
Description = NULL,
Tags = NULL
)
Arguments
GlobalNetworkId |
[required] The ID of the global network. |
DeviceId |
[required] The ID of the first device in the connection. |
ConnectedDeviceId |
[required] The ID of the second device in the connection. |
LinkId |
The ID of the link for the first device. |
ConnectedLinkId |
The ID of the link for the second device. |
Description |
A description of the connection. Length Constraints: Maximum length of 256 characters. |
Tags |
The tags to apply to the resource during creation. |
Creates a core network as part of your global network, and optionally, with a core network policy
Description
Creates a core network as part of your global network, and optionally, with a core network policy.
See https://www.paws-r-sdk.com/docs/networkmanager_create_core_network/ for full documentation.
Usage
networkmanager_create_core_network(
GlobalNetworkId,
Description = NULL,
Tags = NULL,
PolicyDocument = NULL,
ClientToken = NULL
)
Arguments
GlobalNetworkId |
[required] The ID of the global network that a core network will be a part of. |
Description |
The description of a core network. |
Tags |
Key-value tags associated with a core network request. |
PolicyDocument |
The policy document for creating a core network. |
ClientToken |
The client token associated with a core network request. |
Creates a new device in a global network
Description
Creates a new device in a global network. If you specify both a site ID and a location, the location of the site is used for visualization in the Network Manager console.
See https://www.paws-r-sdk.com/docs/networkmanager_create_device/ for full documentation.
Usage
networkmanager_create_device(
GlobalNetworkId,
AWSLocation = NULL,
Description = NULL,
Type = NULL,
Vendor = NULL,
Model = NULL,
SerialNumber = NULL,
Location = NULL,
SiteId = NULL,
Tags = NULL
)
Arguments
GlobalNetworkId |
[required] The ID of the global network. |
AWSLocation |
The Amazon Web Services location of the device, if applicable. For an on-premises device, you can omit this parameter. |
Description |
A description of the device. Constraints: Maximum length of 256 characters. |
Type |
The type of the device. |
Vendor |
The vendor of the device. Constraints: Maximum length of 128 characters. |
Model |
The model of the device. Constraints: Maximum length of 128 characters. |
SerialNumber |
The serial number of the device. Constraints: Maximum length of 128 characters. |
Location |
The location of the device. |
SiteId |
The ID of the site. |
Tags |
The tags to apply to the resource during creation. |
Creates an Amazon Web Services Direct Connect gateway attachment
Description
Creates an Amazon Web Services Direct Connect gateway attachment
See https://www.paws-r-sdk.com/docs/networkmanager_create_direct_connect_gateway_attachment/ for full documentation.
Usage
networkmanager_create_direct_connect_gateway_attachment(
CoreNetworkId,
DirectConnectGatewayArn,
EdgeLocations,
Tags = NULL,
ClientToken = NULL
)
Arguments
CoreNetworkId |
[required] The ID of the Cloud WAN core network that the Direct Connect gateway attachment should be attached to. |
DirectConnectGatewayArn |
[required] The ARN of the Direct Connect gateway attachment. |
EdgeLocations |
[required] One or more core network edge locations that the Direct Connect gateway attachment is associated with. |
Tags |
The key value tags to apply to the Direct Connect gateway attachment during creation. |
ClientToken |
client token |
Creates a new, empty global network
Description
Creates a new, empty global network.
See https://www.paws-r-sdk.com/docs/networkmanager_create_global_network/ for full documentation.
Usage
networkmanager_create_global_network(Description = NULL, Tags = NULL)
Arguments
Description |
A description of the global network. Constraints: Maximum length of 256 characters. |
Tags |
The tags to apply to the resource during creation. |
Creates a new link for a specified site
Description
Creates a new link for a specified site.
See https://www.paws-r-sdk.com/docs/networkmanager_create_link/ for full documentation.
Usage
networkmanager_create_link(
GlobalNetworkId,
Description = NULL,
Type = NULL,
Bandwidth,
Provider = NULL,
SiteId,
Tags = NULL
)
Arguments
GlobalNetworkId |
[required] The ID of the global network. |
Description |
A description of the link. Constraints: Maximum length of 256 characters. |
Type |
The type of the link. Constraints: Maximum length of 128 characters. Cannot include the following characters: | \ ^ |
Bandwidth |
[required] The upload speed and download speed in Mbps. |
Provider |
The provider of the link. Constraints: Maximum length of 128 characters. Cannot include the following characters: | \ ^ |
SiteId |
[required] The ID of the site. |
Tags |
The tags to apply to the resource during creation. |
Creates a new site in a global network
Description
Creates a new site in a global network.
See https://www.paws-r-sdk.com/docs/networkmanager_create_site/ for full documentation.
Usage
networkmanager_create_site(
GlobalNetworkId,
Description = NULL,
Location = NULL,
Tags = NULL
)
Arguments
GlobalNetworkId |
[required] The ID of the global network. |
Description |
A description of your site. Constraints: Maximum length of 256 characters. |
Location |
The site location. This information is used for visualization in the Network Manager console. If you specify the address, the latitude and longitude are automatically calculated.
|
Tags |
The tags to apply to the resource during creation. |
Creates an Amazon Web Services site-to-site VPN attachment on an edge location of a core network
Description
Creates an Amazon Web Services site-to-site VPN attachment on an edge location of a core network.
See https://www.paws-r-sdk.com/docs/networkmanager_create_site_to_site_vpn_attachment/ for full documentation.
Usage
networkmanager_create_site_to_site_vpn_attachment(
CoreNetworkId,
VpnConnectionArn,
Tags = NULL,
ClientToken = NULL
)
Arguments
CoreNetworkId |
[required] The ID of a core network where you're creating a site-to-site VPN attachment. |
VpnConnectionArn |
[required] The ARN identifying the VPN attachment. |
Tags |
The tags associated with the request. |
ClientToken |
The client token associated with the request. |
Creates a transit gateway peering connection
Description
Creates a transit gateway peering connection.
See https://www.paws-r-sdk.com/docs/networkmanager_create_transit_gateway_peering/ for full documentation.
Usage
networkmanager_create_transit_gateway_peering(
CoreNetworkId,
TransitGatewayArn,
Tags = NULL,
ClientToken = NULL
)
Arguments
CoreNetworkId |
[required] The ID of a core network. |
TransitGatewayArn |
[required] The ARN of the transit gateway for the peering request. |
Tags |
The list of key-value tags associated with the request. |
ClientToken |
The client token associated with the request. |
Creates a transit gateway route table attachment
Description
Creates a transit gateway route table attachment.
See https://www.paws-r-sdk.com/docs/networkmanager_create_transit_gateway_route_table_attachment/ for full documentation.
Usage
networkmanager_create_transit_gateway_route_table_attachment(
PeeringId,
TransitGatewayRouteTableArn,
Tags = NULL,
ClientToken = NULL
)
Arguments
PeeringId |
[required] The ID of the peer for the |
TransitGatewayRouteTableArn |
[required] The ARN of the transit gateway route table for the attachment request.
For example,
|
Tags |
The list of key-value tags associated with the request. |
ClientToken |
The client token associated with the request. |
Creates a VPC attachment on an edge location of a core network
Description
Creates a VPC attachment on an edge location of a core network.
See https://www.paws-r-sdk.com/docs/networkmanager_create_vpc_attachment/ for full documentation.
Usage
networkmanager_create_vpc_attachment(
CoreNetworkId,
VpcArn,
SubnetArns,
Options = NULL,
Tags = NULL,
ClientToken = NULL
)
Arguments
CoreNetworkId |
[required] The ID of a core network for the VPC attachment. |
VpcArn |
[required] The ARN of the VPC. |
SubnetArns |
[required] The subnet ARN of the VPC attachment. |
Options |
Options for the VPC attachment. |
Tags |
The key-value tags associated with the request. |
ClientToken |
The client token associated with the request. |
Deletes an attachment
Description
Deletes an attachment. Supports all attachment types.
See https://www.paws-r-sdk.com/docs/networkmanager_delete_attachment/ for full documentation.
Usage
networkmanager_delete_attachment(AttachmentId)
Arguments
AttachmentId |
[required] The ID of the attachment to delete. |
Deletes a Connect peer
Description
Deletes a Connect peer.
See https://www.paws-r-sdk.com/docs/networkmanager_delete_connect_peer/ for full documentation.
Usage
networkmanager_delete_connect_peer(ConnectPeerId)
Arguments
ConnectPeerId |
[required] The ID of the deleted Connect peer. |
Deletes the specified connection in your global network
Description
Deletes the specified connection in your global network.
See https://www.paws-r-sdk.com/docs/networkmanager_delete_connection/ for full documentation.
Usage
networkmanager_delete_connection(GlobalNetworkId, ConnectionId)
Arguments
GlobalNetworkId |
[required] The ID of the global network. |
ConnectionId |
[required] The ID of the connection. |
Deletes a core network along with all core network policies
Description
Deletes a core network along with all core network policies. This can only be done if there are no attachments on a core network.
See https://www.paws-r-sdk.com/docs/networkmanager_delete_core_network/ for full documentation.
Usage
networkmanager_delete_core_network(CoreNetworkId)
Arguments
CoreNetworkId |
[required] The network ID of the deleted core network. |
Deletes a policy version from a core network
Description
Deletes a policy version from a core network. You can't delete the current LIVE policy.
See https://www.paws-r-sdk.com/docs/networkmanager_delete_core_network_policy_version/ for full documentation.
Usage
networkmanager_delete_core_network_policy_version(
CoreNetworkId,
PolicyVersionId
)
Arguments
CoreNetworkId |
[required] The ID of a core network for the deleted policy. |
PolicyVersionId |
[required] The version ID of the deleted policy. |
Deletes an existing device
Description
Deletes an existing device. You must first disassociate the device from any links and customer gateways.
See https://www.paws-r-sdk.com/docs/networkmanager_delete_device/ for full documentation.
Usage
networkmanager_delete_device(GlobalNetworkId, DeviceId)
Arguments
GlobalNetworkId |
[required] The ID of the global network. |
DeviceId |
[required] The ID of the device. |
Deletes an existing global network
Description
Deletes an existing global network. You must first delete all global network objects (devices, links, and sites), deregister all transit gateways, and delete any core networks.
See https://www.paws-r-sdk.com/docs/networkmanager_delete_global_network/ for full documentation.
Usage
networkmanager_delete_global_network(GlobalNetworkId)
Arguments
GlobalNetworkId |
[required] The ID of the global network. |
Deletes an existing link
Description
Deletes an existing link. You must first disassociate the link from any devices and customer gateways.
See https://www.paws-r-sdk.com/docs/networkmanager_delete_link/ for full documentation.
Usage
networkmanager_delete_link(GlobalNetworkId, LinkId)
Arguments
GlobalNetworkId |
[required] The ID of the global network. |
LinkId |
[required] The ID of the link. |
Deletes an existing peering connection
Description
Deletes an existing peering connection.
See https://www.paws-r-sdk.com/docs/networkmanager_delete_peering/ for full documentation.
Usage
networkmanager_delete_peering(PeeringId)
Arguments
PeeringId |
[required] The ID of the peering connection to delete. |
Deletes a resource policy for the specified resource
Description
Deletes a resource policy for the specified resource. This revokes the access of the principals specified in the resource policy.
See https://www.paws-r-sdk.com/docs/networkmanager_delete_resource_policy/ for full documentation.
Usage
networkmanager_delete_resource_policy(ResourceArn)
Arguments
ResourceArn |
[required] The ARN of the policy to delete. |
Deletes an existing site
Description
Deletes an existing site. The site cannot be associated with any device or link.
See https://www.paws-r-sdk.com/docs/networkmanager_delete_site/ for full documentation.
Usage
networkmanager_delete_site(GlobalNetworkId, SiteId)
Arguments
GlobalNetworkId |
[required] The ID of the global network. |
SiteId |
[required] The ID of the site. |
Deregisters a transit gateway from your global network
Description
Deregisters a transit gateway from your global network. This action does not delete your transit gateway, or modify any of its attachments. This action removes any customer gateway associations.
See https://www.paws-r-sdk.com/docs/networkmanager_deregister_transit_gateway/ for full documentation.
Usage
networkmanager_deregister_transit_gateway(GlobalNetworkId, TransitGatewayArn)
Arguments
GlobalNetworkId |
[required] The ID of the global network. |
TransitGatewayArn |
[required] The Amazon Resource Name (ARN) of the transit gateway. |
Describes one or more global networks
Description
Describes one or more global networks. By default, all global networks are described. To describe the objects in your global network, you must use the appropriate Get*
action. For example, to list the transit gateways in your global network, use get_transit_gateway_registrations
.
See https://www.paws-r-sdk.com/docs/networkmanager_describe_global_networks/ for full documentation.
Usage
networkmanager_describe_global_networks(
GlobalNetworkIds = NULL,
MaxResults = NULL,
NextToken = NULL
)
Arguments
GlobalNetworkIds |
The IDs of one or more global networks. The maximum is 10. |
MaxResults |
The maximum number of results to return. |
NextToken |
The token for the next page of results. |
Disassociates a core network Connect peer from a device and a link
Description
Disassociates a core network Connect peer from a device and a link.
See https://www.paws-r-sdk.com/docs/networkmanager_disassociate_connect_peer/ for full documentation.
Usage
networkmanager_disassociate_connect_peer(GlobalNetworkId, ConnectPeerId)
Arguments
GlobalNetworkId |
[required] The ID of the global network. |
ConnectPeerId |
[required] The ID of the Connect peer to disassociate from a device. |
Disassociates a customer gateway from a device and a link
Description
Disassociates a customer gateway from a device and a link.
See https://www.paws-r-sdk.com/docs/networkmanager_disassociate_customer_gateway/ for full documentation.
Usage
networkmanager_disassociate_customer_gateway(
GlobalNetworkId,
CustomerGatewayArn
)
Arguments
GlobalNetworkId |
[required] The ID of the global network. |
CustomerGatewayArn |
[required] The Amazon Resource Name (ARN) of the customer gateway. |
Disassociates an existing device from a link
Description
Disassociates an existing device from a link. You must first disassociate any customer gateways that are associated with the link.
See https://www.paws-r-sdk.com/docs/networkmanager_disassociate_link/ for full documentation.
Usage
networkmanager_disassociate_link(GlobalNetworkId, DeviceId, LinkId)
Arguments
GlobalNetworkId |
[required] The ID of the global network. |
DeviceId |
[required] The ID of the device. |
LinkId |
[required] The ID of the link. |
Disassociates a transit gateway Connect peer from a device and link
Description
Disassociates a transit gateway Connect peer from a device and link.
See https://www.paws-r-sdk.com/docs/networkmanager_disassociate_transit_gateway_connect_peer/ for full documentation.
Usage
networkmanager_disassociate_transit_gateway_connect_peer(
GlobalNetworkId,
TransitGatewayConnectPeerArn
)
Arguments
GlobalNetworkId |
[required] The ID of the global network. |
TransitGatewayConnectPeerArn |
[required] The Amazon Resource Name (ARN) of the transit gateway Connect peer. |
Executes a change set on your core network
Description
Executes a change set on your core network. Deploys changes globally based on the policy submitted..
See https://www.paws-r-sdk.com/docs/networkmanager_execute_core_network_change_set/ for full documentation.
Usage
networkmanager_execute_core_network_change_set(CoreNetworkId, PolicyVersionId)
Arguments
CoreNetworkId |
[required] The ID of a core network. |
PolicyVersionId |
[required] The ID of the policy version. |
Returns information about a core network Connect attachment
Description
Returns information about a core network Connect attachment.
See https://www.paws-r-sdk.com/docs/networkmanager_get_connect_attachment/ for full documentation.
Usage
networkmanager_get_connect_attachment(AttachmentId)
Arguments
AttachmentId |
[required] The ID of the attachment. |
Returns information about a core network Connect peer
Description
Returns information about a core network Connect peer.
See https://www.paws-r-sdk.com/docs/networkmanager_get_connect_peer/ for full documentation.
Usage
networkmanager_get_connect_peer(ConnectPeerId)
Arguments
ConnectPeerId |
[required] The ID of the Connect peer. |
Returns information about a core network Connect peer associations
Description
Returns information about a core network Connect peer associations.
See https://www.paws-r-sdk.com/docs/networkmanager_get_connect_peer_associations/ for full documentation.
Usage
networkmanager_get_connect_peer_associations(
GlobalNetworkId,
ConnectPeerIds = NULL,
MaxResults = NULL,
NextToken = NULL
)
Arguments
GlobalNetworkId |
[required] The ID of the global network. |
ConnectPeerIds |
The IDs of the Connect peers. |
MaxResults |
The maximum number of results to return. |
NextToken |
The token for the next page of results. |
Gets information about one or more of your connections in a global network
Description
Gets information about one or more of your connections in a global network.
See https://www.paws-r-sdk.com/docs/networkmanager_get_connections/ for full documentation.
Usage
networkmanager_get_connections(
GlobalNetworkId,
ConnectionIds = NULL,
DeviceId = NULL,
MaxResults = NULL,
NextToken = NULL
)
Arguments
GlobalNetworkId |
[required] The ID of the global network. |
ConnectionIds |
One or more connection IDs. |
DeviceId |
The ID of the device. |
MaxResults |
The maximum number of results to return. |
NextToken |
The token for the next page of results. |
Returns information about the LIVE policy for a core network
Description
Returns information about the LIVE policy for a core network.
See https://www.paws-r-sdk.com/docs/networkmanager_get_core_network/ for full documentation.
Usage
networkmanager_get_core_network(CoreNetworkId)
Arguments
CoreNetworkId |
[required] The ID of a core network. |
Returns information about a core network change event
Description
Returns information about a core network change event.
See https://www.paws-r-sdk.com/docs/networkmanager_get_core_network_change_events/ for full documentation.
Usage
networkmanager_get_core_network_change_events(
CoreNetworkId,
PolicyVersionId,
MaxResults = NULL,
NextToken = NULL
)
Arguments
CoreNetworkId |
[required] The ID of a core network. |
PolicyVersionId |
[required] The ID of the policy version. |
MaxResults |
The maximum number of results to return. |
NextToken |
The token for the next page of results. |
Returns a change set between the LIVE core network policy and a submitted policy
Description
Returns a change set between the LIVE core network policy and a submitted policy.
See https://www.paws-r-sdk.com/docs/networkmanager_get_core_network_change_set/ for full documentation.
Usage
networkmanager_get_core_network_change_set(
CoreNetworkId,
PolicyVersionId,
MaxResults = NULL,
NextToken = NULL
)
Arguments
CoreNetworkId |
[required] The ID of a core network. |
PolicyVersionId |
[required] The ID of the policy version. |
MaxResults |
The maximum number of results to return. |
NextToken |
The token for the next page of results. |
Returns details about a core network policy
Description
Returns details about a core network policy. You can get details about your current live policy or any previous policy version.
See https://www.paws-r-sdk.com/docs/networkmanager_get_core_network_policy/ for full documentation.
Usage
networkmanager_get_core_network_policy(
CoreNetworkId,
PolicyVersionId = NULL,
Alias = NULL
)
Arguments
CoreNetworkId |
[required] The ID of a core network. |
PolicyVersionId |
The ID of a core network policy version. |
Alias |
The alias of a core network policy |
Gets the association information for customer gateways that are associated with devices and links in your global network
Description
Gets the association information for customer gateways that are associated with devices and links in your global network.
See https://www.paws-r-sdk.com/docs/networkmanager_get_customer_gateway_associations/ for full documentation.
Usage
networkmanager_get_customer_gateway_associations(
GlobalNetworkId,
CustomerGatewayArns = NULL,
MaxResults = NULL,
NextToken = NULL
)
Arguments
GlobalNetworkId |
[required] The ID of the global network. |
CustomerGatewayArns |
One or more customer gateway Amazon Resource Names (ARNs). The maximum is 10. |
MaxResults |
The maximum number of results to return. |
NextToken |
The token for the next page of results. |
Gets information about one or more of your devices in a global network
Description
Gets information about one or more of your devices in a global network.
See https://www.paws-r-sdk.com/docs/networkmanager_get_devices/ for full documentation.
Usage
networkmanager_get_devices(
GlobalNetworkId,
DeviceIds = NULL,
SiteId = NULL,
MaxResults = NULL,
NextToken = NULL
)
Arguments
GlobalNetworkId |
[required] The ID of the global network. |
DeviceIds |
One or more device IDs. The maximum is 10. |
SiteId |
The ID of the site. |
MaxResults |
The maximum number of results to return. |
NextToken |
The token for the next page of results. |
Returns information about a specific Amazon Web Services Direct Connect gateway attachment
Description
Returns information about a specific Amazon Web Services Direct Connect gateway attachment.
See https://www.paws-r-sdk.com/docs/networkmanager_get_direct_connect_gateway_attachment/ for full documentation.
Usage
networkmanager_get_direct_connect_gateway_attachment(AttachmentId)
Arguments
AttachmentId |
[required] The ID of the Direct Connect gateway attachment that you want to see details about. |
Gets the link associations for a device or a link
Description
Gets the link associations for a device or a link. Either the device ID or the link ID must be specified.
See https://www.paws-r-sdk.com/docs/networkmanager_get_link_associations/ for full documentation.
Usage
networkmanager_get_link_associations(
GlobalNetworkId,
DeviceId = NULL,
LinkId = NULL,
MaxResults = NULL,
NextToken = NULL
)
Arguments
GlobalNetworkId |
[required] The ID of the global network. |
DeviceId |
The ID of the device. |
LinkId |
The ID of the link. |
MaxResults |
The maximum number of results to return. |
NextToken |
The token for the next page of results. |
Gets information about one or more links in a specified global network
Description
Gets information about one or more links in a specified global network.
See https://www.paws-r-sdk.com/docs/networkmanager_get_links/ for full documentation.
Usage
networkmanager_get_links(
GlobalNetworkId,
LinkIds = NULL,
SiteId = NULL,
Type = NULL,
Provider = NULL,
MaxResults = NULL,
NextToken = NULL
)
Arguments
GlobalNetworkId |
[required] The ID of the global network. |
LinkIds |
One or more link IDs. The maximum is 10. |
SiteId |
The ID of the site. |
Type |
The link type. |
Provider |
The link provider. |
MaxResults |
The maximum number of results to return. |
NextToken |
The token for the next page of results. |
Gets the count of network resources, by resource type, for the specified global network
Description
Gets the count of network resources, by resource type, for the specified global network.
See https://www.paws-r-sdk.com/docs/networkmanager_get_network_resource_counts/ for full documentation.
Usage
networkmanager_get_network_resource_counts(
GlobalNetworkId,
ResourceType = NULL,
MaxResults = NULL,
NextToken = NULL
)
Arguments
GlobalNetworkId |
[required] The ID of the global network. |
ResourceType |
The resource type. The following are the supported resource types for Direct Connect:
The following are the supported resource types for Network Manager:
The following are the supported resource types for Amazon VPC:
|
MaxResults |
The maximum number of results to return. |
NextToken |
The token for the next page of results. |
Gets the network resource relationships for the specified global network
Description
Gets the network resource relationships for the specified global network.
See https://www.paws-r-sdk.com/docs/networkmanager_get_network_resource_relationships/ for full documentation.
Usage
networkmanager_get_network_resource_relationships(
GlobalNetworkId,
CoreNetworkId = NULL,
RegisteredGatewayArn = NULL,
AwsRegion = NULL,
AccountId = NULL,
ResourceType = NULL,
ResourceArn = NULL,
MaxResults = NULL,
NextToken = NULL
)
Arguments
GlobalNetworkId |
[required] The ID of the global network. |
CoreNetworkId |
The ID of a core network. |
RegisteredGatewayArn |
The ARN of the registered gateway. |
AwsRegion |
The Amazon Web Services Region. |
AccountId |
The Amazon Web Services account ID. |
ResourceType |
The resource type. The following are the supported resource types for Direct Connect:
The following are the supported resource types for Network Manager:
The following are the supported resource types for Amazon VPC:
|
ResourceArn |
The ARN of the gateway. |
MaxResults |
The maximum number of results to return. |
NextToken |
The token for the next page of results. |
Describes the network resources for the specified global network
Description
Describes the network resources for the specified global network.
See https://www.paws-r-sdk.com/docs/networkmanager_get_network_resources/ for full documentation.
Usage
networkmanager_get_network_resources(
GlobalNetworkId,
CoreNetworkId = NULL,
RegisteredGatewayArn = NULL,
AwsRegion = NULL,
AccountId = NULL,
ResourceType = NULL,
ResourceArn = NULL,
MaxResults = NULL,
NextToken = NULL
)
Arguments
GlobalNetworkId |
[required] The ID of the global network. |
CoreNetworkId |
The ID of a core network. |
RegisteredGatewayArn |
The ARN of the gateway. |
AwsRegion |
The Amazon Web Services Region. |
AccountId |
The Amazon Web Services account ID. |
ResourceType |
The resource type. The following are the supported resource types for Direct Connect:
The following are the supported resource types for Network Manager:
The following are the supported resource types for Amazon VPC:
|
ResourceArn |
The ARN of the resource. |
MaxResults |
The maximum number of results to return. |
NextToken |
The token for the next page of results. |
Gets the network routes of the specified global network
Description
Gets the network routes of the specified global network.
See https://www.paws-r-sdk.com/docs/networkmanager_get_network_routes/ for full documentation.
Usage
networkmanager_get_network_routes(
GlobalNetworkId,
RouteTableIdentifier,
ExactCidrMatches = NULL,
LongestPrefixMatches = NULL,
SubnetOfMatches = NULL,
SupernetOfMatches = NULL,
PrefixListIds = NULL,
States = NULL,
Types = NULL,
DestinationFilters = NULL
)
Arguments
GlobalNetworkId |
[required] The ID of the global network. |
RouteTableIdentifier |
[required] The ID of the route table. |
ExactCidrMatches |
An exact CIDR block. |
LongestPrefixMatches |
The most specific route that matches the traffic (longest prefix match). |
SubnetOfMatches |
The routes with a subnet that match the specified CIDR filter. |
SupernetOfMatches |
The routes with a CIDR that encompasses the CIDR filter. Example: If you specify 10.0.1.0/30, then the result returns 10.0.1.0/29. |
PrefixListIds |
The IDs of the prefix lists. |
States |
The route states. |
Types |
The route types. |
DestinationFilters |
Filter by route table destination. Possible Values: TRANSIT_GATEWAY_ATTACHMENT_ID, RESOURCE_ID, or RESOURCE_TYPE. |
Gets the network telemetry of the specified global network
Description
Gets the network telemetry of the specified global network.
See https://www.paws-r-sdk.com/docs/networkmanager_get_network_telemetry/ for full documentation.
Usage
networkmanager_get_network_telemetry(
GlobalNetworkId,
CoreNetworkId = NULL,
RegisteredGatewayArn = NULL,
AwsRegion = NULL,
AccountId = NULL,
ResourceType = NULL,
ResourceArn = NULL,
MaxResults = NULL,
NextToken = NULL
)
Arguments
GlobalNetworkId |
[required] The ID of the global network. |
CoreNetworkId |
The ID of a core network. |
RegisteredGatewayArn |
The ARN of the gateway. |
AwsRegion |
The Amazon Web Services Region. |
AccountId |
The Amazon Web Services account ID. |
ResourceType |
The resource type. The following are the supported resource types:
|
ResourceArn |
The ARN of the resource. |
MaxResults |
The maximum number of results to return. |
NextToken |
The token for the next page of results. |
Returns information about a resource policy
Description
Returns information about a resource policy.
See https://www.paws-r-sdk.com/docs/networkmanager_get_resource_policy/ for full documentation.
Usage
networkmanager_get_resource_policy(ResourceArn)
Arguments
ResourceArn |
[required] The ARN of the resource. |
Gets information about the specified route analysis
Description
Gets information about the specified route analysis.
See https://www.paws-r-sdk.com/docs/networkmanager_get_route_analysis/ for full documentation.
Usage
networkmanager_get_route_analysis(GlobalNetworkId, RouteAnalysisId)
Arguments
GlobalNetworkId |
[required] The ID of the global network. |
RouteAnalysisId |
[required] The ID of the route analysis. |
Returns information about a site-to-site VPN attachment
Description
Returns information about a site-to-site VPN attachment.
See https://www.paws-r-sdk.com/docs/networkmanager_get_site_to_site_vpn_attachment/ for full documentation.
Usage
networkmanager_get_site_to_site_vpn_attachment(AttachmentId)
Arguments
AttachmentId |
[required] The ID of the attachment. |
Gets information about one or more of your sites in a global network
Description
Gets information about one or more of your sites in a global network.
See https://www.paws-r-sdk.com/docs/networkmanager_get_sites/ for full documentation.
Usage
networkmanager_get_sites(
GlobalNetworkId,
SiteIds = NULL,
MaxResults = NULL,
NextToken = NULL
)
Arguments
GlobalNetworkId |
[required] The ID of the global network. |
SiteIds |
One or more site IDs. The maximum is 10. |
MaxResults |
The maximum number of results to return. |
NextToken |
The token for the next page of results. |
Gets information about one or more of your transit gateway Connect peer associations in a global network
Description
Gets information about one or more of your transit gateway Connect peer associations in a global network.
See https://www.paws-r-sdk.com/docs/networkmanager_get_transit_gateway_connect_peer_associations/ for full documentation.
Usage
networkmanager_get_transit_gateway_connect_peer_associations(
GlobalNetworkId,
TransitGatewayConnectPeerArns = NULL,
MaxResults = NULL,
NextToken = NULL
)
Arguments
GlobalNetworkId |
[required] The ID of the global network. |
TransitGatewayConnectPeerArns |
One or more transit gateway Connect peer Amazon Resource Names (ARNs). |
MaxResults |
The maximum number of results to return. |
NextToken |
The token for the next page of results. |
Returns information about a transit gateway peer
Description
Returns information about a transit gateway peer.
See https://www.paws-r-sdk.com/docs/networkmanager_get_transit_gateway_peering/ for full documentation.
Usage
networkmanager_get_transit_gateway_peering(PeeringId)
Arguments
PeeringId |
[required] The ID of the peering request. |
Gets information about the transit gateway registrations in a specified global network
Description
Gets information about the transit gateway registrations in a specified global network.
See https://www.paws-r-sdk.com/docs/networkmanager_get_transit_gateway_registrations/ for full documentation.
Usage
networkmanager_get_transit_gateway_registrations(
GlobalNetworkId,
TransitGatewayArns = NULL,
MaxResults = NULL,
NextToken = NULL
)
Arguments
GlobalNetworkId |
[required] The ID of the global network. |
TransitGatewayArns |
The Amazon Resource Names (ARNs) of one or more transit gateways. The maximum is 10. |
MaxResults |
The maximum number of results to return. |
NextToken |
The token for the next page of results. |
Returns information about a transit gateway route table attachment
Description
Returns information about a transit gateway route table attachment.
See https://www.paws-r-sdk.com/docs/networkmanager_get_transit_gateway_route_table_attachment/ for full documentation.
Usage
networkmanager_get_transit_gateway_route_table_attachment(AttachmentId)
Arguments
AttachmentId |
[required] The ID of the transit gateway route table attachment. |
Returns information about a VPC attachment
Description
Returns information about a VPC attachment.
See https://www.paws-r-sdk.com/docs/networkmanager_get_vpc_attachment/ for full documentation.
Usage
networkmanager_get_vpc_attachment(AttachmentId)
Arguments
AttachmentId |
[required] The ID of the attachment. |
Returns a list of core network attachments
Description
Returns a list of core network attachments.
See https://www.paws-r-sdk.com/docs/networkmanager_list_attachments/ for full documentation.
Usage
networkmanager_list_attachments(
CoreNetworkId = NULL,
AttachmentType = NULL,
EdgeLocation = NULL,
State = NULL,
MaxResults = NULL,
NextToken = NULL
)
Arguments
CoreNetworkId |
The ID of a core network. |
AttachmentType |
The type of attachment. |
EdgeLocation |
The Region where the edge is located. |
State |
The state of the attachment. |
MaxResults |
The maximum number of results to return. |
NextToken |
The token for the next page of results. |
Returns a list of core network Connect peers
Description
Returns a list of core network Connect peers.
See https://www.paws-r-sdk.com/docs/networkmanager_list_connect_peers/ for full documentation.
Usage
networkmanager_list_connect_peers(
CoreNetworkId = NULL,
ConnectAttachmentId = NULL,
MaxResults = NULL,
NextToken = NULL
)
Arguments
CoreNetworkId |
The ID of a core network. |
ConnectAttachmentId |
The ID of the attachment. |
MaxResults |
The maximum number of results to return. |
NextToken |
The token for the next page of results. |
Returns a list of core network policy versions
Description
Returns a list of core network policy versions.
See https://www.paws-r-sdk.com/docs/networkmanager_list_core_network_policy_versions/ for full documentation.
Usage
networkmanager_list_core_network_policy_versions(
CoreNetworkId,
MaxResults = NULL,
NextToken = NULL
)
Arguments
CoreNetworkId |
[required] The ID of a core network. |
MaxResults |
The maximum number of results to return. |
NextToken |
The token for the next page of results. |
Returns a list of owned and shared core networks
Description
Returns a list of owned and shared core networks.
See https://www.paws-r-sdk.com/docs/networkmanager_list_core_networks/ for full documentation.
Usage
networkmanager_list_core_networks(MaxResults = NULL, NextToken = NULL)
Arguments
MaxResults |
The maximum number of results to return. |
NextToken |
The token for the next page of results. |
Gets the status of the Service Linked Role (SLR) deployment for the accounts in a given Amazon Web Services Organization
Description
Gets the status of the Service Linked Role (SLR) deployment for the accounts in a given Amazon Web Services Organization.
See https://www.paws-r-sdk.com/docs/networkmanager_list_organization_service_access_status/ for full documentation.
Usage
networkmanager_list_organization_service_access_status(
MaxResults = NULL,
NextToken = NULL
)
Arguments
MaxResults |
The maximum number of results to return. |
NextToken |
The token for the next page of results. |
Lists the peerings for a core network
Description
Lists the peerings for a core network.
See https://www.paws-r-sdk.com/docs/networkmanager_list_peerings/ for full documentation.
Usage
networkmanager_list_peerings(
CoreNetworkId = NULL,
PeeringType = NULL,
EdgeLocation = NULL,
State = NULL,
MaxResults = NULL,
NextToken = NULL
)
Arguments
CoreNetworkId |
The ID of a core network. |
PeeringType |
Returns a list of a peering requests. |
EdgeLocation |
Returns a list edge locations for the |
State |
Returns a list of the peering request states. |
MaxResults |
The maximum number of results to return. |
NextToken |
The token for the next page of results. |
Lists the tags for a specified resource
Description
Lists the tags for a specified resource.
See https://www.paws-r-sdk.com/docs/networkmanager_list_tags_for_resource/ for full documentation.
Usage
networkmanager_list_tags_for_resource(ResourceArn)
Arguments
ResourceArn |
[required] The Amazon Resource Name (ARN) of the resource. |
Creates a new, immutable version of a core network policy
Description
Creates a new, immutable version of a core network policy. A subsequent change set is created showing the differences between the LIVE policy and the submitted policy.
See https://www.paws-r-sdk.com/docs/networkmanager_put_core_network_policy/ for full documentation.
Usage
networkmanager_put_core_network_policy(
CoreNetworkId,
PolicyDocument,
Description = NULL,
LatestVersionId = NULL,
ClientToken = NULL
)
Arguments
CoreNetworkId |
[required] The ID of a core network. |
PolicyDocument |
[required] The policy document. |
Description |
a core network policy description. |
LatestVersionId |
The ID of a core network policy. |
ClientToken |
The client token associated with the request. |
Creates or updates a resource policy
Description
Creates or updates a resource policy.
See https://www.paws-r-sdk.com/docs/networkmanager_put_resource_policy/ for full documentation.
Usage
networkmanager_put_resource_policy(PolicyDocument, ResourceArn)
Arguments
PolicyDocument |
[required] The JSON resource policy document. |
ResourceArn |
[required] The ARN of the resource policy. |
Registers a transit gateway in your global network
Description
Registers a transit gateway in your global network. Not all Regions support transit gateways for global networks. For a list of the supported Regions, see Region Availability in the Amazon Web Services Transit Gateways for Global Networks User Guide. The transit gateway can be in any of the supported Amazon Web Services Regions, but it must be owned by the same Amazon Web Services account that owns the global network. You cannot register a transit gateway in more than one global network.
See https://www.paws-r-sdk.com/docs/networkmanager_register_transit_gateway/ for full documentation.
Usage
networkmanager_register_transit_gateway(GlobalNetworkId, TransitGatewayArn)
Arguments
GlobalNetworkId |
[required] The ID of the global network. |
TransitGatewayArn |
[required] The Amazon Resource Name (ARN) of the transit gateway. |
Rejects a core network attachment request
Description
Rejects a core network attachment request.
See https://www.paws-r-sdk.com/docs/networkmanager_reject_attachment/ for full documentation.
Usage
networkmanager_reject_attachment(AttachmentId)
Arguments
AttachmentId |
[required] The ID of the attachment. |
Restores a previous policy version as a new, immutable version of a core network policy
Description
Restores a previous policy version as a new, immutable version of a core network policy. A subsequent change set is created showing the differences between the LIVE policy and restored policy.
See https://www.paws-r-sdk.com/docs/networkmanager_restore_core_network_policy_version/ for full documentation.
Usage
networkmanager_restore_core_network_policy_version(
CoreNetworkId,
PolicyVersionId
)
Arguments
CoreNetworkId |
[required] The ID of a core network. |
PolicyVersionId |
[required] The ID of the policy version to restore. |
Enables the Network Manager service for an Amazon Web Services Organization
Description
Enables the Network Manager service for an Amazon Web Services Organization. This can only be called by a management account within the organization.
See https://www.paws-r-sdk.com/docs/networkmanager_start_organization_service_access_update/ for full documentation.
Usage
networkmanager_start_organization_service_access_update(Action)
Arguments
Action |
[required] The action to take for the update request. This can be either |
Starts analyzing the routing path between the specified source and destination
Description
Starts analyzing the routing path between the specified source and destination. For more information, see Route Analyzer.
See https://www.paws-r-sdk.com/docs/networkmanager_start_route_analysis/ for full documentation.
Usage
networkmanager_start_route_analysis(
GlobalNetworkId,
Source,
Destination,
IncludeReturnPath = NULL,
UseMiddleboxes = NULL
)
Arguments
GlobalNetworkId |
[required] The ID of the global network. |
Source |
[required] The source from which traffic originates. |
Destination |
[required] The destination. |
IncludeReturnPath |
Indicates whether to analyze the return path. The default is |
UseMiddleboxes |
Indicates whether to include the location of middlebox appliances in the
route analysis. The default is |
Tags a specified resource
Description
Tags a specified resource.
See https://www.paws-r-sdk.com/docs/networkmanager_tag_resource/ for full documentation.
Usage
networkmanager_tag_resource(ResourceArn, Tags)
Arguments
ResourceArn |
[required] The Amazon Resource Name (ARN) of the resource. |
Tags |
[required] The tags to apply to the specified resource. |
Removes tags from a specified resource
Description
Removes tags from a specified resource.
See https://www.paws-r-sdk.com/docs/networkmanager_untag_resource/ for full documentation.
Usage
networkmanager_untag_resource(ResourceArn, TagKeys)
Arguments
ResourceArn |
[required] The Amazon Resource Name (ARN) of the resource. |
TagKeys |
[required] The tag keys to remove from the specified resource. |
Updates the information for an existing connection
Description
Updates the information for an existing connection. To remove information for any of the parameters, specify an empty string.
See https://www.paws-r-sdk.com/docs/networkmanager_update_connection/ for full documentation.
Usage
networkmanager_update_connection(
GlobalNetworkId,
ConnectionId,
LinkId = NULL,
ConnectedLinkId = NULL,
Description = NULL
)
Arguments
GlobalNetworkId |
[required] The ID of the global network. |
ConnectionId |
[required] The ID of the connection. |
LinkId |
The ID of the link for the first device in the connection. |
ConnectedLinkId |
The ID of the link for the second device in the connection. |
Description |
A description of the connection. Length Constraints: Maximum length of 256 characters. |
Updates the description of a core network
Description
Updates the description of a core network.
See https://www.paws-r-sdk.com/docs/networkmanager_update_core_network/ for full documentation.
Usage
networkmanager_update_core_network(CoreNetworkId, Description = NULL)
Arguments
CoreNetworkId |
[required] The ID of a core network. |
Description |
The description of the update. |
Updates the details for an existing device
Description
Updates the details for an existing device. To remove information for any of the parameters, specify an empty string.
See https://www.paws-r-sdk.com/docs/networkmanager_update_device/ for full documentation.
Usage
networkmanager_update_device(
GlobalNetworkId,
DeviceId,
AWSLocation = NULL,
Description = NULL,
Type = NULL,
Vendor = NULL,
Model = NULL,
SerialNumber = NULL,
Location = NULL,
SiteId = NULL
)
Arguments
GlobalNetworkId |
[required] The ID of the global network. |
DeviceId |
[required] The ID of the device. |
AWSLocation |
The Amazon Web Services location of the device, if applicable. For an on-premises device, you can omit this parameter. |
Description |
A description of the device. Constraints: Maximum length of 256 characters. |
Type |
The type of the device. |
Vendor |
The vendor of the device. Constraints: Maximum length of 128 characters. |
Model |
The model of the device. Constraints: Maximum length of 128 characters. |
SerialNumber |
The serial number of the device. Constraints: Maximum length of 128 characters. |
Location |
|
SiteId |
The ID of the site. |
Updates the edge locations associated with an Amazon Web Services Direct Connect gateway attachment
Description
Updates the edge locations associated with an Amazon Web Services Direct Connect gateway attachment.
See https://www.paws-r-sdk.com/docs/networkmanager_update_direct_connect_gateway_attachment/ for full documentation.
Usage
networkmanager_update_direct_connect_gateway_attachment(
AttachmentId,
EdgeLocations = NULL
)
Arguments
AttachmentId |
[required] The ID of the Direct Connect gateway attachment for the updated edge locations. |
EdgeLocations |
One or more edge locations to update for the Direct Connect gateway
attachment. The updated array of edge locations overwrites the previous
array of locations. |
Updates an existing global network
Description
Updates an existing global network. To remove information for any of the parameters, specify an empty string.
See https://www.paws-r-sdk.com/docs/networkmanager_update_global_network/ for full documentation.
Usage
networkmanager_update_global_network(GlobalNetworkId, Description = NULL)
Arguments
GlobalNetworkId |
[required] The ID of your global network. |
Description |
A description of the global network. Constraints: Maximum length of 256 characters. |
Updates the details for an existing link
Description
Updates the details for an existing link. To remove information for any of the parameters, specify an empty string.
See https://www.paws-r-sdk.com/docs/networkmanager_update_link/ for full documentation.
Usage
networkmanager_update_link(
GlobalNetworkId,
LinkId,
Description = NULL,
Type = NULL,
Bandwidth = NULL,
Provider = NULL
)
Arguments
GlobalNetworkId |
[required] The ID of the global network. |
LinkId |
[required] The ID of the link. |
Description |
A description of the link. Constraints: Maximum length of 256 characters. |
Type |
The type of the link. Constraints: Maximum length of 128 characters. |
Bandwidth |
The upload and download speed in Mbps. |
Provider |
The provider of the link. Constraints: Maximum length of 128 characters. |
Updates the resource metadata for the specified global network
Description
Updates the resource metadata for the specified global network.
See https://www.paws-r-sdk.com/docs/networkmanager_update_network_resource_metadata/ for full documentation.
Usage
networkmanager_update_network_resource_metadata(
GlobalNetworkId,
ResourceArn,
Metadata
)
Arguments
GlobalNetworkId |
[required] The ID of the global network. |
ResourceArn |
[required] The ARN of the resource. |
Metadata |
[required] The resource metadata. |
Updates the information for an existing site
Description
Updates the information for an existing site. To remove information for any of the parameters, specify an empty string.
See https://www.paws-r-sdk.com/docs/networkmanager_update_site/ for full documentation.
Usage
networkmanager_update_site(
GlobalNetworkId,
SiteId,
Description = NULL,
Location = NULL
)
Arguments
GlobalNetworkId |
[required] The ID of the global network. |
SiteId |
[required] The ID of your site. |
Description |
A description of your site. Constraints: Maximum length of 256 characters. |
Location |
The site location:
|
Updates a VPC attachment
Description
Updates a VPC attachment.
See https://www.paws-r-sdk.com/docs/networkmanager_update_vpc_attachment/ for full documentation.
Usage
networkmanager_update_vpc_attachment(
AttachmentId,
AddSubnetArns = NULL,
RemoveSubnetArns = NULL,
Options = NULL
)
Arguments
AttachmentId |
[required] The ID of the attachment. |
AddSubnetArns |
Adds a subnet ARN to the VPC attachment. |
RemoveSubnetArns |
Removes a subnet ARN from the attachment. |
Options |
Additional options for updating the VPC attachment. |
Objects exported from other packages
Description
These objects are imported from other packages. Follow the links below to see their documentation.
- paws.common
config
,credentials
,creds
,list_paginators
,paginate
,paginate_lapply
,paginate_sapply
,paws_stream_parser
Amazon Route 53
Description
Amazon Route 53 is a highly available and scalable Domain Name System (DNS) web service.
You can use Route 53 to:
Register domain names.
For more information, see How domain registration works.
Route internet traffic to the resources for your domain
For more information, see How internet traffic is routed to your website or web application.
Check the health of your resources.
For more information, see How Route 53 checks the health of your resources.
Usage
route53(config = list(), credentials = list(), endpoint = NULL, region = NULL)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...)
, where svc
is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- route53( config = list( credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string", close_connection = "logical", timeout = "numeric", s3_force_path_style = "logical", sts_regional_endpoint = "string" ), credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string" )
Operations
activate_key_signing_key | Activates a key-signing key (KSK) so that it can be used for signing by DNSSEC |
associate_vpc_with_hosted_zone | Associates an Amazon VPC with a private hosted zone |
change_cidr_collection | Creates, changes, or deletes CIDR blocks within a collection |
change_resource_record_sets | Creates, changes, or deletes a resource record set, which contains authoritative DNS information for a specified domain name or subdomain name |
change_tags_for_resource | Adds, edits, or deletes tags for a health check or a hosted zone |
create_cidr_collection | Creates a CIDR collection in the current Amazon Web Services account |
create_health_check | Creates a new health check |
create_hosted_zone | Creates a new public or private hosted zone |
create_key_signing_key | Creates a new key-signing key (KSK) associated with a hosted zone |
create_query_logging_config | Creates a configuration for DNS query logging |
create_reusable_delegation_set | Creates a delegation set (a group of four name servers) that can be reused by multiple hosted zones that were created by the same Amazon Web Services account |
create_traffic_policy | Creates a traffic policy, which you use to create multiple DNS resource record sets for one domain name (such as example |
create_traffic_policy_instance | Creates resource record sets in a specified hosted zone based on the settings in a specified traffic policy version |
create_traffic_policy_version | Creates a new version of an existing traffic policy |
create_vpc_association_authorization | Authorizes the Amazon Web Services account that created a specified VPC to submit an AssociateVPCWithHostedZone request to associate the VPC with a specified hosted zone that was created by a different account |
deactivate_key_signing_key | Deactivates a key-signing key (KSK) so that it will not be used for signing by DNSSEC |
delete_cidr_collection | Deletes a CIDR collection in the current Amazon Web Services account |
delete_health_check | Deletes a health check |
delete_hosted_zone | Deletes a hosted zone |
delete_key_signing_key | Deletes a key-signing key (KSK) |
delete_query_logging_config | Deletes a configuration for DNS query logging |
delete_reusable_delegation_set | Deletes a reusable delegation set |
delete_traffic_policy | Deletes a traffic policy |
delete_traffic_policy_instance | Deletes a traffic policy instance and all of the resource record sets that Amazon Route 53 created when you created the instance |
delete_vpc_association_authorization | Removes authorization to submit an AssociateVPCWithHostedZone request to associate a specified VPC with a hosted zone that was created by a different account |
disable_hosted_zone_dnssec | Disables DNSSEC signing in a specific hosted zone |
disassociate_vpc_from_hosted_zone | Disassociates an Amazon Virtual Private Cloud (Amazon VPC) from an Amazon Route 53 private hosted zone |
enable_hosted_zone_dnssec | Enables DNSSEC signing in a specific hosted zone |
get_account_limit | Gets the specified limit for the current account, for example, the maximum number of health checks that you can create using the account |
get_change | Returns the current status of a change batch request |
get_checker_ip_ranges | Route 53 does not perform authorization for this API because it retrieves information that is already available to the public |
get_dnssec | Returns information about DNSSEC for a specific hosted zone, including the key-signing keys (KSKs) in the hosted zone |
get_geo_location | Gets information about whether a specified geographic location is supported for Amazon Route 53 geolocation resource record sets |
get_health_check | Gets information about a specified health check |
get_health_check_count | Retrieves the number of health checks that are associated with the current Amazon Web Services account |
get_health_check_last_failure_reason | Gets the reason that a specified health check failed most recently |
get_health_check_status | Gets status of a specified health check |
get_hosted_zone | Gets information about a specified hosted zone including the four name servers assigned to the hosted zone |
get_hosted_zone_count | Retrieves the number of hosted zones that are associated with the current Amazon Web Services account |
get_hosted_zone_limit | Gets the specified limit for a specified hosted zone, for example, the maximum number of records that you can create in the hosted zone |
get_query_logging_config | Gets information about a specified configuration for DNS query logging |
get_reusable_delegation_set | Retrieves information about a specified reusable delegation set, including the four name servers that are assigned to the delegation set |
get_reusable_delegation_set_limit | Gets the maximum number of hosted zones that you can associate with the specified reusable delegation set |
get_traffic_policy | Gets information about a specific traffic policy version |
get_traffic_policy_instance | Gets information about a specified traffic policy instance |
get_traffic_policy_instance_count | Gets the number of traffic policy instances that are associated with the current Amazon Web Services account |
list_cidr_blocks | Returns a paginated list of location objects and their CIDR blocks |
list_cidr_collections | Returns a paginated list of CIDR collections in the Amazon Web Services account (metadata only) |
list_cidr_locations | Returns a paginated list of CIDR locations for the given collection (metadata only, does not include CIDR blocks) |
list_geo_locations | Retrieves a list of supported geographic locations |
list_health_checks | Retrieve a list of the health checks that are associated with the current Amazon Web Services account |
list_hosted_zones | Retrieves a list of the public and private hosted zones that are associated with the current Amazon Web Services account |
list_hosted_zones_by_name | Retrieves a list of your hosted zones in lexicographic order |
list_hosted_zones_by_vpc | Lists all the private hosted zones that a specified VPC is associated with, regardless of which Amazon Web Services account or Amazon Web Services service owns the hosted zones |
list_query_logging_configs | Lists the configurations for DNS query logging that are associated with the current Amazon Web Services account or the configuration that is associated with a specified hosted zone |
list_resource_record_sets | Lists the resource record sets in a specified hosted zone |
list_reusable_delegation_sets | Retrieves a list of the reusable delegation sets that are associated with the current Amazon Web Services account |
list_tags_for_resource | Lists tags for one health check or hosted zone |
list_tags_for_resources | Lists tags for up to 10 health checks or hosted zones |
list_traffic_policies | Gets information about the latest version for every traffic policy that is associated with the current Amazon Web Services account |
list_traffic_policy_instances | Gets information about the traffic policy instances that you created by using the current Amazon Web Services account |
list_traffic_policy_instances_by_hosted_zone | Gets information about the traffic policy instances that you created in a specified hosted zone |
list_traffic_policy_instances_by_policy | Gets information about the traffic policy instances that you created by using a specify traffic policy version |
list_traffic_policy_versions | Gets information about all of the versions for a specified traffic policy |
list_vpc_association_authorizations | Gets a list of the VPCs that were created by other accounts and that can be associated with a specified hosted zone because you've submitted one or more CreateVPCAssociationAuthorization requests |
test_dns_answer | Gets the value that Amazon Route 53 returns in response to a DNS request for a specified record name and type |
update_health_check | Updates an existing health check |
update_hosted_zone_comment | Updates the comment for a specified hosted zone |
update_traffic_policy_comment | Updates the comment for a specified traffic policy version |
update_traffic_policy_instance | After you submit a UpdateTrafficPolicyInstance request, there's a brief delay while Route 53 creates the resource record sets that are specified in the traffic policy definition |
Examples
## Not run:
svc <- route53()
# The following example associates the VPC with ID vpc-1a2b3c4d with the
# hosted zone with ID Z3M3LMPEXAMPLE.
svc$associate_vpc_with_hosted_zone(
Comment = "",
HostedZoneId = "Z3M3LMPEXAMPLE",
VPC = list(
VPCId = "vpc-1a2b3c4d",
VPCRegion = "us-east-2"
)
)
## End(Not run)
Activates a key-signing key (KSK) so that it can be used for signing by DNSSEC
Description
Activates a key-signing key (KSK) so that it can be used for signing by DNSSEC. This operation changes the KSK status to ACTIVE
.
See https://www.paws-r-sdk.com/docs/route53_activate_key_signing_key/ for full documentation.
Usage
route53_activate_key_signing_key(HostedZoneId, Name)
Arguments
HostedZoneId |
[required] A unique string used to identify a hosted zone. |
Name |
[required] A string used to identify a key-signing key (KSK). |
Associates an Amazon VPC with a private hosted zone
Description
Associates an Amazon VPC with a private hosted zone.
See https://www.paws-r-sdk.com/docs/route53_associate_vpc_with_hosted_zone/ for full documentation.
Usage
route53_associate_vpc_with_hosted_zone(HostedZoneId, VPC, Comment = NULL)
Arguments
HostedZoneId |
[required] The ID of the private hosted zone that you want to associate an Amazon VPC with. Note that you can't associate a VPC with a hosted zone that doesn't have an existing VPC association. |
VPC |
[required] A complex type that contains information about the VPC that you want to associate with a private hosted zone. |
Comment |
Optional: A comment about the association request. |
Creates, changes, or deletes CIDR blocks within a collection
Description
Creates, changes, or deletes CIDR blocks within a collection. Contains authoritative IP information mapping blocks to one or multiple locations.
See https://www.paws-r-sdk.com/docs/route53_change_cidr_collection/ for full documentation.
Usage
route53_change_cidr_collection(Id, CollectionVersion = NULL, Changes)
Arguments
Id |
[required] The UUID of the CIDR collection to update. |
CollectionVersion |
A sequential counter that Amazon Route 53 sets to 1 when you create a collection and increments it by 1 each time you update the collection. We recommend that you use
|
Changes |
[required] Information about changes to a CIDR collection. |
Creates, changes, or deletes a resource record set, which contains authoritative DNS information for a specified domain name or subdomain name
Description
Creates, changes, or deletes a resource record set, which contains authoritative DNS information for a specified domain name or subdomain name. For example, you can use change_resource_record_sets
to create a resource record set that routes traffic for test.example.com to a web server that has an IP address of 192.0.2.44.
See https://www.paws-r-sdk.com/docs/route53_change_resource_record_sets/ for full documentation.
Usage
route53_change_resource_record_sets(HostedZoneId, ChangeBatch)
Arguments
HostedZoneId |
[required] The ID of the hosted zone that contains the resource record sets that you want to change. |
ChangeBatch |
[required] A complex type that contains an optional comment and the |
Adds, edits, or deletes tags for a health check or a hosted zone
Description
Adds, edits, or deletes tags for a health check or a hosted zone.
See https://www.paws-r-sdk.com/docs/route53_change_tags_for_resource/ for full documentation.
Usage
route53_change_tags_for_resource(
ResourceType,
ResourceId,
AddTags = NULL,
RemoveTagKeys = NULL
)
Arguments
ResourceType |
[required] The type of the resource.
|
ResourceId |
[required] The ID of the resource for which you want to add, change, or delete tags. |
AddTags |
A complex type that contains a list of the tags that you want to add to
the specified health check or hosted zone and/or the tags that you want
to edit You can add a maximum of 10 tags to a health check or a hosted zone. |
RemoveTagKeys |
A complex type that contains a list of the tags that you want to delete from the specified health check or hosted zone. You can specify up to 10 keys. |
Creates a CIDR collection in the current Amazon Web Services account
Description
Creates a CIDR collection in the current Amazon Web Services account.
See https://www.paws-r-sdk.com/docs/route53_create_cidr_collection/ for full documentation.
Usage
route53_create_cidr_collection(Name, CallerReference)
Arguments
Name |
[required] A unique identifier for the account that can be used to reference the collection from other API calls. |
CallerReference |
[required] A client-specific token that allows requests to be securely retried so that the intended outcome will only occur once, retries receive a similar response, and there are no additional edge cases to handle. |
Creates a new health check
Description
Creates a new health check.
See https://www.paws-r-sdk.com/docs/route53_create_health_check/ for full documentation.
Usage
route53_create_health_check(CallerReference, HealthCheckConfig)
Arguments
CallerReference |
[required] A unique string that identifies the request and that allows you to retry
a failed
Route 53 does not store the |
HealthCheckConfig |
[required] A complex type that contains settings for a new health check. |
Creates a new public or private hosted zone
Description
Creates a new public or private hosted zone. You create records in a public hosted zone to define how you want to route traffic on the internet for a domain, such as example.com, and its subdomains (apex.example.com, acme.example.com). You create records in a private hosted zone to define how you want to route traffic for a domain and its subdomains within one or more Amazon Virtual Private Clouds (Amazon VPCs).
See https://www.paws-r-sdk.com/docs/route53_create_hosted_zone/ for full documentation.
Usage
route53_create_hosted_zone(
Name,
VPC = NULL,
CallerReference,
HostedZoneConfig = NULL,
DelegationSetId = NULL
)
Arguments
Name |
[required] The name of the domain. Specify a fully qualified domain name, for example, www.example.com. The trailing dot is optional; Amazon Route 53 assumes that the domain name is fully qualified. This means that Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical. If you're creating a public hosted zone, this is the name you have
registered with your DNS registrar. If your domain name is registered
with a registrar other than Route 53, change the name servers for your
domain to the set of |
VPC |
(Private hosted zones only) A complex type that contains information about the Amazon VPC that you're associating with this hosted zone. You can specify only one Amazon VPC when you create a private hosted
zone. If you are associating a VPC with a hosted zone with this request,
the paramaters To associate additional Amazon VPCs with the hosted zone, use
|
CallerReference |
[required] A unique string that identifies the request and that allows failed
|
HostedZoneConfig |
(Optional) A complex type that contains the following optional values:
If you don't specify a comment or the |
DelegationSetId |
If you want to associate a reusable delegation set with this hosted
zone, the ID that Amazon Route 53 assigned to the reusable delegation
set when you created it. For more information about reusable delegation
sets, see
If you are using a reusable delegation set to create a public hosted
zone for a subdomain, make sure that the parent hosted zone doesn't use
one or more of the same name servers. If you have overlapping
nameservers, the operation will cause a |
Creates a new key-signing key (KSK) associated with a hosted zone
Description
Creates a new key-signing key (KSK) associated with a hosted zone. You can only have two KSKs per hosted zone.
See https://www.paws-r-sdk.com/docs/route53_create_key_signing_key/ for full documentation.
Usage
route53_create_key_signing_key(
CallerReference,
HostedZoneId,
KeyManagementServiceArn,
Name,
Status
)
Arguments
CallerReference |
[required] A unique string that identifies the request. |
HostedZoneId |
[required] The unique string (ID) used to identify a hosted zone. |
KeyManagementServiceArn |
[required] The Amazon resource name (ARN) for a customer managed key in Key
Management Service (KMS). The You must configure the customer managed customer managed key as follows: Status Enabled Key spec ECC_NIST_P256 Key usage Sign and verify Key policy The key policy must give permission for the following actions:
The key policy must also include the Amazon Route 53 service in the principal for your account. Specify the following:
For more information about working with a customer managed key in KMS, see Key Management Service concepts. |
Name |
[required] A string used to identify a key-signing key (KSK). |
Status |
[required] A string specifying the initial status of the key-signing key (KSK). You
can set the value to |
Creates a configuration for DNS query logging
Description
Creates a configuration for DNS query logging. After you create a query logging configuration, Amazon Route 53 begins to publish log data to an Amazon CloudWatch Logs log group.
See https://www.paws-r-sdk.com/docs/route53_create_query_logging_config/ for full documentation.
Usage
route53_create_query_logging_config(HostedZoneId, CloudWatchLogsLogGroupArn)
Arguments
HostedZoneId |
[required] The ID of the hosted zone that you want to log queries for. You can log queries only for public hosted zones. |
CloudWatchLogsLogGroupArn |
[required] The Amazon Resource Name (ARN) for the log group that you want to Amazon Route 53 to send query logs to. This is the format of the ARN: arn:aws:logs:region:account-id:log-group:log_group_name To get the ARN for a log group, you can use the CloudWatch console, the DescribeLogGroups API action, the describe-log-groups command, or the applicable command in one of the Amazon Web Services SDKs. |
Creates a delegation set (a group of four name servers) that can be reused by multiple hosted zones that were created by the same Amazon Web Services account
Description
Creates a delegation set (a group of four name servers) that can be reused by multiple hosted zones that were created by the same Amazon Web Services account.
See https://www.paws-r-sdk.com/docs/route53_create_reusable_delegation_set/ for full documentation.
Usage
route53_create_reusable_delegation_set(CallerReference, HostedZoneId = NULL)
Arguments
CallerReference |
[required] A unique string that identifies the request, and that allows you to
retry failed
|
HostedZoneId |
If you want to mark the delegation set for an existing hosted zone as reusable, the ID for that hosted zone. |
Creates a traffic policy, which you use to create multiple DNS resource record sets for one domain name (such as example
Description
Creates a traffic policy, which you use to create multiple DNS resource record sets for one domain name (such as example.com) or one subdomain name (such as www.example.com).
See https://www.paws-r-sdk.com/docs/route53_create_traffic_policy/ for full documentation.
Usage
route53_create_traffic_policy(Name, Document, Comment = NULL)
Arguments
Name |
[required] The name of the traffic policy. |
Document |
[required] The definition of this traffic policy in JSON format. For more information, see Traffic Policy Document Format. |
Comment |
(Optional) Any comments that you want to include about the traffic policy. |
Creates resource record sets in a specified hosted zone based on the settings in a specified traffic policy version
Description
Creates resource record sets in a specified hosted zone based on the settings in a specified traffic policy version. In addition, create_traffic_policy_instance
associates the resource record sets with a specified domain name (such as example.com) or subdomain name (such as www.example.com). Amazon Route 53 responds to DNS queries for the domain or subdomain name by using the resource record sets that create_traffic_policy_instance
created.
See https://www.paws-r-sdk.com/docs/route53_create_traffic_policy_instance/ for full documentation.
Usage
route53_create_traffic_policy_instance(
HostedZoneId,
Name,
TTL,
TrafficPolicyId,
TrafficPolicyVersion
)
Arguments
HostedZoneId |
[required] The ID of the hosted zone that you want Amazon Route 53 to create resource record sets in by using the configuration in a traffic policy. |
Name |
[required] The domain name (such as example.com) or subdomain name (such as www.example.com) for which Amazon Route 53 responds to DNS queries by using the resource record sets that Route 53 creates for this traffic policy instance. |
TTL |
[required] (Optional) The TTL that you want Amazon Route 53 to assign to all of the resource record sets that it creates in the specified hosted zone. |
TrafficPolicyId |
[required] The ID of the traffic policy that you want to use to create resource record sets in the specified hosted zone. |
TrafficPolicyVersion |
[required] The version of the traffic policy that you want to use to create resource record sets in the specified hosted zone. |
Creates a new version of an existing traffic policy
Description
Creates a new version of an existing traffic policy. When you create a new version of a traffic policy, you specify the ID of the traffic policy that you want to update and a JSON-formatted document that describes the new version. You use traffic policies to create multiple DNS resource record sets for one domain name (such as example.com) or one subdomain name (such as www.example.com). You can create a maximum of 1000 versions of a traffic policy. If you reach the limit and need to create another version, you'll need to start a new traffic policy.
See https://www.paws-r-sdk.com/docs/route53_create_traffic_policy_version/ for full documentation.
Usage
route53_create_traffic_policy_version(Id, Document, Comment = NULL)
Arguments
Id |
[required] The ID of the traffic policy for which you want to create a new version. |
Document |
[required] The definition of this version of the traffic policy, in JSON format.
You specified the JSON in the
|
Comment |
The comment that you specified in the
|
Authorizes the Amazon Web Services account that created a specified VPC to submit an AssociateVPCWithHostedZone request to associate the VPC with a specified hosted zone that was created by a different account
Description
Authorizes the Amazon Web Services account that created a specified VPC to submit an associate_vpc_with_hosted_zone
request to associate the VPC with a specified hosted zone that was created by a different account. To submit a create_vpc_association_authorization
request, you must use the account that created the hosted zone. After you authorize the association, use the account that created the VPC to submit an associate_vpc_with_hosted_zone
request.
See https://www.paws-r-sdk.com/docs/route53_create_vpc_association_authorization/ for full documentation.
Usage
route53_create_vpc_association_authorization(HostedZoneId, VPC)
Arguments
HostedZoneId |
[required] The ID of the private hosted zone that you want to authorize associating a VPC with. |
VPC |
[required] A complex type that contains the VPC ID and region for the VPC that you want to authorize associating with your hosted zone. |
Deactivates a key-signing key (KSK) so that it will not be used for signing by DNSSEC
Description
Deactivates a key-signing key (KSK) so that it will not be used for signing by DNSSEC. This operation changes the KSK status to INACTIVE
.
See https://www.paws-r-sdk.com/docs/route53_deactivate_key_signing_key/ for full documentation.
Usage
route53_deactivate_key_signing_key(HostedZoneId, Name)
Arguments
HostedZoneId |
[required] A unique string used to identify a hosted zone. |
Name |
[required] A string used to identify a key-signing key (KSK). |
Deletes a CIDR collection in the current Amazon Web Services account
Description
Deletes a CIDR collection in the current Amazon Web Services account. The collection must be empty before it can be deleted.
See https://www.paws-r-sdk.com/docs/route53_delete_cidr_collection/ for full documentation.
Usage
route53_delete_cidr_collection(Id)
Arguments
Id |
[required] The UUID of the collection to delete. |
Deletes a health check
Description
Deletes a health check.
See https://www.paws-r-sdk.com/docs/route53_delete_health_check/ for full documentation.
Usage
route53_delete_health_check(HealthCheckId)
Arguments
HealthCheckId |
[required] The ID of the health check that you want to delete. |
Deletes a hosted zone
Description
Deletes a hosted zone.
See https://www.paws-r-sdk.com/docs/route53_delete_hosted_zone/ for full documentation.
Usage
route53_delete_hosted_zone(Id)
Arguments
Id |
[required] The ID of the hosted zone you want to delete. |
Deletes a key-signing key (KSK)
Description
Deletes a key-signing key (KSK). Before you can delete a KSK, you must deactivate it. The KSK must be deactivated before you can delete it regardless of whether the hosted zone is enabled for DNSSEC signing.
See https://www.paws-r-sdk.com/docs/route53_delete_key_signing_key/ for full documentation.
Usage
route53_delete_key_signing_key(HostedZoneId, Name)
Arguments
HostedZoneId |
[required] A unique string used to identify a hosted zone. |
Name |
[required] A string used to identify a key-signing key (KSK). |
Deletes a configuration for DNS query logging
Description
Deletes a configuration for DNS query logging. If you delete a configuration, Amazon Route 53 stops sending query logs to CloudWatch Logs. Route 53 doesn't delete any logs that are already in CloudWatch Logs.
See https://www.paws-r-sdk.com/docs/route53_delete_query_logging_config/ for full documentation.
Usage
route53_delete_query_logging_config(Id)
Arguments
Id |
[required] The ID of the configuration that you want to delete. |
Deletes a reusable delegation set
Description
Deletes a reusable delegation set.
See https://www.paws-r-sdk.com/docs/route53_delete_reusable_delegation_set/ for full documentation.
Usage
route53_delete_reusable_delegation_set(Id)
Arguments
Id |
[required] The ID of the reusable delegation set that you want to delete. |
Deletes a traffic policy
Description
Deletes a traffic policy.
See https://www.paws-r-sdk.com/docs/route53_delete_traffic_policy/ for full documentation.
Usage
route53_delete_traffic_policy(Id, Version)
Arguments
Id |
[required] The ID of the traffic policy that you want to delete. |
Version |
[required] The version number of the traffic policy that you want to delete. |
Deletes a traffic policy instance and all of the resource record sets that Amazon Route 53 created when you created the instance
Description
Deletes a traffic policy instance and all of the resource record sets that Amazon Route 53 created when you created the instance.
See https://www.paws-r-sdk.com/docs/route53_delete_traffic_policy_instance/ for full documentation.
Usage
route53_delete_traffic_policy_instance(Id)
Arguments
Id |
[required] The ID of the traffic policy instance that you want to delete. When you delete a traffic policy instance, Amazon Route 53 also deletes all of the resource record sets that were created when you created the traffic policy instance. |
Removes authorization to submit an AssociateVPCWithHostedZone request to associate a specified VPC with a hosted zone that was created by a different account
Description
Removes authorization to submit an associate_vpc_with_hosted_zone
request to associate a specified VPC with a hosted zone that was created by a different account. You must use the account that created the hosted zone to submit a delete_vpc_association_authorization
request.
See https://www.paws-r-sdk.com/docs/route53_delete_vpc_association_authorization/ for full documentation.
Usage
route53_delete_vpc_association_authorization(HostedZoneId, VPC)
Arguments
HostedZoneId |
[required] When removing authorization to associate a VPC that was created by one Amazon Web Services account with a hosted zone that was created with a different Amazon Web Services account, the ID of the hosted zone. |
VPC |
[required] When removing authorization to associate a VPC that was created by one Amazon Web Services account with a hosted zone that was created with a different Amazon Web Services account, a complex type that includes the ID and region of the VPC. |
Disables DNSSEC signing in a specific hosted zone
Description
Disables DNSSEC signing in a specific hosted zone. This action does not deactivate any key-signing keys (KSKs) that are active in the hosted zone.
See https://www.paws-r-sdk.com/docs/route53_disable_hosted_zone_dnssec/ for full documentation.
Usage
route53_disable_hosted_zone_dnssec(HostedZoneId)
Arguments
HostedZoneId |
[required] A unique string used to identify a hosted zone. |
Disassociates an Amazon Virtual Private Cloud (Amazon VPC) from an Amazon Route 53 private hosted zone
Description
Disassociates an Amazon Virtual Private Cloud (Amazon VPC) from an Amazon Route 53 private hosted zone. Note the following:
See https://www.paws-r-sdk.com/docs/route53_disassociate_vpc_from_hosted_zone/ for full documentation.
Usage
route53_disassociate_vpc_from_hosted_zone(HostedZoneId, VPC, Comment = NULL)
Arguments
HostedZoneId |
[required] The ID of the private hosted zone that you want to disassociate a VPC from. |
VPC |
[required] A complex type that contains information about the VPC that you're disassociating from the specified hosted zone. |
Comment |
Optional: A comment about the disassociation request. |
Enables DNSSEC signing in a specific hosted zone
Description
Enables DNSSEC signing in a specific hosted zone.
See https://www.paws-r-sdk.com/docs/route53_enable_hosted_zone_dnssec/ for full documentation.
Usage
route53_enable_hosted_zone_dnssec(HostedZoneId)
Arguments
HostedZoneId |
[required] A unique string used to identify a hosted zone. |
Gets the specified limit for the current account, for example, the maximum number of health checks that you can create using the account
Description
Gets the specified limit for the current account, for example, the maximum number of health checks that you can create using the account.
See https://www.paws-r-sdk.com/docs/route53_get_account_limit/ for full documentation.
Usage
route53_get_account_limit(Type)
Arguments
Type |
[required] The limit that you want to get. Valid values include the following:
|
Returns the current status of a change batch request
Description
Returns the current status of a change batch request. The status is one of the following values:
See https://www.paws-r-sdk.com/docs/route53_get_change/ for full documentation.
Usage
route53_get_change(Id)
Arguments
Id |
[required] The ID of the change batch request. The value that you specify here is
the value that
|
Route 53 does not perform authorization for this API because it retrieves information that is already available to the public
Description
Route 53 does not perform authorization for this API because it retrieves information that is already available to the public.
See https://www.paws-r-sdk.com/docs/route53_get_checker_ip_ranges/ for full documentation.
Usage
route53_get_checker_ip_ranges()
Returns information about DNSSEC for a specific hosted zone, including the key-signing keys (KSKs) in the hosted zone
Description
Returns information about DNSSEC for a specific hosted zone, including the key-signing keys (KSKs) in the hosted zone.
See https://www.paws-r-sdk.com/docs/route53_get_dnssec/ for full documentation.
Usage
route53_get_dnssec(HostedZoneId)
Arguments
HostedZoneId |
[required] A unique string used to identify a hosted zone. |
Gets information about whether a specified geographic location is supported for Amazon Route 53 geolocation resource record sets
Description
Gets information about whether a specified geographic location is supported for Amazon Route 53 geolocation resource record sets.
See https://www.paws-r-sdk.com/docs/route53_get_geo_location/ for full documentation.
Usage
route53_get_geo_location(
ContinentCode = NULL,
CountryCode = NULL,
SubdivisionCode = NULL
)
Arguments
ContinentCode |
For geolocation resource record sets, a two-letter abbreviation that identifies a continent. Amazon Route 53 supports the following continent codes:
|
CountryCode |
Amazon Route 53 uses the two-letter country codes that are specified in ISO standard 3166-1 alpha-2. Route 53 also supports the country code UA for Ukraine. |
SubdivisionCode |
The code for the subdivision, such as a particular state within the
United States. For a list of US state abbreviations, see Appendix B:
Two–Letter State and Possession Abbreviations on the United States
Postal Service website. For a list of all supported subdivision codes,
use the |
Gets information about a specified health check
Description
Gets information about a specified health check.
See https://www.paws-r-sdk.com/docs/route53_get_health_check/ for full documentation.
Usage
route53_get_health_check(HealthCheckId)
Arguments
HealthCheckId |
[required] The identifier that Amazon Route 53 assigned to the health check when you created it. When you add or update a resource record set, you use this value to specify which health check to use. The value can be up to 64 characters long. |
Retrieves the number of health checks that are associated with the current Amazon Web Services account
Description
Retrieves the number of health checks that are associated with the current Amazon Web Services account.
See https://www.paws-r-sdk.com/docs/route53_get_health_check_count/ for full documentation.
Usage
route53_get_health_check_count()
Gets the reason that a specified health check failed most recently
Description
Gets the reason that a specified health check failed most recently.
See https://www.paws-r-sdk.com/docs/route53_get_health_check_last_failure_reason/ for full documentation.
Usage
route53_get_health_check_last_failure_reason(HealthCheckId)
Arguments
HealthCheckId |
[required] The ID for the health check for which you want the last failure reason.
When you created the health check,
If you want to get the last failure reason for a calculated health
check, you must use the Amazon Route 53 console or the CloudWatch
console. You can't use
|
Gets status of a specified health check
Description
Gets status of a specified health check.
See https://www.paws-r-sdk.com/docs/route53_get_health_check_status/ for full documentation.
Usage
route53_get_health_check_status(HealthCheckId)
Arguments
HealthCheckId |
[required] The ID for the health check that you want the current status for. When
you created the health check,
If you want to check the status of a calculated health check, you must
use the Amazon Route 53 console or the CloudWatch console. You can't use
|
Gets information about a specified hosted zone including the four name servers assigned to the hosted zone
Description
Gets information about a specified hosted zone including the four name servers assigned to the hosted zone.
See https://www.paws-r-sdk.com/docs/route53_get_hosted_zone/ for full documentation.
Usage
route53_get_hosted_zone(Id)
Arguments
Id |
[required] The ID of the hosted zone that you want to get information about. |
Retrieves the number of hosted zones that are associated with the current Amazon Web Services account
Description
Retrieves the number of hosted zones that are associated with the current Amazon Web Services account.
See https://www.paws-r-sdk.com/docs/route53_get_hosted_zone_count/ for full documentation.
Usage
route53_get_hosted_zone_count()
Gets the specified limit for a specified hosted zone, for example, the maximum number of records that you can create in the hosted zone
Description
Gets the specified limit for a specified hosted zone, for example, the maximum number of records that you can create in the hosted zone.
See https://www.paws-r-sdk.com/docs/route53_get_hosted_zone_limit/ for full documentation.
Usage
route53_get_hosted_zone_limit(Type, HostedZoneId)
Arguments
Type |
[required] The limit that you want to get. Valid values include the following:
|
HostedZoneId |
[required] The ID of the hosted zone that you want to get a limit for. |
Gets information about a specified configuration for DNS query logging
Description
Gets information about a specified configuration for DNS query logging.
See https://www.paws-r-sdk.com/docs/route53_get_query_logging_config/ for full documentation.
Usage
route53_get_query_logging_config(Id)
Arguments
Id |
[required] The ID of the configuration for DNS query logging that you want to get information about. |
Retrieves information about a specified reusable delegation set, including the four name servers that are assigned to the delegation set
Description
Retrieves information about a specified reusable delegation set, including the four name servers that are assigned to the delegation set.
See https://www.paws-r-sdk.com/docs/route53_get_reusable_delegation_set/ for full documentation.
Usage
route53_get_reusable_delegation_set(Id)
Arguments
Id |
[required] The ID of the reusable delegation set that you want to get a list of name servers for. |
Gets the maximum number of hosted zones that you can associate with the specified reusable delegation set
Description
Gets the maximum number of hosted zones that you can associate with the specified reusable delegation set.
See https://www.paws-r-sdk.com/docs/route53_get_reusable_delegation_set_limit/ for full documentation.
Usage
route53_get_reusable_delegation_set_limit(Type, DelegationSetId)
Arguments
Type |
[required] Specify |
DelegationSetId |
[required] The ID of the delegation set that you want to get the limit for. |
Gets information about a specific traffic policy version
Description
Gets information about a specific traffic policy version.
See https://www.paws-r-sdk.com/docs/route53_get_traffic_policy/ for full documentation.
Usage
route53_get_traffic_policy(Id, Version)
Arguments
Id |
[required] The ID of the traffic policy that you want to get information about. |
Version |
[required] The version number of the traffic policy that you want to get information about. |
Gets information about a specified traffic policy instance
Description
Gets information about a specified traffic policy instance.
See https://www.paws-r-sdk.com/docs/route53_get_traffic_policy_instance/ for full documentation.
Usage
route53_get_traffic_policy_instance(Id)
Arguments
Id |
[required] The ID of the traffic policy instance that you want to get information about. |
Gets the number of traffic policy instances that are associated with the current Amazon Web Services account
Description
Gets the number of traffic policy instances that are associated with the current Amazon Web Services account.
See https://www.paws-r-sdk.com/docs/route53_get_traffic_policy_instance_count/ for full documentation.
Usage
route53_get_traffic_policy_instance_count()
Returns a paginated list of location objects and their CIDR blocks
Description
Returns a paginated list of location objects and their CIDR blocks.
See https://www.paws-r-sdk.com/docs/route53_list_cidr_blocks/ for full documentation.
Usage
route53_list_cidr_blocks(
CollectionId,
LocationName = NULL,
NextToken = NULL,
MaxResults = NULL
)
Arguments
CollectionId |
[required] The UUID of the CIDR collection. |
LocationName |
The name of the CIDR collection location. |
NextToken |
An opaque pagination token to indicate where the service is to begin enumerating results. |
MaxResults |
Maximum number of results you want returned. |
Returns a paginated list of CIDR collections in the Amazon Web Services account (metadata only)
Description
Returns a paginated list of CIDR collections in the Amazon Web Services account (metadata only).
See https://www.paws-r-sdk.com/docs/route53_list_cidr_collections/ for full documentation.
Usage
route53_list_cidr_collections(NextToken = NULL, MaxResults = NULL)
Arguments
NextToken |
An opaque pagination token to indicate where the service is to begin enumerating results. If no value is provided, the listing of results starts from the beginning. |
MaxResults |
The maximum number of CIDR collections to return in the response. |
Returns a paginated list of CIDR locations for the given collection (metadata only, does not include CIDR blocks)
Description
Returns a paginated list of CIDR locations for the given collection (metadata only, does not include CIDR blocks).
See https://www.paws-r-sdk.com/docs/route53_list_cidr_locations/ for full documentation.
Usage
route53_list_cidr_locations(CollectionId, NextToken = NULL, MaxResults = NULL)
Arguments
CollectionId |
[required] The CIDR collection ID. |
NextToken |
An opaque pagination token to indicate where the service is to begin enumerating results. If no value is provided, the listing of results starts from the beginning. |
MaxResults |
The maximum number of CIDR collection locations to return in the response. |
Retrieves a list of supported geographic locations
Description
Retrieves a list of supported geographic locations.
See https://www.paws-r-sdk.com/docs/route53_list_geo_locations/ for full documentation.
Usage
route53_list_geo_locations(
StartContinentCode = NULL,
StartCountryCode = NULL,
StartSubdivisionCode = NULL,
MaxItems = NULL
)
Arguments
StartContinentCode |
The code for the continent with which you want to start listing
locations that Amazon Route 53 supports for geolocation. If Route 53 has
already returned a page or more of results, if Include |
StartCountryCode |
The code for the country with which you want to start listing locations
that Amazon Route 53 supports for geolocation. If Route 53 has already
returned a page or more of results, if |
StartSubdivisionCode |
The code for the state of the United States with which you want to start
listing locations that Amazon Route 53 supports for geolocation. If
Route 53 has already returned a page or more of results, if
To list subdivisions (U.S. states), you must include both
|
MaxItems |
(Optional) The maximum number of geolocations to be included in the
response body for this request. If more than |
Retrieve a list of the health checks that are associated with the current Amazon Web Services account
Description
Retrieve a list of the health checks that are associated with the current Amazon Web Services account.
See https://www.paws-r-sdk.com/docs/route53_list_health_checks/ for full documentation.
Usage
route53_list_health_checks(Marker = NULL, MaxItems = NULL)
Arguments
Marker |
If the value of For the value of If the value of |
MaxItems |
The maximum number of health checks that you want
|
Retrieves a list of the public and private hosted zones that are associated with the current Amazon Web Services account
Description
Retrieves a list of the public and private hosted zones that are associated with the current Amazon Web Services account. The response includes a HostedZones
child element for each hosted zone.
See https://www.paws-r-sdk.com/docs/route53_list_hosted_zones/ for full documentation.
Usage
route53_list_hosted_zones(
Marker = NULL,
MaxItems = NULL,
DelegationSetId = NULL,
HostedZoneType = NULL
)
Arguments
Marker |
If the value of For the value of If the value of |
MaxItems |
(Optional) The maximum number of hosted zones that you want Amazon Route
53 to return. If you have more than |
DelegationSetId |
If you're using reusable delegation sets and you want to list all of the hosted zones that are associated with a reusable delegation set, specify the ID of that reusable delegation set. |
HostedZoneType |
(Optional) Specifies if the hosted zone is private. |
Retrieves a list of your hosted zones in lexicographic order
Description
Retrieves a list of your hosted zones in lexicographic order. The response includes a HostedZones
child element for each hosted zone created by the current Amazon Web Services account.
See https://www.paws-r-sdk.com/docs/route53_list_hosted_zones_by_name/ for full documentation.
Usage
route53_list_hosted_zones_by_name(
DNSName = NULL,
HostedZoneId = NULL,
MaxItems = NULL
)
Arguments
DNSName |
(Optional) For your first request to
|
HostedZoneId |
(Optional) For your first request to
If you have more hosted zones than the value of |
MaxItems |
The maximum number of hosted zones to be included in the response body
for this request. If you have more than |
Lists all the private hosted zones that a specified VPC is associated with, regardless of which Amazon Web Services account or Amazon Web Services service owns the hosted zones
Description
Lists all the private hosted zones that a specified VPC is associated with, regardless of which Amazon Web Services account or Amazon Web Services service owns the hosted zones. The HostedZoneOwner
structure in the response contains one of the following values:
See https://www.paws-r-sdk.com/docs/route53_list_hosted_zones_by_vpc/ for full documentation.
Usage
route53_list_hosted_zones_by_vpc(
VPCId,
VPCRegion,
MaxItems = NULL,
NextToken = NULL
)
Arguments
VPCId |
[required] The ID of the Amazon VPC that you want to list hosted zones for. |
VPCRegion |
[required] For the Amazon VPC that you specified for |
MaxItems |
(Optional) The maximum number of hosted zones that you want Amazon Route
53 to return. If the specified VPC is associated with more than
|
NextToken |
If the previous response included a For the value of If the previous response didn't include a |
Lists the configurations for DNS query logging that are associated with the current Amazon Web Services account or the configuration that is associated with a specified hosted zone
Description
Lists the configurations for DNS query logging that are associated with the current Amazon Web Services account or the configuration that is associated with a specified hosted zone.
See https://www.paws-r-sdk.com/docs/route53_list_query_logging_configs/ for full documentation.
Usage
route53_list_query_logging_configs(
HostedZoneId = NULL,
NextToken = NULL,
MaxResults = NULL
)
Arguments
HostedZoneId |
(Optional) If you want to list the query logging configuration that is
associated with a hosted zone, specify the ID in If you don't specify a hosted zone ID,
|
NextToken |
(Optional) If the current Amazon Web Services account has more than
For the first
For the second and subsequent requests, get the value of |
MaxResults |
(Optional) The maximum number of query logging configurations that you
want Amazon Route 53 to return in response to the current request. If
the current Amazon Web Services account has more than If you don't specify a value for |
Lists the resource record sets in a specified hosted zone
Description
Lists the resource record sets in a specified hosted zone.
See https://www.paws-r-sdk.com/docs/route53_list_resource_record_sets/ for full documentation.
Usage
route53_list_resource_record_sets(
HostedZoneId,
StartRecordName = NULL,
StartRecordType = NULL,
StartRecordIdentifier = NULL,
MaxItems = NULL
)
Arguments
HostedZoneId |
[required] The ID of the hosted zone that contains the resource record sets that you want to list. |
StartRecordName |
The first name in the lexicographic ordering of resource record sets
that you want to list. If the specified record name doesn't exist, the
results begin with the first resource record set that has a name greater
than the value of |
StartRecordType |
The type of resource record set to begin the record listing from. Valid values for basic resource record sets: Values for weighted, latency, geolocation, and failover resource record
sets: Values for alias resource record sets:
Constraint: Specifying |
StartRecordIdentifier |
Resource record sets that have a routing policy other than simple: If
results were truncated for a given DNS name and type, specify the value
of |
MaxItems |
(Optional) The maximum number of resource records sets to include in the
response body for this request. If the response includes more than
|
Retrieves a list of the reusable delegation sets that are associated with the current Amazon Web Services account
Description
Retrieves a list of the reusable delegation sets that are associated with the current Amazon Web Services account.
See https://www.paws-r-sdk.com/docs/route53_list_reusable_delegation_sets/ for full documentation.
Usage
route53_list_reusable_delegation_sets(Marker = NULL, MaxItems = NULL)
Arguments
Marker |
If the value of For the value of If the value of |
MaxItems |
The number of reusable delegation sets that you want Amazon Route 53 to return in the response to this request. If you specify a value greater than 100, Route 53 returns only the first 100 reusable delegation sets. |
Lists tags for one health check or hosted zone
Description
Lists tags for one health check or hosted zone.
See https://www.paws-r-sdk.com/docs/route53_list_tags_for_resource/ for full documentation.
Usage
route53_list_tags_for_resource(ResourceType, ResourceId)
Arguments
ResourceType |
[required] The type of the resource.
|
ResourceId |
[required] The ID of the resource for which you want to retrieve tags. |
Lists tags for up to 10 health checks or hosted zones
Description
Lists tags for up to 10 health checks or hosted zones.
See https://www.paws-r-sdk.com/docs/route53_list_tags_for_resources/ for full documentation.
Usage
route53_list_tags_for_resources(ResourceType, ResourceIds)
Arguments
ResourceType |
[required] The type of the resources.
|
ResourceIds |
[required] A complex type that contains the ResourceId element for each resource for which you want to get a list of tags. |
Gets information about the latest version for every traffic policy that is associated with the current Amazon Web Services account
Description
Gets information about the latest version for every traffic policy that is associated with the current Amazon Web Services account. Policies are listed in the order that they were created in.
See https://www.paws-r-sdk.com/docs/route53_list_traffic_policies/ for full documentation.
Usage
route53_list_traffic_policies(TrafficPolicyIdMarker = NULL, MaxItems = NULL)
Arguments
TrafficPolicyIdMarker |
(Conditional) For your first request to
If you have more traffic policies than the value of |
MaxItems |
(Optional) The maximum number of traffic policies that you want Amazon
Route 53 to return in response to this request. If you have more than
|
Gets information about the traffic policy instances that you created by using the current Amazon Web Services account
Description
Gets information about the traffic policy instances that you created by using the current Amazon Web Services account.
See https://www.paws-r-sdk.com/docs/route53_list_traffic_policy_instances/ for full documentation.
Usage
route53_list_traffic_policy_instances(
HostedZoneIdMarker = NULL,
TrafficPolicyInstanceNameMarker = NULL,
TrafficPolicyInstanceTypeMarker = NULL,
MaxItems = NULL
)
Arguments
HostedZoneIdMarker |
If the value of If the value of |
TrafficPolicyInstanceNameMarker |
If the value of If the value of |
TrafficPolicyInstanceTypeMarker |
If the value of If the value of |
MaxItems |
The maximum number of traffic policy instances that you want Amazon
Route 53 to return in response to a
|
Gets information about the traffic policy instances that you created in a specified hosted zone
Description
Gets information about the traffic policy instances that you created in a specified hosted zone.
See https://www.paws-r-sdk.com/docs/route53_list_traffic_policy_instances_by_hosted_zone/ for full documentation.
Usage
route53_list_traffic_policy_instances_by_hosted_zone(
HostedZoneId,
TrafficPolicyInstanceNameMarker = NULL,
TrafficPolicyInstanceTypeMarker = NULL,
MaxItems = NULL
)
Arguments
HostedZoneId |
[required] The ID of the hosted zone that you want to list traffic policy instances for. |
TrafficPolicyInstanceNameMarker |
If the value of If the value of |
TrafficPolicyInstanceTypeMarker |
If the value of If the value of |
MaxItems |
The maximum number of traffic policy instances to be included in the
response body for this request. If you have more than |
Gets information about the traffic policy instances that you created by using a specify traffic policy version
Description
Gets information about the traffic policy instances that you created by using a specify traffic policy version.
See https://www.paws-r-sdk.com/docs/route53_list_traffic_policy_instances_by_policy/ for full documentation.
Usage
route53_list_traffic_policy_instances_by_policy(
TrafficPolicyId,
TrafficPolicyVersion,
HostedZoneIdMarker = NULL,
TrafficPolicyInstanceNameMarker = NULL,
TrafficPolicyInstanceTypeMarker = NULL,
MaxItems = NULL
)
Arguments
TrafficPolicyId |
[required] The ID of the traffic policy for which you want to list traffic policy instances. |
TrafficPolicyVersion |
[required] The version of the traffic policy for which you want to list traffic
policy instances. The version must be associated with the traffic policy
that is specified by |
HostedZoneIdMarker |
If the value of For the value of If the value of |
TrafficPolicyInstanceNameMarker |
If the value of For the value of If the value of |
TrafficPolicyInstanceTypeMarker |
If the value of For the value of If the value of |
MaxItems |
The maximum number of traffic policy instances to be included in the
response body for this request. If you have more than |
Gets information about all of the versions for a specified traffic policy
Description
Gets information about all of the versions for a specified traffic policy.
See https://www.paws-r-sdk.com/docs/route53_list_traffic_policy_versions/ for full documentation.
Usage
route53_list_traffic_policy_versions(
Id,
TrafficPolicyVersionMarker = NULL,
MaxItems = NULL
)
Arguments
Id |
[required] Specify the value of |
TrafficPolicyVersionMarker |
For your first request to
If you have more traffic policy versions than the value of |
MaxItems |
The maximum number of traffic policy versions that you want Amazon Route
53 to include in the response body for this request. If the specified
traffic policy has more than |
Gets a list of the VPCs that were created by other accounts and that can be associated with a specified hosted zone because you've submitted one or more CreateVPCAssociationAuthorization requests
Description
Gets a list of the VPCs that were created by other accounts and that can be associated with a specified hosted zone because you've submitted one or more create_vpc_association_authorization
requests.
See https://www.paws-r-sdk.com/docs/route53_list_vpc_association_authorizations/ for full documentation.
Usage
route53_list_vpc_association_authorizations(
HostedZoneId,
NextToken = NULL,
MaxResults = NULL
)
Arguments
HostedZoneId |
[required] The ID of the hosted zone for which you want a list of VPCs that can be associated with the hosted zone. |
NextToken |
Optional: If a response includes a |
MaxResults |
Optional: An integer that specifies the maximum number of VPCs that
you want Amazon Route 53 to return. If you don't specify a value for
|
Gets the value that Amazon Route 53 returns in response to a DNS request for a specified record name and type
Description
Gets the value that Amazon Route 53 returns in response to a DNS request for a specified record name and type. You can optionally specify the IP address of a DNS resolver, an EDNS0 client subnet IP address, and a subnet mask.
See https://www.paws-r-sdk.com/docs/route53_test_dns_answer/ for full documentation.
Usage
route53_test_dns_answer(
HostedZoneId,
RecordName,
RecordType,
ResolverIP = NULL,
EDNS0ClientSubnetIP = NULL,
EDNS0ClientSubnetMask = NULL
)
Arguments
HostedZoneId |
[required] The ID of the hosted zone that you want Amazon Route 53 to simulate a query for. |
RecordName |
[required] The name of the resource record set that you want Amazon Route 53 to simulate a query for. |
RecordType |
[required] The type of the resource record set. |
ResolverIP |
If you want to simulate a request from a specific DNS resolver, specify
the IP address for that resolver. If you omit this value,
|
EDNS0ClientSubnetIP |
If the resolver that you specified for resolverip supports EDNS0,
specify the IPv4 or IPv6 address of a client in the applicable location,
for example, |
EDNS0ClientSubnetMask |
If you specify an IP address for The range of valid values depends on whether
|
Updates an existing health check
Description
Updates an existing health check. Note that some values can't be updated.
See https://www.paws-r-sdk.com/docs/route53_update_health_check/ for full documentation.
Usage
route53_update_health_check(
HealthCheckId,
HealthCheckVersion = NULL,
IPAddress = NULL,
Port = NULL,
ResourcePath = NULL,
FullyQualifiedDomainName = NULL,
SearchString = NULL,
FailureThreshold = NULL,
Inverted = NULL,
Disabled = NULL,
HealthThreshold = NULL,
ChildHealthChecks = NULL,
EnableSNI = NULL,
Regions = NULL,
AlarmIdentifier = NULL,
InsufficientDataHealthStatus = NULL,
ResetElements = NULL
)
Arguments
HealthCheckId |
[required] The ID for the health check for which you want detailed information.
When you created the health check,
|
HealthCheckVersion |
A sequential counter that Amazon Route 53 sets to We recommend that you use
|
IPAddress |
The IPv4 or IPv6 IP address for the endpoint that you want Amazon Route
53 to perform health checks on. If you don't specify a value for
Use one of the following formats for the value of
If the endpoint is an EC2 instance, we recommend that you create an
Elastic IP address, associate it with your EC2 instance, and specify the
Elastic IP address for
If a health check already has a value for For more information, see FullyQualifiedDomainName. Constraints: Route 53 can't check the health of endpoints for which the IP address is in local, private, non-routable, or multicast ranges. For more information about IP addresses for which you can't create health checks, see the following documents: |
Port |
The port on the endpoint that you want Amazon Route 53 to perform health checks on. Don't specify a value for |
ResourcePath |
The path that you want Amazon Route 53 to request when performing health
checks. The path can be any value for which your endpoint will return an
HTTP status code of 2xx or 3xx when the endpoint is healthy, for example
the file /docs/route53-health-check.html. You can also include query
string parameters, for example, Specify this value only if you want to change it. |
FullyQualifiedDomainName |
Amazon Route 53 behavior depends on whether you specify a value for
If a health check already has a value for If you specify a value for Route 53 sends health check requests to the specified IPv4 or IPv6
address and passes the value of When Route 53 checks the health of an endpoint, here is how it
constructs the
If you don't specify a value for If you don't specify a value for If you don't specify a value for If you don't specify a value for If you don't specify a value for If you want to check the health of weighted, latency, or failover
resource record sets and you choose to specify the endpoint only by
In this configuration, if the value of In addition, if the value of |
SearchString |
If the value of |
FailureThreshold |
The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa. For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide. If you don't specify a value for |
Inverted |
Specify whether you want Amazon Route 53 to invert the status of a health check, for example, to consider a health check unhealthy when it otherwise would be considered healthy. |
Disabled |
Stops Route 53 from performing health checks. When you disable a health check, here's what happens:
After you disable a health check, Route 53 considers the status of the health check to always be healthy. If you configured DNS failover, Route 53 continues to route traffic to the corresponding resources. If you want to stop routing traffic to a resource, change the value of Inverted. Charges for a health check still apply when the health check is disabled. For more information, see Amazon Route 53 Pricing. |
HealthThreshold |
The number of child health checks that are associated with a
Note the following:
|
ChildHealthChecks |
A complex type that contains one |
EnableSNI |
Specify whether you want Amazon Route 53 to send the value of
Some endpoints require that HTTPS requests include the host name in the
The SSL/TLS certificate on your endpoint includes a domain name in the
|
Regions |
A complex type that contains one |
AlarmIdentifier |
A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether the specified health check is healthy. |
InsufficientDataHealthStatus |
When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you want Amazon Route 53 to assign to the health check:
|
ResetElements |
A complex type that contains one
|
Updates the comment for a specified hosted zone
Description
Updates the comment for a specified hosted zone.
See https://www.paws-r-sdk.com/docs/route53_update_hosted_zone_comment/ for full documentation.
Usage
route53_update_hosted_zone_comment(Id, Comment = NULL)
Arguments
Id |
[required] The ID for the hosted zone that you want to update the comment for. |
Comment |
The new comment for the hosted zone. If you don't specify a value for
|
Updates the comment for a specified traffic policy version
Description
Updates the comment for a specified traffic policy version.
See https://www.paws-r-sdk.com/docs/route53_update_traffic_policy_comment/ for full documentation.
Usage
route53_update_traffic_policy_comment(Id, Version, Comment)
Arguments
Id |
[required] The value of |
Version |
[required] The value of |
Comment |
[required] The new comment for the specified traffic policy and version. |
After you submit a UpdateTrafficPolicyInstance request, there's a brief delay while Route 53 creates the resource record sets that are specified in the traffic policy definition
Description
After you submit a update_traffic_policy_instance
request, there's a brief delay while Route 53 creates the resource record sets that are specified in the traffic policy definition. Use get_traffic_policy_instance
with the id
of updated traffic policy instance confirm that the update_traffic_policy_instance
request completed successfully. For more information, see the State
response element.
See https://www.paws-r-sdk.com/docs/route53_update_traffic_policy_instance/ for full documentation.
Usage
route53_update_traffic_policy_instance(
Id,
TTL,
TrafficPolicyId,
TrafficPolicyVersion
)
Arguments
Id |
[required] The ID of the traffic policy instance that you want to update. |
TTL |
[required] The TTL that you want Amazon Route 53 to assign to all of the updated resource record sets. |
TrafficPolicyId |
[required] The ID of the traffic policy that you want Amazon Route 53 to use to update resource record sets for the specified traffic policy instance. |
TrafficPolicyVersion |
[required] The version of the traffic policy that you want Amazon Route 53 to use to update resource record sets for the specified traffic policy instance. |
Amazon Route 53 Domains
Description
Amazon Route 53 API actions let you register domain names and perform related operations.
Usage
route53domains(
config = list(),
credentials = list(),
endpoint = NULL,
region = NULL
)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...)
, where svc
is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- route53domains( config = list( credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string", close_connection = "logical", timeout = "numeric", s3_force_path_style = "logical", sts_regional_endpoint = "string" ), credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string" )
Operations
accept_domain_transfer_from_another_aws_account | Accepts the transfer of a domain from another Amazon Web Services account to the currentAmazon Web Services account |
associate_delegation_signer_to_domain | Creates a delegation signer (DS) record in the registry zone for this domain name |
cancel_domain_transfer_to_another_aws_account | Cancels the transfer of a domain from the current Amazon Web Services account to another Amazon Web Services account |
check_domain_availability | This operation checks the availability of one domain name |
check_domain_transferability | Checks whether a domain name can be transferred to Amazon Route 53 |
delete_domain | This operation deletes the specified domain |
delete_tags_for_domain | This operation deletes the specified tags for a domain |
disable_domain_auto_renew | This operation disables automatic renewal of domain registration for the specified domain |
disable_domain_transfer_lock | This operation removes the transfer lock on the domain (specifically the clientTransferProhibited status) to allow domain transfers |
disassociate_delegation_signer_from_domain | Deletes a delegation signer (DS) record in the registry zone for this domain name |
enable_domain_auto_renew | This operation configures Amazon Route 53 to automatically renew the specified domain before the domain registration expires |
enable_domain_transfer_lock | This operation sets the transfer lock on the domain (specifically the clientTransferProhibited status) to prevent domain transfers |
get_contact_reachability_status | For operations that require confirmation that the email address for the registrant contact is valid, such as registering a new domain, this operation returns information about whether the registrant contact has responded |
get_domain_detail | This operation returns detailed information about a specified domain that is associated with the current Amazon Web Services account |
get_domain_suggestions | The GetDomainSuggestions operation returns a list of suggested domain names |
get_operation_detail | This operation returns the current status of an operation that is not completed |
list_domains | This operation returns all the domain names registered with Amazon Route 53 for the current Amazon Web Services account if no filtering conditions are used |
list_operations | Returns information about all of the operations that return an operation ID and that have ever been performed on domains that were registered by the current account |
list_prices | Lists the following prices for either all the TLDs supported by Route 53, or the specified TLD: |
list_tags_for_domain | This operation returns all of the tags that are associated with the specified domain |
push_domain | Moves a domain from Amazon Web Services to another registrar |
register_domain | This operation registers a domain |
reject_domain_transfer_from_another_aws_account | Rejects the transfer of a domain from another Amazon Web Services account to the current Amazon Web Services account |
renew_domain | This operation renews a domain for the specified number of years |
resend_contact_reachability_email | For operations that require confirmation that the email address for the registrant contact is valid, such as registering a new domain, this operation resends the confirmation email to the current email address for the registrant contact |
resend_operation_authorization | Resend the form of authorization email for this operation |
retrieve_domain_auth_code | This operation returns the authorization code for the domain |
transfer_domain | Transfers a domain from another registrar to Amazon Route 53 |
transfer_domain_to_another_aws_account | Transfers a domain from the current Amazon Web Services account to another Amazon Web Services account |
update_domain_contact | This operation updates the contact information for a particular domain |
update_domain_contact_privacy | This operation updates the specified domain contact's privacy setting |
update_domain_nameservers | This operation replaces the current set of name servers for the domain with the specified set of name servers |
update_tags_for_domain | This operation adds or updates tags for a specified domain |
view_billing | Returns all the domain-related billing records for the current Amazon Web Services account for a specified period |
Examples
## Not run:
svc <- route53domains()
svc$accept_domain_transfer_from_another_aws_account(
Foo = 123
)
## End(Not run)
Accepts the transfer of a domain from another Amazon Web Services account to the currentAmazon Web Services account
Description
Accepts the transfer of a domain from another Amazon Web Services account to the currentAmazon Web Services account. You initiate a transfer between Amazon Web Services accounts using transfer_domain_to_another_aws_account
.
See https://www.paws-r-sdk.com/docs/route53domains_accept_domain_transfer_from_another_aws_account/ for full documentation.
Usage
route53domains_accept_domain_transfer_from_another_aws_account(
DomainName,
Password
)
Arguments
DomainName |
[required] The name of the domain that was specified when another Amazon Web
Services account submitted a
|
Password |
[required] The password that was returned by the
|
Creates a delegation signer (DS) record in the registry zone for this domain name
Description
Creates a delegation signer (DS) record in the registry zone for this domain name.
See https://www.paws-r-sdk.com/docs/route53domains_associate_delegation_signer_to_domain/ for full documentation.
Usage
route53domains_associate_delegation_signer_to_domain(
DomainName,
SigningAttributes
)
Arguments
DomainName |
[required] The name of the domain. |
SigningAttributes |
[required] The information about a key, including the algorithm, public key-value, and flags. |
Cancels the transfer of a domain from the current Amazon Web Services account to another Amazon Web Services account
Description
Cancels the transfer of a domain from the current Amazon Web Services account to another Amazon Web Services account. You initiate a transfer betweenAmazon Web Services accounts using transfer_domain_to_another_aws_account
.
See https://www.paws-r-sdk.com/docs/route53domains_cancel_domain_transfer_to_another_aws_account/ for full documentation.
Usage
route53domains_cancel_domain_transfer_to_another_aws_account(DomainName)
Arguments
DomainName |
[required] The name of the domain for which you want to cancel the transfer to another Amazon Web Services account. |
This operation checks the availability of one domain name
Description
This operation checks the availability of one domain name. Note that if the availability status of a domain is pending, you must submit another request to determine the availability of the domain name.
See https://www.paws-r-sdk.com/docs/route53domains_check_domain_availability/ for full documentation.
Usage
route53domains_check_domain_availability(DomainName, IdnLangCode = NULL)
Arguments
DomainName |
[required] The name of the domain that you want to get availability for. The top-level domain (TLD), such as .com, must be a TLD that Route 53 supports. For a list of supported TLDs, see Domains that You Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide. The domain name can contain only the following characters:
Internationalized domain names are not supported for some top-level domains. To determine whether the TLD that you want to use supports internationalized domain names, see Domains that You Can Register with Amazon Route 53. For more information, see Formatting Internationalized Domain Names. |
IdnLangCode |
Reserved for future use. |
Checks whether a domain name can be transferred to Amazon Route 53
Description
Checks whether a domain name can be transferred to Amazon Route 53.
See https://www.paws-r-sdk.com/docs/route53domains_check_domain_transferability/ for full documentation.
Usage
route53domains_check_domain_transferability(DomainName, AuthCode = NULL)
Arguments
DomainName |
[required] The name of the domain that you want to transfer to Route 53. The top-level domain (TLD), such as .com, must be a TLD that Route 53 supports. For a list of supported TLDs, see Domains that You Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide. The domain name can contain only the following characters:
|
AuthCode |
If the registrar for the top-level domain (TLD) requires an authorization code to transfer the domain, the code that you got from the current registrar for the domain. |
This operation deletes the specified domain
Description
This operation deletes the specified domain. This action is permanent. For more information, see Deleting a domain name registration.
See https://www.paws-r-sdk.com/docs/route53domains_delete_domain/ for full documentation.
Usage
route53domains_delete_domain(DomainName)
Arguments
DomainName |
[required] Name of the domain to be deleted. |
This operation deletes the specified tags for a domain
Description
This operation deletes the specified tags for a domain.
See https://www.paws-r-sdk.com/docs/route53domains_delete_tags_for_domain/ for full documentation.
Usage
route53domains_delete_tags_for_domain(DomainName, TagsToDelete)
Arguments
DomainName |
[required] The domain for which you want to delete one or more tags. |
TagsToDelete |
[required] A list of tag keys to delete. |
This operation disables automatic renewal of domain registration for the specified domain
Description
This operation disables automatic renewal of domain registration for the specified domain.
See https://www.paws-r-sdk.com/docs/route53domains_disable_domain_auto_renew/ for full documentation.
Usage
route53domains_disable_domain_auto_renew(DomainName)
Arguments
DomainName |
[required] The name of the domain that you want to disable automatic renewal for. |
This operation removes the transfer lock on the domain (specifically the clientTransferProhibited status) to allow domain transfers
Description
This operation removes the transfer lock on the domain (specifically the clientTransferProhibited
status) to allow domain transfers. We recommend you refrain from performing this action unless you intend to transfer the domain to a different registrar. Successful submission returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email.
See https://www.paws-r-sdk.com/docs/route53domains_disable_domain_transfer_lock/ for full documentation.
Usage
route53domains_disable_domain_transfer_lock(DomainName)
Arguments
DomainName |
[required] The name of the domain that you want to remove the transfer lock for. |
Deletes a delegation signer (DS) record in the registry zone for this domain name
Description
Deletes a delegation signer (DS) record in the registry zone for this domain name.
See https://www.paws-r-sdk.com/docs/route53domains_disassociate_delegation_signer_from_domain/ for full documentation.
Usage
route53domains_disassociate_delegation_signer_from_domain(DomainName, Id)
Arguments
DomainName |
[required] Name of the domain. |
Id |
[required] An internal identification number assigned to each DS record after it’s
created. You can retrieve it as part of DNSSEC information returned by
|
This operation configures Amazon Route 53 to automatically renew the specified domain before the domain registration expires
Description
This operation configures Amazon Route 53 to automatically renew the specified domain before the domain registration expires. The cost of renewing your domain registration is billed to your Amazon Web Services account.
See https://www.paws-r-sdk.com/docs/route53domains_enable_domain_auto_renew/ for full documentation.
Usage
route53domains_enable_domain_auto_renew(DomainName)
Arguments
DomainName |
[required] The name of the domain that you want to enable automatic renewal for. |
This operation sets the transfer lock on the domain (specifically the clientTransferProhibited status) to prevent domain transfers
Description
This operation sets the transfer lock on the domain (specifically the clientTransferProhibited
status) to prevent domain transfers. Successful submission returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email.
See https://www.paws-r-sdk.com/docs/route53domains_enable_domain_transfer_lock/ for full documentation.
Usage
route53domains_enable_domain_transfer_lock(DomainName)
Arguments
DomainName |
[required] The name of the domain that you want to set the transfer lock for. |
For operations that require confirmation that the email address for the registrant contact is valid, such as registering a new domain, this operation returns information about whether the registrant contact has responded
Description
For operations that require confirmation that the email address for the registrant contact is valid, such as registering a new domain, this operation returns information about whether the registrant contact has responded.
See https://www.paws-r-sdk.com/docs/route53domains_get_contact_reachability_status/ for full documentation.
Usage
route53domains_get_contact_reachability_status(domainName = NULL)
Arguments
domainName |
The name of the domain for which you want to know whether the registrant contact has confirmed that the email address is valid. |
This operation returns detailed information about a specified domain that is associated with the current Amazon Web Services account
Description
This operation returns detailed information about a specified domain that is associated with the current Amazon Web Services account. Contact information for the domain is also returned as part of the output.
See https://www.paws-r-sdk.com/docs/route53domains_get_domain_detail/ for full documentation.
Usage
route53domains_get_domain_detail(DomainName)
Arguments
DomainName |
[required] The name of the domain that you want to get detailed information about. |
The GetDomainSuggestions operation returns a list of suggested domain names
Description
The GetDomainSuggestions operation returns a list of suggested domain names.
See https://www.paws-r-sdk.com/docs/route53domains_get_domain_suggestions/ for full documentation.
Usage
route53domains_get_domain_suggestions(
DomainName,
SuggestionCount,
OnlyAvailable
)
Arguments
DomainName |
[required] A domain name that you want to use as the basis for a list of possible domain names. The top-level domain (TLD), such as .com, must be a TLD that Route 53 supports. For a list of supported TLDs, see Domains that You Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide. The domain name can contain only the following characters:
Internationalized domain names are not supported for some top-level domains. To determine whether the TLD that you want to use supports internationalized domain names, see Domains that You Can Register with Amazon Route 53. |
SuggestionCount |
[required] The number of suggested domain names that you want Route 53 to return. Specify a value between 1 and 50. |
OnlyAvailable |
[required] If |
This operation returns the current status of an operation that is not completed
Description
This operation returns the current status of an operation that is not completed.
See https://www.paws-r-sdk.com/docs/route53domains_get_operation_detail/ for full documentation.
Usage
route53domains_get_operation_detail(OperationId)
Arguments
OperationId |
[required] The identifier for the operation for which you want to get the status. Route 53 returned the identifier in the response to the original request. |
This operation returns all the domain names registered with Amazon Route 53 for the current Amazon Web Services account if no filtering conditions are used
Description
This operation returns all the domain names registered with Amazon Route 53 for the current Amazon Web Services account if no filtering conditions are used.
See https://www.paws-r-sdk.com/docs/route53domains_list_domains/ for full documentation.
Usage
route53domains_list_domains(
FilterConditions = NULL,
SortCondition = NULL,
Marker = NULL,
MaxItems = NULL
)
Arguments
FilterConditions |
A complex type that contains information about the filters applied
during the |
SortCondition |
A complex type that contains information about the requested ordering of domains in the returned list. |
Marker |
For an initial request for a list of domains, omit this element. If the
number of domains that are associated with the current Amazon Web
Services account is greater than the value that you specified for
Constraints: The marker must match the value specified in the previous request. |
MaxItems |
Number of domains to be returned. Default: 20 |
Returns information about all of the operations that return an operation ID and that have ever been performed on domains that were registered by the current account
Description
Returns information about all of the operations that return an operation ID and that have ever been performed on domains that were registered by the current account.
See https://www.paws-r-sdk.com/docs/route53domains_list_operations/ for full documentation.
Usage
route53domains_list_operations(
SubmittedSince = NULL,
Marker = NULL,
MaxItems = NULL,
Status = NULL,
Type = NULL,
SortBy = NULL,
SortOrder = NULL
)
Arguments
SubmittedSince |
An optional parameter that lets you get information about all the operations that you submitted after a specified date and time. Specify the date and time in Unix time format and Coordinated Universal time (UTC). |
Marker |
For an initial request for a list of operations, omit this element. If
the number of operations that are not yet complete is greater than the
value that you specified for |
MaxItems |
Number of domains to be returned. Default: 20 |
Status |
The status of the operations. |
Type |
An arrays of the domains operation types. |
SortBy |
The sort type for returned values. |
SortOrder |
The sort order for returned values, either ascending or descending. |
Lists the following prices for either all the TLDs supported by Route 53, or the specified TLD:
Description
Lists the following prices for either all the TLDs supported by Route 53, or the specified TLD:
See https://www.paws-r-sdk.com/docs/route53domains_list_prices/ for full documentation.
Usage
route53domains_list_prices(Tld = NULL, Marker = NULL, MaxItems = NULL)
Arguments
Tld |
The TLD for which you want to receive the pricing information. For
example. If a |
Marker |
For an initial request for a list of prices, omit this element. If the
number of prices that are not yet complete is greater than the value
that you specified for Used only for all TLDs. If you specify a TLD, don't specify a |
MaxItems |
Number of Used only for all TLDs. If you specify a TLD, don't specify a
|
This operation returns all of the tags that are associated with the specified domain
Description
This operation returns all of the tags that are associated with the specified domain.
See https://www.paws-r-sdk.com/docs/route53domains_list_tags_for_domain/ for full documentation.
Usage
route53domains_list_tags_for_domain(DomainName)
Arguments
DomainName |
[required] The domain for which you want to get a list of tags. |
Moves a domain from Amazon Web Services to another registrar
Description
Moves a domain from Amazon Web Services to another registrar.
See https://www.paws-r-sdk.com/docs/route53domains_push_domain/ for full documentation.
Usage
route53domains_push_domain(DomainName, Target)
Arguments
DomainName |
[required] Name of the domain. |
Target |
[required] New IPS tag for the domain. |
This operation registers a domain
Description
This operation registers a domain. For some top-level domains (TLDs), this operation requires extra parameters.
See https://www.paws-r-sdk.com/docs/route53domains_register_domain/ for full documentation.
Usage
route53domains_register_domain(
DomainName,
IdnLangCode = NULL,
DurationInYears,
AutoRenew = NULL,
AdminContact,
RegistrantContact,
TechContact,
PrivacyProtectAdminContact = NULL,
PrivacyProtectRegistrantContact = NULL,
PrivacyProtectTechContact = NULL,
BillingContact = NULL,
PrivacyProtectBillingContact = NULL
)
Arguments
DomainName |
[required] The domain name that you want to register. The top-level domain (TLD), such as .com, must be a TLD that Route 53 supports. For a list of supported TLDs, see Domains that You Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide. The domain name can contain only the following characters:
Internationalized domain names are not supported for some top-level domains. To determine whether the TLD that you want to use supports internationalized domain names, see Domains that You Can Register with Amazon Route 53. For more information, see Formatting Internationalized Domain Names. |
IdnLangCode |
Reserved for future use. |
DurationInYears |
[required] The number of years that you want to register the domain for. Domains are registered for a minimum of one year. The maximum period depends on the top-level domain. For the range of valid values for your domain, see Domains that You Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide. Default: 1 |
AutoRenew |
Indicates whether the domain will be automatically renewed ( Default: |
AdminContact |
[required] Provides detailed contact information. For information about the values that you specify for each element, see ContactDetail. |
RegistrantContact |
[required] Provides detailed contact information. For information about the values that you specify for each element, see ContactDetail. |
TechContact |
[required] Provides detailed contact information. For information about the values that you specify for each element, see ContactDetail. |
PrivacyProtectAdminContact |
Whether you want to conceal contact information from WHOIS queries. If
you specify You must specify the same privacy setting for the administrative, billing, registrant, and technical contacts. Default: |
PrivacyProtectRegistrantContact |
Whether you want to conceal contact information from WHOIS queries. If
you specify You must specify the same privacy setting for the administrative, billing, registrant, and technical contacts. Default: |
PrivacyProtectTechContact |
Whether you want to conceal contact information from WHOIS queries. If
you specify You must specify the same privacy setting for the administrative, billing, registrant, and technical contacts. Default: |
BillingContact |
Provides detailed contact information. For information about the values that you specify for each element, see ContactDetail. |
PrivacyProtectBillingContact |
Whether you want to conceal contact information from WHOIS queries. If
you specify You must specify the same privacy setting for the administrative, billing, registrant, and technical contacts. |
Rejects the transfer of a domain from another Amazon Web Services account to the current Amazon Web Services account
Description
Rejects the transfer of a domain from another Amazon Web Services account to the current Amazon Web Services account. You initiate a transfer betweenAmazon Web Services accounts using transfer_domain_to_another_aws_account
.
See https://www.paws-r-sdk.com/docs/route53domains_reject_domain_transfer_from_another_aws_account/ for full documentation.
Usage
route53domains_reject_domain_transfer_from_another_aws_account(DomainName)
Arguments
DomainName |
[required] The name of the domain that was specified when another Amazon Web
Services account submitted a
|
This operation renews a domain for the specified number of years
Description
This operation renews a domain for the specified number of years. The cost of renewing your domain is billed to your Amazon Web Services account.
See https://www.paws-r-sdk.com/docs/route53domains_renew_domain/ for full documentation.
Usage
route53domains_renew_domain(
DomainName,
DurationInYears = NULL,
CurrentExpiryYear
)
Arguments
DomainName |
[required] The name of the domain that you want to renew. |
DurationInYears |
The number of years that you want to renew the domain for. The maximum number of years depends on the top-level domain. For the range of valid values for your domain, see Domains that You Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide. Default: 1 |
CurrentExpiryYear |
[required] The year when the registration for the domain is set to expire. This value must match the current expiration date for the domain. |
For operations that require confirmation that the email address for the registrant contact is valid, such as registering a new domain, this operation resends the confirmation email to the current email address for the registrant contact
Description
For operations that require confirmation that the email address for the registrant contact is valid, such as registering a new domain, this operation resends the confirmation email to the current email address for the registrant contact.
See https://www.paws-r-sdk.com/docs/route53domains_resend_contact_reachability_email/ for full documentation.
Usage
route53domains_resend_contact_reachability_email(domainName = NULL)
Arguments
domainName |
The name of the domain for which you want Route 53 to resend a confirmation email to the registrant contact. |
Resend the form of authorization email for this operation
Description
Resend the form of authorization email for this operation.
See https://www.paws-r-sdk.com/docs/route53domains_resend_operation_authorization/ for full documentation.
Usage
route53domains_resend_operation_authorization(OperationId)
Arguments
OperationId |
[required] Operation ID. |
This operation returns the authorization code for the domain
Description
This operation returns the authorization code for the domain. To transfer a domain to another registrar, you provide this value to the new registrar.
See https://www.paws-r-sdk.com/docs/route53domains_retrieve_domain_auth_code/ for full documentation.
Usage
route53domains_retrieve_domain_auth_code(DomainName)
Arguments
DomainName |
[required] The name of the domain that you want to get an authorization code for. |
Transfers a domain from another registrar to Amazon Route 53
Description
Transfers a domain from another registrar to Amazon Route 53.
See https://www.paws-r-sdk.com/docs/route53domains_transfer_domain/ for full documentation.
Usage
route53domains_transfer_domain(
DomainName,
IdnLangCode = NULL,
DurationInYears,
Nameservers = NULL,
AuthCode = NULL,
AutoRenew = NULL,
AdminContact,
RegistrantContact,
TechContact,
PrivacyProtectAdminContact = NULL,
PrivacyProtectRegistrantContact = NULL,
PrivacyProtectTechContact = NULL,
BillingContact = NULL,
PrivacyProtectBillingContact = NULL
)
Arguments
DomainName |
[required] The name of the domain that you want to transfer to Route 53. The top-level domain (TLD), such as .com, must be a TLD that Route 53 supports. For a list of supported TLDs, see Domains that You Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide. The domain name can contain only the following characters:
|
IdnLangCode |
Reserved for future use. |
DurationInYears |
[required] The number of years that you want to register the domain for. Domains are registered for a minimum of one year. The maximum period depends on the top-level domain. Default: 1 |
Nameservers |
Contains details for the host and glue IP addresses. |
AuthCode |
The authorization code for the domain. You get this value from the current registrar. |
AutoRenew |
Indicates whether the domain will be automatically renewed (true) or not (false). Auto renewal only takes effect after the account is charged. Default: true |
AdminContact |
[required] Provides detailed contact information. |
RegistrantContact |
[required] Provides detailed contact information. |
TechContact |
[required] Provides detailed contact information. |
PrivacyProtectAdminContact |
Whether you want to conceal contact information from WHOIS queries. If
you specify While some domains may allow different privacy settings per contact, we recommend specifying the same privacy setting for all contacts. Default: |
PrivacyProtectRegistrantContact |
Whether you want to conceal contact information from WHOIS queries. If
you specify You must specify the same privacy setting for the administrative, billing, registrant, and technical contacts. Default: |
PrivacyProtectTechContact |
Whether you want to conceal contact information from WHOIS queries. If
you specify You must specify the same privacy setting for the administrative, billing, registrant, and technical contacts. Default: |
BillingContact |
Provides detailed contact information. |
PrivacyProtectBillingContact |
Whether you want to conceal contact information from WHOIS queries. If
you specify You must specify the same privacy setting for the administrative, billing, registrant, and technical contacts. |
Transfers a domain from the current Amazon Web Services account to another Amazon Web Services account
Description
Transfers a domain from the current Amazon Web Services account to another Amazon Web Services account. Note the following:
See https://www.paws-r-sdk.com/docs/route53domains_transfer_domain_to_another_aws_account/ for full documentation.
Usage
route53domains_transfer_domain_to_another_aws_account(DomainName, AccountId)
Arguments
DomainName |
[required] The name of the domain that you want to transfer from the current Amazon Web Services account to another account. |
AccountId |
[required] The account ID of the Amazon Web Services account that you want to
transfer the domain to, for example, |
This operation updates the contact information for a particular domain
Description
This operation updates the contact information for a particular domain. You must specify information for at least one contact: registrant, administrator, or technical.
See https://www.paws-r-sdk.com/docs/route53domains_update_domain_contact/ for full documentation.
Usage
route53domains_update_domain_contact(
DomainName,
AdminContact = NULL,
RegistrantContact = NULL,
TechContact = NULL,
Consent = NULL,
BillingContact = NULL
)
Arguments
DomainName |
[required] The name of the domain that you want to update contact information for. |
AdminContact |
Provides detailed contact information. |
RegistrantContact |
Provides detailed contact information. |
TechContact |
Provides detailed contact information. |
Consent |
Customer's consent for the owner change request. Required if the domain is not free (consent price is more than $0.00). |
BillingContact |
Provides detailed contact information. |
This operation updates the specified domain contact's privacy setting
Description
This operation updates the specified domain contact's privacy setting. When privacy protection is enabled, your contact information is replaced with contact information for the registrar or with the phrase "REDACTED FOR PRIVACY", or "On behalf of \<domain name\> owner."
See https://www.paws-r-sdk.com/docs/route53domains_update_domain_contact_privacy/ for full documentation.
Usage
route53domains_update_domain_contact_privacy(
DomainName,
AdminPrivacy = NULL,
RegistrantPrivacy = NULL,
TechPrivacy = NULL,
BillingPrivacy = NULL
)
Arguments
DomainName |
[required] The name of the domain that you want to update the privacy setting for. |
AdminPrivacy |
Whether you want to conceal contact information from WHOIS queries. If
you specify You must specify the same privacy setting for the administrative, billing, registrant, and technical contacts. |
RegistrantPrivacy |
Whether you want to conceal contact information from WHOIS queries. If
you specify You must specify the same privacy setting for the administrative, billing, registrant, and technical contacts. |
TechPrivacy |
Whether you want to conceal contact information from WHOIS queries. If
you specify You must specify the same privacy setting for the administrative, billing, registrant, and technical contacts. |
BillingPrivacy |
Whether you want to conceal contact information from WHOIS queries. If
you specify You must specify the same privacy setting for the administrative, billing, registrant, and technical contacts. |
This operation replaces the current set of name servers for the domain with the specified set of name servers
Description
This operation replaces the current set of name servers for the domain with the specified set of name servers. If you use Amazon Route 53 as your DNS service, specify the four name servers in the delegation set for the hosted zone for the domain.
See https://www.paws-r-sdk.com/docs/route53domains_update_domain_nameservers/ for full documentation.
Usage
route53domains_update_domain_nameservers(
DomainName,
FIAuthKey = NULL,
Nameservers
)
Arguments
DomainName |
[required] The name of the domain that you want to change name servers for. |
FIAuthKey |
The authorization key for .fi domains |
Nameservers |
[required] A list of new name servers for the domain. |
This operation adds or updates tags for a specified domain
Description
This operation adds or updates tags for a specified domain.
See https://www.paws-r-sdk.com/docs/route53domains_update_tags_for_domain/ for full documentation.
Usage
route53domains_update_tags_for_domain(DomainName, TagsToUpdate = NULL)
Arguments
DomainName |
[required] The domain for which you want to add or update tags. |
TagsToUpdate |
A list of the tag keys and values that you want to add or update. If you specify a key that already exists, the corresponding value will be replaced. |
Returns all the domain-related billing records for the current Amazon Web Services account for a specified period
Description
Returns all the domain-related billing records for the current Amazon Web Services account for a specified period
See https://www.paws-r-sdk.com/docs/route53domains_view_billing/ for full documentation.
Usage
route53domains_view_billing(
Start = NULL,
End = NULL,
Marker = NULL,
MaxItems = NULL
)
Arguments
Start |
The beginning date and time for the time period for which you want a list of billing records. Specify the date and time in Unix time format and Coordinated Universal time (UTC). |
End |
The end date and time for the time period for which you want a list of billing records. Specify the date and time in Unix time format and Coordinated Universal time (UTC). |
Marker |
For an initial request for a list of billing records, omit this element.
If the number of billing records that are associated with the current
Amazon Web Services account during the specified period is greater than
the value that you specified for Constraints: The marker must match the value of |
MaxItems |
The number of billing records to be returned. Default: 20 |
Route 53 Profiles
Description
With Amazon Route 53 Profiles you can share Route 53 configurations with VPCs and AWS accounts
Usage
route53profiles(
config = list(),
credentials = list(),
endpoint = NULL,
region = NULL
)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...)
, where svc
is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- route53profiles( config = list( credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string", close_connection = "logical", timeout = "numeric", s3_force_path_style = "logical", sts_regional_endpoint = "string" ), credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string" )
Operations
associate_profile | Associates a Route 53 Profiles profile with a VPC |
associate_resource_to_profile | Associates a DNS reource configuration to a Route 53 Profile |
create_profile | Creates an empty Route 53 Profile |
delete_profile | Deletes the specified Route 53 Profile |
disassociate_profile | Dissociates a specified Route 53 Profile from the specified VPC |
disassociate_resource_from_profile | Dissoaciated a specified resource, from the Route 53 Profile |
get_profile | 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 | Retrieves a Route 53 Profile association for a VPC |
get_profile_resource_association | Returns information about a specified Route 53 Profile resource association |
list_profile_associations | Lists all the VPCs that the specified Route 53 Profile is associated with |
list_profile_resource_associations | Lists all the resource associations for the specified Route 53 Profile |
list_profiles | Lists all the Route 53 Profiles associated with your Amazon Web Services account |
list_tags_for_resource | Lists the tags that you associated with the specified resource |
tag_resource | Adds one or more tags to a specified resource |
untag_resource | Removes one or more tags from a specified resource |
update_profile_resource_association | Updates the specified Route 53 Profile resourse association |
Examples
## Not run:
svc <- route53profiles()
svc$associate_profile(
Foo = 123
)
## End(Not run)
Associates a Route 53 Profiles profile with a VPC
Description
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-entities.
See https://www.paws-r-sdk.com/docs/route53profiles_associate_profile/ for full documentation.
Usage
route53profiles_associate_profile(Name, ProfileId, ResourceId, Tags = NULL)
Arguments
Name |
[required] A name for the association. |
ProfileId |
[required] ID of the Profile. |
ResourceId |
[required] The ID of the VPC. |
Tags |
A list of the tag keys and values that you want to identify the Profile association. |
Associates a DNS reource configuration to a Route 53 Profile
Description
Associates a DNS reource configuration to a Route 53 Profile.
See https://www.paws-r-sdk.com/docs/route53profiles_associate_resource_to_profile/ for full documentation.
Usage
route53profiles_associate_resource_to_profile(
Name,
ProfileId,
ResourceArn,
ResourceProperties = NULL
)
Arguments
Name |
[required] Name for the resource association. |
ProfileId |
[required] ID of the Profile. |
ResourceArn |
[required] Amazon resource number, ARN, of the DNS resource. |
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. |
Creates an empty Route 53 Profile
Description
Creates an empty Route 53 Profile.
See https://www.paws-r-sdk.com/docs/route53profiles_create_profile/ for full documentation.
Usage
route53profiles_create_profile(ClientToken, Name, Tags = NULL)
Arguments
ClientToken |
[required] |
Name |
[required] A name for the Profile. |
Tags |
A list of the tag keys and values that you want to associate with the Route 53 Profile. |
Deletes the specified Route 53 Profile
Description
Deletes the specified Route 53 Profile. Before you can delete a profile, you must first disassociate it from all VPCs.
See https://www.paws-r-sdk.com/docs/route53profiles_delete_profile/ for full documentation.
Usage
route53profiles_delete_profile(ProfileId)
Arguments
ProfileId |
[required] The ID of the Profile that you want to delete. |
Dissociates a specified Route 53 Profile from the specified VPC
Description
Dissociates a specified Route 53 Profile from the specified VPC.
See https://www.paws-r-sdk.com/docs/route53profiles_disassociate_profile/ for full documentation.
Usage
route53profiles_disassociate_profile(ProfileId, ResourceId)
Arguments
ProfileId |
[required] ID of the Profile. |
ResourceId |
[required] The ID of the VPC. |
Dissoaciated a specified resource, from the Route 53 Profile
Description
Dissoaciated a specified resource, from the Route 53 Profile.
See https://www.paws-r-sdk.com/docs/route53profiles_disassociate_resource_from_profile/ for full documentation.
Usage
route53profiles_disassociate_resource_from_profile(ProfileId, ResourceArn)
Arguments
ProfileId |
[required] The ID of the Profile. |
ResourceArn |
[required] The Amazon Resource Name (ARN) of the resource. |
Returns information about a specified Route 53 Profile, such as whether whether the Profile is shared, and the current status of the Profile
Description
Returns information about a specified Route 53 Profile, such as whether whether the Profile is shared, and the current status of the Profile.
See https://www.paws-r-sdk.com/docs/route53profiles_get_profile/ for full documentation.
Usage
route53profiles_get_profile(ProfileId)
Arguments
ProfileId |
[required] ID of the Profile. |
Retrieves a Route 53 Profile association for a VPC
Description
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.
See https://www.paws-r-sdk.com/docs/route53profiles_get_profile_association/ for full documentation.
Usage
route53profiles_get_profile_association(ProfileAssociationId)
Arguments
ProfileAssociationId |
[required] The identifier of the association you want to get information about. |
Returns information about a specified Route 53 Profile resource association
Description
Returns information about a specified Route 53 Profile resource association.
See https://www.paws-r-sdk.com/docs/route53profiles_get_profile_resource_association/ for full documentation.
Usage
route53profiles_get_profile_resource_association(ProfileResourceAssociationId)
Arguments
ProfileResourceAssociationId |
[required] The ID of the profile resource association that you want to get information about. |
Lists all the VPCs that the specified Route 53 Profile is associated with
Description
Lists all the VPCs that the specified Route 53 Profile is associated with.
See https://www.paws-r-sdk.com/docs/route53profiles_list_profile_associations/ for full documentation.
Usage
route53profiles_list_profile_associations(
MaxResults = NULL,
NextToken = NULL,
ProfileId = NULL,
ResourceId = NULL
)
Arguments
MaxResults |
The maximum number of objects that you want to return for this request.
If more objects are available, in the response, a If you don't specify a value for |
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 |
ProfileId |
ID of the Profile. |
ResourceId |
ID of the VPC. |
Lists all the resource associations for the specified Route 53 Profile
Description
Lists all the resource associations for the specified Route 53 Profile.
See https://www.paws-r-sdk.com/docs/route53profiles_list_profile_resource_associations/ for full documentation.
Usage
route53profiles_list_profile_resource_associations(
MaxResults = NULL,
NextToken = NULL,
ProfileId,
ResourceType = NULL
)
Arguments
MaxResults |
The maximum number of objects that you want to return for this request.
If more objects are available, in the response, a If you don't specify a value for |
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 |
ProfileId |
[required] The ID of the Profile. |
ResourceType |
ID of a resource if you want information on only one type. |
Lists all the Route 53 Profiles associated with your Amazon Web Services account
Description
Lists all the Route 53 Profiles associated with your Amazon Web Services account.
See https://www.paws-r-sdk.com/docs/route53profiles_list_profiles/ for full documentation.
Usage
route53profiles_list_profiles(MaxResults = NULL, NextToken = NULL)
Arguments
MaxResults |
The maximum number of objects that you want to return for this request.
If more objects are available, in the response, a If you don't specify a value for |
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 |
Lists the tags that you associated with the specified resource
Description
Lists the tags that you associated with the specified resource.
See https://www.paws-r-sdk.com/docs/route53profiles_list_tags_for_resource/ for full documentation.
Usage
route53profiles_list_tags_for_resource(ResourceArn)
Arguments
ResourceArn |
[required] The Amazon Resource Name (ARN) for the resource that you want to list the tags for. |
Adds one or more tags to a specified resource
Description
Adds one or more tags to a specified resource.
See https://www.paws-r-sdk.com/docs/route53profiles_tag_resource/ for full documentation.
Usage
route53profiles_tag_resource(ResourceArn, Tags)
Arguments
ResourceArn |
[required] The Amazon Resource Name (ARN) for the resource that you want to add tags to. |
Tags |
[required] The tags that you want to add to the specified resource. |
Removes one or more tags from a specified resource
Description
Removes one or more tags from a specified resource.
See https://www.paws-r-sdk.com/docs/route53profiles_untag_resource/ for full documentation.
Usage
route53profiles_untag_resource(ResourceArn, TagKeys)
Arguments
ResourceArn |
[required] The Amazon Resource Name (ARN) for the resource that you want to remove tags from. |
TagKeys |
[required] The tags that you want to remove to the specified resource. |
Updates the specified Route 53 Profile resourse association
Description
Updates the specified Route 53 Profile resourse association.
See https://www.paws-r-sdk.com/docs/route53profiles_update_profile_resource_association/ for full documentation.
Usage
route53profiles_update_profile_resource_association(
Name = NULL,
ProfileResourceAssociationId,
ResourceProperties = NULL
)
Arguments
Name |
Name of the resource association. |
ProfileResourceAssociationId |
[required] ID 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. |
Route53 Recovery Cluster
Description
Welcome to the Routing Control (Recovery Cluster) API Reference Guide for Amazon Route 53 Application Recovery Controller.
With Route 53 ARC, you can use routing control with extreme reliability to recover applications by rerouting traffic across Availability Zones or Amazon Web Services Regions. Routing controls are simple on/off switches hosted on a highly available cluster in Route 53 ARC. A cluster provides a set of five redundant Regional endpoints against which you can run API calls to get or update the state of routing controls. To implement failover, you set one routing control to ON and another one to OFF, to reroute traffic from one Availability Zone or Amazon Web Services Region to another.
Be aware that you must specify a Regional endpoint for a cluster when
you work with API cluster operations to get or update routing control
states in Route 53 ARC. In addition, you must specify the US West
(Oregon) Region for Route 53 ARC API calls. For example, use the
parameter --region us-west-2
with AWS CLI commands. For more
information, see Get and update routing control states using the API
in the Amazon Route 53 Application Recovery Controller Developer Guide.
This API guide includes information about the API operations for how to get and update routing control states in Route 53 ARC. To work with routing control in Route 53 ARC, you must first create the required components (clusters, control panels, and routing controls) using the recovery cluster configuration API.
For more information about working with routing control in Route 53 ARC, see the following:
Create clusters, control panels, and routing controls by using API operations. For more information, see the Recovery Control Configuration API Reference Guide for Amazon Route 53 Application Recovery Controller.
Learn about the components in recovery control, including clusters, routing controls, and control panels, and how to work with Route 53 ARC in the Amazon Web Services console. For more information, see Recovery control components in the Amazon Route 53 Application Recovery Controller Developer Guide.
Route 53 ARC also provides readiness checks that continually audit resources to help make sure that your applications are scaled and ready to handle failover traffic. For more information about the related API operations, see the Recovery Readiness API Reference Guide for Amazon Route 53 Application Recovery Controller.
For more information about creating resilient applications and preparing for recovery readiness with Route 53 ARC, see the Amazon Route 53 Application Recovery Controller Developer Guide.
Usage
route53recoverycluster(
config = list(),
credentials = list(),
endpoint = NULL,
region = NULL
)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...)
, where svc
is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- route53recoverycluster( config = list( credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string", close_connection = "logical", timeout = "numeric", s3_force_path_style = "logical", sts_regional_endpoint = "string" ), credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string" )
Operations
get_routing_control_state | Get the state for a routing control |
list_routing_controls | List routing control names and Amazon Resource Names (ARNs), as well as the routing control state for each routing control, along with the control panel name and control panel ARN for the routing controls |
update_routing_control_state | Set the state of the routing control to reroute traffic |
update_routing_control_states | Set multiple routing control states |
Examples
## Not run:
svc <- route53recoverycluster()
svc$get_routing_control_state(
Foo = 123
)
## End(Not run)
Get the state for a routing control
Description
Get the state for a routing control. A routing control is a simple on/off switch that you can use to route traffic to cells. When a routing control state is set to ON, traffic flows to a cell. When the state is set to OFF, traffic does not flow.
See https://www.paws-r-sdk.com/docs/route53recoverycluster_get_routing_control_state/ for full documentation.
Usage
route53recoverycluster_get_routing_control_state(RoutingControlArn)
Arguments
RoutingControlArn |
[required] The Amazon Resource Name (ARN) for the routing control that you want to get the state for. |
List routing control names and Amazon Resource Names (ARNs), as well as the routing control state for each routing control, along with the control panel name and control panel ARN for the routing controls
Description
List routing control names and Amazon Resource Names (ARNs), as well as the routing control state for each routing control, along with the control panel name and control panel ARN for the routing controls. If you specify a control panel ARN, this call lists the routing controls in the control panel. Otherwise, it lists all the routing controls in the cluster.
See https://www.paws-r-sdk.com/docs/route53recoverycluster_list_routing_controls/ for full documentation.
Usage
route53recoverycluster_list_routing_controls(
ControlPanelArn = NULL,
NextToken = NULL,
MaxResults = NULL
)
Arguments
ControlPanelArn |
The Amazon Resource Name (ARN) of the control panel of the routing controls to list. |
NextToken |
The token for the next set of results. You receive this token from a previous call. |
MaxResults |
The number of routing controls objects that you want to return with this call. The default value is 500. |
Set the state of the routing control to reroute traffic
Description
Set the state of the routing control to reroute traffic. You can set the value to ON or OFF. When the state is ON, traffic flows to a cell. When the state is OFF, traffic does not flow.
See https://www.paws-r-sdk.com/docs/route53recoverycluster_update_routing_control_state/ for full documentation.
Usage
route53recoverycluster_update_routing_control_state(
RoutingControlArn,
RoutingControlState,
SafetyRulesToOverride = NULL
)
Arguments
RoutingControlArn |
[required] The Amazon Resource Name (ARN) for the routing control that you want to update the state for. |
RoutingControlState |
[required] The state of the routing control. You can set the value to ON or OFF. |
SafetyRulesToOverride |
The Amazon Resource Names (ARNs) for the safety rules that you want to override when you're updating the state of a routing control. You can override one safety rule or multiple safety rules by including one or more ARNs, separated by commas. For more information, see Override safety rules to reroute traffic in the Amazon Route 53 Application Recovery Controller Developer Guide. |
Set multiple routing control states
Description
Set multiple routing control states. You can set the value for each state to be ON or OFF. When the state is ON, traffic flows to a cell. When it's OFF, traffic does not flow.
See https://www.paws-r-sdk.com/docs/route53recoverycluster_update_routing_control_states/ for full documentation.
Usage
route53recoverycluster_update_routing_control_states(
UpdateRoutingControlStateEntries,
SafetyRulesToOverride = NULL
)
Arguments
UpdateRoutingControlStateEntries |
[required] A set of routing control entries that you want to update. |
SafetyRulesToOverride |
The Amazon Resource Names (ARNs) for the safety rules that you want to override when you're updating routing control states. You can override one safety rule or multiple safety rules by including one or more ARNs, separated by commas. For more information, see Override safety rules to reroute traffic in the Amazon Route 53 Application Recovery Controller Developer Guide. |
AWS Route53 Recovery Control Config
Description
Recovery Control Configuration API Reference for Amazon Route 53 Application Recovery Controller
Usage
route53recoverycontrolconfig(
config = list(),
credentials = list(),
endpoint = NULL,
region = NULL
)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...)
, where svc
is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- route53recoverycontrolconfig( config = list( credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string", close_connection = "logical", timeout = "numeric", s3_force_path_style = "logical", sts_regional_endpoint = "string" ), credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string" )
Operations
create_cluster | Create a new cluster |
create_control_panel | Creates a new control panel |
create_routing_control | Creates a new routing control |
create_safety_rule | Creates a safety rule in a control panel |
delete_cluster | Delete a cluster |
delete_control_panel | Deletes a control panel |
delete_routing_control | Deletes a routing control |
delete_safety_rule | Deletes a safety rule |
describe_cluster | Display the details about a cluster |
describe_control_panel | Displays details about a control panel |
describe_routing_control | Displays details about a routing control |
describe_safety_rule | Returns information about a safety rule |
get_resource_policy | Get information about the resource policy for a cluster |
list_associated_route_53_health_checks | Returns an array of all Amazon Route 53 health checks associated with a specific routing control |
list_clusters | Returns an array of all the clusters in an account |
list_control_panels | Returns an array of control panels in an account or in a cluster |
list_routing_controls | Returns an array of routing controls for a control panel |
list_safety_rules | List the safety rules (the assertion rules and gating rules) that you've defined for the routing controls in a control panel |
list_tags_for_resource | Lists the tags for a resource |
tag_resource | Adds a tag to a resource |
untag_resource | Removes a tag from a resource |
update_control_panel | Updates a control panel |
update_routing_control | Updates a routing control |
update_safety_rule | Update a safety rule (an assertion rule or gating rule) |
Examples
## Not run:
svc <- route53recoverycontrolconfig()
svc$create_cluster(
Foo = 123
)
## End(Not run)
Create a new cluster
Description
Create a new cluster. A cluster is a set of redundant Regional endpoints against which you can run API calls to update or get the state of one or more routing controls. Each cluster has a name, status, Amazon Resource Name (ARN), and an array of the five cluster endpoints (one for each supported Amazon Web Services Region) that you can use with API calls to the cluster data plane.
See https://www.paws-r-sdk.com/docs/route53recoverycontrolconfig_create_cluster/ for full documentation.
Usage
route53recoverycontrolconfig_create_cluster(
ClientToken = NULL,
ClusterName,
Tags = NULL
)
Arguments
ClientToken |
A unique, case-sensitive string of up to 64 ASCII characters. To make an idempotent API request with an action, specify a client token in the request. |
ClusterName |
[required] The name of the cluster. |
Tags |
The tags associated with the cluster. |
Creates a new control panel
Description
Creates a new control panel. A control panel represents a group of routing controls that can be changed together in a single transaction. You can use a control panel to centrally view the operational status of applications across your organization, and trigger multi-app failovers in a single transaction, for example, to fail over an Availability Zone or Amazon Web Services Region.
See https://www.paws-r-sdk.com/docs/route53recoverycontrolconfig_create_control_panel/ for full documentation.
Usage
route53recoverycontrolconfig_create_control_panel(
ClientToken = NULL,
ClusterArn,
ControlPanelName,
Tags = NULL
)
Arguments
ClientToken |
A unique, case-sensitive string of up to 64 ASCII characters. To make an idempotent API request with an action, specify a client token in the request. |
ClusterArn |
[required] The Amazon Resource Name (ARN) of the cluster for the control panel. |
ControlPanelName |
[required] The name of the control panel. |
Tags |
The tags associated with the control panel. |
Creates a new routing control
Description
Creates a new routing control.
See https://www.paws-r-sdk.com/docs/route53recoverycontrolconfig_create_routing_control/ for full documentation.
Usage
route53recoverycontrolconfig_create_routing_control(
ClientToken = NULL,
ClusterArn,
ControlPanelArn = NULL,
RoutingControlName
)
Arguments
ClientToken |
A unique, case-sensitive string of up to 64 ASCII characters. To make an idempotent API request with an action, specify a client token in the request. |
ClusterArn |
[required] The Amazon Resource Name (ARN) of the cluster that includes the routing control. |
ControlPanelArn |
The Amazon Resource Name (ARN) of the control panel that includes the routing control. |
RoutingControlName |
[required] The name of the routing control. |
Creates a safety rule in a control panel
Description
Creates a safety rule in a control panel. Safety rules let you add safeguards around changing routing control states, and for enabling and disabling routing controls, to help prevent unexpected outcomes.
See https://www.paws-r-sdk.com/docs/route53recoverycontrolconfig_create_safety_rule/ for full documentation.
Usage
route53recoverycontrolconfig_create_safety_rule(
AssertionRule = NULL,
ClientToken = NULL,
GatingRule = NULL,
Tags = NULL
)
Arguments
AssertionRule |
The assertion rule requested. |
ClientToken |
A unique, case-sensitive string of up to 64 ASCII characters. To make an idempotent API request with an action, specify a client token in the request. |
GatingRule |
The gating rule requested. |
Tags |
The tags associated with the safety rule. |
Delete a cluster
Description
Delete a cluster.
See https://www.paws-r-sdk.com/docs/route53recoverycontrolconfig_delete_cluster/ for full documentation.
Usage
route53recoverycontrolconfig_delete_cluster(ClusterArn)
Arguments
ClusterArn |
[required] The Amazon Resource Name (ARN) of the cluster that you're deleting. |
Deletes a control panel
Description
Deletes a control panel.
See https://www.paws-r-sdk.com/docs/route53recoverycontrolconfig_delete_control_panel/ for full documentation.
Usage
route53recoverycontrolconfig_delete_control_panel(ControlPanelArn)
Arguments
ControlPanelArn |
[required] The Amazon Resource Name (ARN) of the control panel. |
Deletes a routing control
Description
Deletes a routing control.
See https://www.paws-r-sdk.com/docs/route53recoverycontrolconfig_delete_routing_control/ for full documentation.
Usage
route53recoverycontrolconfig_delete_routing_control(RoutingControlArn)
Arguments
RoutingControlArn |
[required] The Amazon Resource Name (ARN) of the routing control that you're deleting. |
Deletes a safety rule
Description
Deletes a safety rule.
See https://www.paws-r-sdk.com/docs/route53recoverycontrolconfig_delete_safety_rule/ for full documentation.
Usage
route53recoverycontrolconfig_delete_safety_rule(SafetyRuleArn)
Arguments
SafetyRuleArn |
[required] The ARN of the safety rule. |
Display the details about a cluster
Description
Display the details about a cluster. The response includes the cluster name, endpoints, status, and Amazon Resource Name (ARN).
See https://www.paws-r-sdk.com/docs/route53recoverycontrolconfig_describe_cluster/ for full documentation.
Usage
route53recoverycontrolconfig_describe_cluster(ClusterArn)
Arguments
ClusterArn |
[required] The Amazon Resource Name (ARN) of the cluster. |
Displays details about a control panel
Description
Displays details about a control panel.
See https://www.paws-r-sdk.com/docs/route53recoverycontrolconfig_describe_control_panel/ for full documentation.
Usage
route53recoverycontrolconfig_describe_control_panel(ControlPanelArn)
Arguments
ControlPanelArn |
[required] The Amazon Resource Name (ARN) of the control panel. |
Displays details about a routing control
Description
Displays details about a routing control. A routing control has one of two states: ON and OFF. You can map the routing control state to the state of an Amazon Route 53 health check, which can be used to control routing.
See https://www.paws-r-sdk.com/docs/route53recoverycontrolconfig_describe_routing_control/ for full documentation.
Usage
route53recoverycontrolconfig_describe_routing_control(RoutingControlArn)
Arguments
RoutingControlArn |
[required] The Amazon Resource Name (ARN) of the routing control. |
Returns information about a safety rule
Description
Returns information about a safety rule.
See https://www.paws-r-sdk.com/docs/route53recoverycontrolconfig_describe_safety_rule/ for full documentation.
Usage
route53recoverycontrolconfig_describe_safety_rule(SafetyRuleArn)
Arguments
SafetyRuleArn |
[required] The ARN of the safety rule. |
Get information about the resource policy for a cluster
Description
Get information about the resource policy for a cluster.
See https://www.paws-r-sdk.com/docs/route53recoverycontrolconfig_get_resource_policy/ for full documentation.
Usage
route53recoverycontrolconfig_get_resource_policy(ResourceArn)
Arguments
ResourceArn |
[required] The Amazon Resource Name (ARN) of the resource. |
Returns an array of all Amazon Route 53 health checks associated with a specific routing control
Description
Returns an array of all Amazon Route 53 health checks associated with a specific routing control.
See https://www.paws-r-sdk.com/docs/route53recoverycontrolconfig_list_associated_route_53_health_checks/ for full documentation.
Usage
route53recoverycontrolconfig_list_associated_route_53_health_checks(
MaxResults = NULL,
NextToken = NULL,
RoutingControlArn
)
Arguments
MaxResults |
The number of objects that you want to return with this call. |
NextToken |
The token that identifies which batch of results you want to see. |
RoutingControlArn |
[required] The Amazon Resource Name (ARN) of the routing control. |
Returns an array of all the clusters in an account
Description
Returns an array of all the clusters in an account.
See https://www.paws-r-sdk.com/docs/route53recoverycontrolconfig_list_clusters/ for full documentation.
Usage
route53recoverycontrolconfig_list_clusters(MaxResults = NULL, NextToken = NULL)
Arguments
MaxResults |
The number of objects that you want to return with this call. |
NextToken |
The token that identifies which batch of results you want to see. |
Returns an array of control panels in an account or in a cluster
Description
Returns an array of control panels in an account or in a cluster.
See https://www.paws-r-sdk.com/docs/route53recoverycontrolconfig_list_control_panels/ for full documentation.
Usage
route53recoverycontrolconfig_list_control_panels(
ClusterArn = NULL,
MaxResults = NULL,
NextToken = NULL
)
Arguments
ClusterArn |
The Amazon Resource Name (ARN) of a cluster. |
MaxResults |
The number of objects that you want to return with this call. |
NextToken |
The token that identifies which batch of results you want to see. |
Returns an array of routing controls for a control panel
Description
Returns an array of routing controls for a control panel. A routing control is an Amazon Route 53 Application Recovery Controller construct that has one of two states: ON and OFF. You can map the routing control state to the state of an Amazon Route 53 health check, which can be used to control routing.
See https://www.paws-r-sdk.com/docs/route53recoverycontrolconfig_list_routing_controls/ for full documentation.
Usage
route53recoverycontrolconfig_list_routing_controls(
ControlPanelArn,
MaxResults = NULL,
NextToken = NULL
)
Arguments
ControlPanelArn |
[required] The Amazon Resource Name (ARN) of the control panel. |
MaxResults |
The number of objects that you want to return with this call. |
NextToken |
The token that identifies which batch of results you want to see. |
List the safety rules (the assertion rules and gating rules) that you've defined for the routing controls in a control panel
Description
List the safety rules (the assertion rules and gating rules) that you've defined for the routing controls in a control panel.
See https://www.paws-r-sdk.com/docs/route53recoverycontrolconfig_list_safety_rules/ for full documentation.
Usage
route53recoverycontrolconfig_list_safety_rules(
ControlPanelArn,
MaxResults = NULL,
NextToken = NULL
)
Arguments
ControlPanelArn |
[required] The Amazon Resource Name (ARN) of the control panel. |
MaxResults |
The number of objects that you want to return with this call. |
NextToken |
The token that identifies which batch of results you want to see. |
Lists the tags for a resource
Description
Lists the tags for a resource.
See https://www.paws-r-sdk.com/docs/route53recoverycontrolconfig_list_tags_for_resource/ for full documentation.
Usage
route53recoverycontrolconfig_list_tags_for_resource(ResourceArn)
Arguments
ResourceArn |
[required] The Amazon Resource Name (ARN) for the resource that's tagged. |
Adds a tag to a resource
Description
Adds a tag to a resource.
See https://www.paws-r-sdk.com/docs/route53recoverycontrolconfig_tag_resource/ for full documentation.
Usage
route53recoverycontrolconfig_tag_resource(ResourceArn, Tags)
Arguments
ResourceArn |
[required] The Amazon Resource Name (ARN) for the resource that's tagged. |
Tags |
[required] The tags associated with the resource. |
Removes a tag from a resource
Description
Removes a tag from a resource.
See https://www.paws-r-sdk.com/docs/route53recoverycontrolconfig_untag_resource/ for full documentation.
Usage
route53recoverycontrolconfig_untag_resource(ResourceArn, TagKeys)
Arguments
ResourceArn |
[required] The Amazon Resource Name (ARN) for the resource that's tagged. |
TagKeys |
[required] Keys for the tags to be removed. |
Updates a control panel
Description
Updates a control panel. The only update you can make to a control panel is to change the name of the control panel.
See https://www.paws-r-sdk.com/docs/route53recoverycontrolconfig_update_control_panel/ for full documentation.
Usage
route53recoverycontrolconfig_update_control_panel(
ControlPanelArn,
ControlPanelName
)
Arguments
ControlPanelArn |
[required] The Amazon Resource Name (ARN) of the control panel. |
ControlPanelName |
[required] The name of the control panel. |
Updates a routing control
Description
Updates a routing control. You can only update the name of the routing control. To get or update the routing control state, see the Recovery Cluster (data plane) API actions for Amazon Route 53 Application Recovery Controller.
See https://www.paws-r-sdk.com/docs/route53recoverycontrolconfig_update_routing_control/ for full documentation.
Usage
route53recoverycontrolconfig_update_routing_control(
RoutingControlArn,
RoutingControlName
)
Arguments
RoutingControlArn |
[required] The Amazon Resource Name (ARN) of the routing control. |
RoutingControlName |
[required] The name of the routing control. |
Update a safety rule (an assertion rule or gating rule)
Description
Update a safety rule (an assertion rule or gating rule). You can only update the name and the waiting period for a safety rule. To make other updates, delete the safety rule and create a new one.
See https://www.paws-r-sdk.com/docs/route53recoverycontrolconfig_update_safety_rule/ for full documentation.
Usage
route53recoverycontrolconfig_update_safety_rule(
AssertionRuleUpdate = NULL,
GatingRuleUpdate = NULL
)
Arguments
AssertionRuleUpdate |
The assertion rule to update. |
GatingRuleUpdate |
The gating rule to update. |
AWS Route53 Recovery Readiness
Description
Recovery readiness
Usage
route53recoveryreadiness(
config = list(),
credentials = list(),
endpoint = NULL,
region = NULL
)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...)
, where svc
is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- route53recoveryreadiness( config = list( credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string", close_connection = "logical", timeout = "numeric", s3_force_path_style = "logical", sts_regional_endpoint = "string" ), credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string" )
Operations
create_cell | Creates a cell in an account |
create_cross_account_authorization | Creates a cross-account readiness authorization |
create_readiness_check | Creates a readiness check in an account |
create_recovery_group | Creates a recovery group in an account |
create_resource_set | Creates a resource set |
delete_cell | Delete a cell |
delete_cross_account_authorization | Deletes cross account readiness authorization |
delete_readiness_check | Deletes a readiness check |
delete_recovery_group | Deletes a recovery group |
delete_resource_set | Deletes a resource set |
get_architecture_recommendations | Gets recommendations about architecture designs for improving resiliency for an application, based on a recovery group |
get_cell | Gets information about a cell including cell name, cell Amazon Resource Name (ARN), ARNs of nested cells for this cell, and a list of those cell ARNs with their associated recovery group ARNs |
get_cell_readiness_summary | Gets readiness for a cell |
get_readiness_check | Gets details about a readiness check |
get_readiness_check_resource_status | Gets individual readiness status for a readiness check |
get_readiness_check_status | Gets the readiness status for an individual readiness check |
get_recovery_group | Gets details about a recovery group, including a list of the cells that are included in it |
get_recovery_group_readiness_summary | Displays a summary of information about a recovery group's readiness status |
get_resource_set | Displays the details about a resource set, including a list of the resources in the set |
list_cells | Lists the cells for an account |
list_cross_account_authorizations | Lists the cross-account readiness authorizations that are in place for an account |
list_readiness_checks | Lists the readiness checks for an account |
list_recovery_groups | Lists the recovery groups in an account |
list_resource_sets | Lists the resource sets in an account |
list_rules | Lists all readiness rules, or lists the readiness rules for a specific resource type |
list_tags_for_resources | Lists the tags for a resource |
tag_resource | Adds a tag to a resource |
untag_resource | Removes a tag from a resource |
update_cell | Updates a cell to replace the list of nested cells with a new list of nested cells |
update_readiness_check | Updates a readiness check |
update_recovery_group | Updates a recovery group |
update_resource_set | Updates a resource set |
Examples
## Not run:
svc <- route53recoveryreadiness()
svc$create_cell(
Foo = 123
)
## End(Not run)
Creates a cell in an account
Description
Creates a cell in an account.
See https://www.paws-r-sdk.com/docs/route53recoveryreadiness_create_cell/ for full documentation.
Usage
route53recoveryreadiness_create_cell(CellName, Cells = NULL, Tags = NULL)
Arguments
CellName |
[required] The name of the cell to create. |
Cells |
A list of cell Amazon Resource Names (ARNs) contained within this cell, for use in nested cells. For example, Availability Zones within specific Amazon Web Services Regions. |
Tags |
Creates a cross-account readiness authorization
Description
Creates a cross-account readiness authorization. This lets you authorize another account to work with Route 53 Application Recovery Controller, for example, to check the readiness status of resources in a separate account.
See https://www.paws-r-sdk.com/docs/route53recoveryreadiness_create_cross_account_authorization/ for full documentation.
Usage
route53recoveryreadiness_create_cross_account_authorization(
CrossAccountAuthorization
)
Arguments
CrossAccountAuthorization |
[required] The cross-account authorization. |
Creates a readiness check in an account
Description
Creates a readiness check in an account. A readiness check monitors a resource set in your application, such as a set of Amazon Aurora instances, that Application Recovery Controller is auditing recovery readiness for. The audits run once every minute on every resource that's associated with a readiness check.
See https://www.paws-r-sdk.com/docs/route53recoveryreadiness_create_readiness_check/ for full documentation.
Usage
route53recoveryreadiness_create_readiness_check(
ReadinessCheckName,
ResourceSetName,
Tags = NULL
)
Arguments
ReadinessCheckName |
[required] The name of the readiness check to create. |
ResourceSetName |
[required] The name of the resource set to check. |
Tags |
Creates a recovery group in an account
Description
Creates a recovery group in an account. A recovery group corresponds to an application and includes a list of the cells that make up the application.
See https://www.paws-r-sdk.com/docs/route53recoveryreadiness_create_recovery_group/ for full documentation.
Usage
route53recoveryreadiness_create_recovery_group(
Cells = NULL,
RecoveryGroupName,
Tags = NULL
)
Arguments
Cells |
A list of the cell Amazon Resource Names (ARNs) in the recovery group. |
RecoveryGroupName |
[required] The name of the recovery group to create. |
Tags |
Creates a resource set
Description
Creates a resource set. A resource set is a set of resources of one type that span multiple cells. You can associate a resource set with a readiness check to monitor the resources for failover readiness.
See https://www.paws-r-sdk.com/docs/route53recoveryreadiness_create_resource_set/ for full documentation.
Usage
route53recoveryreadiness_create_resource_set(
ResourceSetName,
ResourceSetType,
Resources,
Tags = NULL
)
Arguments
ResourceSetName |
[required] The name of the resource set to create. |
ResourceSetType |
[required] The resource type of the resources in the resource set. Enter one of the following values for resource type: AWS::ApiGateway::Stage, AWS::ApiGatewayV2::Stage, AWS::AutoScaling::AutoScalingGroup, AWS::CloudWatch::Alarm, AWS::EC2::CustomerGateway, AWS::DynamoDB::Table, AWS::EC2::Volume, AWS::ElasticLoadBalancing::LoadBalancer, AWS::ElasticLoadBalancingV2::LoadBalancer, AWS::Lambda::Function, AWS::MSK::Cluster, AWS::RDS::DBCluster, AWS::Route53::HealthCheck, AWS::SQS::Queue, AWS::SNS::Topic, AWS::SNS::Subscription, AWS::EC2::VPC, AWS::EC2::VPNConnection, AWS::EC2::VPNGateway, AWS::Route53RecoveryReadiness::DNSTargetResource |
Resources |
[required] A list of resource objects in the resource set. |
Tags |
A tag to associate with the parameters for a resource set. |
Delete a cell
Description
Delete a cell. When successful, the response code is 204, with no response body.
See https://www.paws-r-sdk.com/docs/route53recoveryreadiness_delete_cell/ for full documentation.
Usage
route53recoveryreadiness_delete_cell(CellName)
Arguments
CellName |
[required] The name of the cell. |
Deletes cross account readiness authorization
Description
Deletes cross account readiness authorization.
See https://www.paws-r-sdk.com/docs/route53recoveryreadiness_delete_cross_account_authorization/ for full documentation.
Usage
route53recoveryreadiness_delete_cross_account_authorization(
CrossAccountAuthorization
)
Arguments
CrossAccountAuthorization |
[required] The cross-account authorization. |
Deletes a readiness check
Description
Deletes a readiness check.
See https://www.paws-r-sdk.com/docs/route53recoveryreadiness_delete_readiness_check/ for full documentation.
Usage
route53recoveryreadiness_delete_readiness_check(ReadinessCheckName)
Arguments
ReadinessCheckName |
[required] Name of a readiness check. |
Deletes a recovery group
Description
Deletes a recovery group.
See https://www.paws-r-sdk.com/docs/route53recoveryreadiness_delete_recovery_group/ for full documentation.
Usage
route53recoveryreadiness_delete_recovery_group(RecoveryGroupName)
Arguments
RecoveryGroupName |
[required] The name of a recovery group. |
Deletes a resource set
Description
Deletes a resource set.
See https://www.paws-r-sdk.com/docs/route53recoveryreadiness_delete_resource_set/ for full documentation.
Usage
route53recoveryreadiness_delete_resource_set(ResourceSetName)
Arguments
ResourceSetName |
[required] Name of a resource set. |
Gets recommendations about architecture designs for improving resiliency for an application, based on a recovery group
Description
Gets recommendations about architecture designs for improving resiliency for an application, based on a recovery group.
See https://www.paws-r-sdk.com/docs/route53recoveryreadiness_get_architecture_recommendations/ for full documentation.
Usage
route53recoveryreadiness_get_architecture_recommendations(
MaxResults = NULL,
NextToken = NULL,
RecoveryGroupName
)
Arguments
MaxResults |
The number of objects that you want to return with this call. |
NextToken |
The token that identifies which batch of results you want to see. |
RecoveryGroupName |
[required] The name of a recovery group. |
Gets information about a cell including cell name, cell Amazon Resource Name (ARN), ARNs of nested cells for this cell, and a list of those cell ARNs with their associated recovery group ARNs
Description
Gets information about a cell including cell name, cell Amazon Resource Name (ARN), ARNs of nested cells for this cell, and a list of those cell ARNs with their associated recovery group ARNs.
See https://www.paws-r-sdk.com/docs/route53recoveryreadiness_get_cell/ for full documentation.
Usage
route53recoveryreadiness_get_cell(CellName)
Arguments
CellName |
[required] The name of the cell. |
Gets readiness for a cell
Description
Gets readiness for a cell. Aggregates the readiness of all the resources that are associated with the cell into a single value.
See https://www.paws-r-sdk.com/docs/route53recoveryreadiness_get_cell_readiness_summary/ for full documentation.
Usage
route53recoveryreadiness_get_cell_readiness_summary(
CellName,
MaxResults = NULL,
NextToken = NULL
)
Arguments
CellName |
[required] The name of the cell. |
MaxResults |
The number of objects that you want to return with this call. |
NextToken |
The token that identifies which batch of results you want to see. |
Gets details about a readiness check
Description
Gets details about a readiness check.
See https://www.paws-r-sdk.com/docs/route53recoveryreadiness_get_readiness_check/ for full documentation.
Usage
route53recoveryreadiness_get_readiness_check(ReadinessCheckName)
Arguments
ReadinessCheckName |
[required] Name of a readiness check. |
Gets individual readiness status for a readiness check
Description
Gets individual readiness status for a readiness check. To see the overall readiness status for a recovery group, that considers the readiness status for all the readiness checks in the recovery group, use GetRecoveryGroupReadinessSummary.
See https://www.paws-r-sdk.com/docs/route53recoveryreadiness_get_readiness_check_resource_status/ for full documentation.
Usage
route53recoveryreadiness_get_readiness_check_resource_status(
MaxResults = NULL,
NextToken = NULL,
ReadinessCheckName,
ResourceIdentifier
)
Arguments
MaxResults |
The number of objects that you want to return with this call. |
NextToken |
The token that identifies which batch of results you want to see. |
ReadinessCheckName |
[required] Name of a readiness check. |
ResourceIdentifier |
[required] The resource identifier, which is the Amazon Resource Name (ARN) or the identifier generated for the resource by Application Recovery Controller (for example, for a DNS target resource). |
Gets the readiness status for an individual readiness check
Description
Gets the readiness status for an individual readiness check. To see the overall readiness status for a recovery group, that considers the readiness status for all the readiness checks in a recovery group, use GetRecoveryGroupReadinessSummary.
See https://www.paws-r-sdk.com/docs/route53recoveryreadiness_get_readiness_check_status/ for full documentation.
Usage
route53recoveryreadiness_get_readiness_check_status(
MaxResults = NULL,
NextToken = NULL,
ReadinessCheckName
)
Arguments
MaxResults |
The number of objects that you want to return with this call. |
NextToken |
The token that identifies which batch of results you want to see. |
ReadinessCheckName |
[required] Name of a readiness check. |
Gets details about a recovery group, including a list of the cells that are included in it
Description
Gets details about a recovery group, including a list of the cells that are included in it.
See https://www.paws-r-sdk.com/docs/route53recoveryreadiness_get_recovery_group/ for full documentation.
Usage
route53recoveryreadiness_get_recovery_group(RecoveryGroupName)
Arguments
RecoveryGroupName |
[required] The name of a recovery group. |
Displays a summary of information about a recovery group's readiness status
Description
Displays a summary of information about a recovery group's readiness status. Includes the readiness checks for resources in the recovery group and the readiness status of each one.
See https://www.paws-r-sdk.com/docs/route53recoveryreadiness_get_recovery_group_readiness_summary/ for full documentation.
Usage
route53recoveryreadiness_get_recovery_group_readiness_summary(
MaxResults = NULL,
NextToken = NULL,
RecoveryGroupName
)
Arguments
MaxResults |
The number of objects that you want to return with this call. |
NextToken |
The token that identifies which batch of results you want to see. |
RecoveryGroupName |
[required] The name of a recovery group. |
Displays the details about a resource set, including a list of the resources in the set
Description
Displays the details about a resource set, including a list of the resources in the set.
See https://www.paws-r-sdk.com/docs/route53recoveryreadiness_get_resource_set/ for full documentation.
Usage
route53recoveryreadiness_get_resource_set(ResourceSetName)
Arguments
ResourceSetName |
[required] Name of a resource set. |
Lists the cells for an account
Description
Lists the cells for an account.
See https://www.paws-r-sdk.com/docs/route53recoveryreadiness_list_cells/ for full documentation.
Usage
route53recoveryreadiness_list_cells(MaxResults = NULL, NextToken = NULL)
Arguments
MaxResults |
The number of objects that you want to return with this call. |
NextToken |
The token that identifies which batch of results you want to see. |
Lists the cross-account readiness authorizations that are in place for an account
Description
Lists the cross-account readiness authorizations that are in place for an account.
See https://www.paws-r-sdk.com/docs/route53recoveryreadiness_list_cross_account_authorizations/ for full documentation.
Usage
route53recoveryreadiness_list_cross_account_authorizations(
MaxResults = NULL,
NextToken = NULL
)
Arguments
MaxResults |
The number of objects that you want to return with this call. |
NextToken |
The token that identifies which batch of results you want to see. |
Lists the readiness checks for an account
Description
Lists the readiness checks for an account.
See https://www.paws-r-sdk.com/docs/route53recoveryreadiness_list_readiness_checks/ for full documentation.
Usage
route53recoveryreadiness_list_readiness_checks(
MaxResults = NULL,
NextToken = NULL
)
Arguments
MaxResults |
The number of objects that you want to return with this call. |
NextToken |
The token that identifies which batch of results you want to see. |
Lists the recovery groups in an account
Description
Lists the recovery groups in an account.
See https://www.paws-r-sdk.com/docs/route53recoveryreadiness_list_recovery_groups/ for full documentation.
Usage
route53recoveryreadiness_list_recovery_groups(
MaxResults = NULL,
NextToken = NULL
)
Arguments
MaxResults |
The number of objects that you want to return with this call. |
NextToken |
The token that identifies which batch of results you want to see. |
Lists the resource sets in an account
Description
Lists the resource sets in an account.
See https://www.paws-r-sdk.com/docs/route53recoveryreadiness_list_resource_sets/ for full documentation.
Usage
route53recoveryreadiness_list_resource_sets(
MaxResults = NULL,
NextToken = NULL
)
Arguments
MaxResults |
The number of objects that you want to return with this call. |
NextToken |
The token that identifies which batch of results you want to see. |
Lists all readiness rules, or lists the readiness rules for a specific resource type
Description
Lists all readiness rules, or lists the readiness rules for a specific resource type.
See https://www.paws-r-sdk.com/docs/route53recoveryreadiness_list_rules/ for full documentation.
Usage
route53recoveryreadiness_list_rules(
MaxResults = NULL,
NextToken = NULL,
ResourceType = NULL
)
Arguments
MaxResults |
The number of objects that you want to return with this call. |
NextToken |
The token that identifies which batch of results you want to see. |
ResourceType |
The resource type that a readiness rule applies to. |
Lists the tags for a resource
Description
Lists the tags for a resource.
See https://www.paws-r-sdk.com/docs/route53recoveryreadiness_list_tags_for_resources/ for full documentation.
Usage
route53recoveryreadiness_list_tags_for_resources(ResourceArn)
Arguments
ResourceArn |
[required] The Amazon Resource Name (ARN) for a resource. |
Adds a tag to a resource
Description
Adds a tag to a resource.
See https://www.paws-r-sdk.com/docs/route53recoveryreadiness_tag_resource/ for full documentation.
Usage
route53recoveryreadiness_tag_resource(ResourceArn, Tags)
Arguments
ResourceArn |
[required] The Amazon Resource Name (ARN) for a resource. |
Tags |
[required] |
Removes a tag from a resource
Description
Removes a tag from a resource.
See https://www.paws-r-sdk.com/docs/route53recoveryreadiness_untag_resource/ for full documentation.
Usage
route53recoveryreadiness_untag_resource(ResourceArn, TagKeys)
Arguments
ResourceArn |
[required] The Amazon Resource Name (ARN) for a resource. |
TagKeys |
[required] The keys for tags you add to resources. |
Updates a cell to replace the list of nested cells with a new list of nested cells
Description
Updates a cell to replace the list of nested cells with a new list of nested cells.
See https://www.paws-r-sdk.com/docs/route53recoveryreadiness_update_cell/ for full documentation.
Usage
route53recoveryreadiness_update_cell(CellName, Cells)
Arguments
CellName |
[required] The name of the cell. |
Cells |
[required] A list of cell Amazon Resource Names (ARNs), which completely replaces the previous list. |
Updates a readiness check
Description
Updates a readiness check.
See https://www.paws-r-sdk.com/docs/route53recoveryreadiness_update_readiness_check/ for full documentation.
Usage
route53recoveryreadiness_update_readiness_check(
ReadinessCheckName,
ResourceSetName
)
Arguments
ReadinessCheckName |
[required] Name of a readiness check. |
ResourceSetName |
[required] The name of the resource set to be checked. |
Updates a recovery group
Description
Updates a recovery group.
See https://www.paws-r-sdk.com/docs/route53recoveryreadiness_update_recovery_group/ for full documentation.
Usage
route53recoveryreadiness_update_recovery_group(Cells, RecoveryGroupName)
Arguments
Cells |
[required] A list of cell Amazon Resource Names (ARNs). This list completely replaces the previous list. |
RecoveryGroupName |
[required] The name of a recovery group. |
Updates a resource set
Description
Updates a resource set.
See https://www.paws-r-sdk.com/docs/route53recoveryreadiness_update_resource_set/ for full documentation.
Usage
route53recoveryreadiness_update_resource_set(
ResourceSetName,
ResourceSetType,
Resources
)
Arguments
ResourceSetName |
[required] Name of a resource set. |
ResourceSetType |
[required] The resource type of the resources in the resource set. Enter one of the following values for resource type: AWS::ApiGateway::Stage, AWS::ApiGatewayV2::Stage, AWS::AutoScaling::AutoScalingGroup, AWS::CloudWatch::Alarm, AWS::EC2::CustomerGateway, AWS::DynamoDB::Table, AWS::EC2::Volume, AWS::ElasticLoadBalancing::LoadBalancer, AWS::ElasticLoadBalancingV2::LoadBalancer, AWS::Lambda::Function, AWS::MSK::Cluster, AWS::RDS::DBCluster, AWS::Route53::HealthCheck, AWS::SQS::Queue, AWS::SNS::Topic, AWS::SNS::Subscription, AWS::EC2::VPC, AWS::EC2::VPNConnection, AWS::EC2::VPNGateway, AWS::Route53RecoveryReadiness::DNSTargetResource |
Resources |
[required] A list of resource objects. |
Amazon Route 53 Resolver
Description
When you create a VPC using Amazon VPC, you automatically get DNS resolution within the VPC from Route 53 Resolver. By default, Resolver answers DNS queries for VPC domain names such as domain names for EC2 instances or Elastic Load Balancing load balancers. Resolver performs recursive lookups against public name servers for all other domain names.
You can also configure DNS resolution between your VPC and your network over a Direct Connect or VPN connection:
Forward DNS queries from resolvers on your network to Route 53 Resolver
DNS resolvers on your network can forward DNS queries to Resolver in a specified VPC. This allows your DNS resolvers to easily resolve domain names for Amazon Web Services resources such as EC2 instances or records in a Route 53 private hosted zone. For more information, see How DNS Resolvers on Your Network Forward DNS Queries to Route 53 Resolver in the Amazon Route 53 Developer Guide.
Conditionally forward queries from a VPC to resolvers on your network
You can configure Resolver to forward queries that it receives from EC2 instances in your VPCs to DNS resolvers on your network. To forward selected queries, you create Resolver rules that specify the domain names for the DNS queries that you want to forward (such as example.com), and the IP addresses of the DNS resolvers on your network that you want to forward the queries to. If a query matches multiple rules (example.com, acme.example.com), Resolver chooses the rule with the most specific match (acme.example.com) and forwards the query to the IP addresses that you specified in that rule. For more information, see How Route 53 Resolver Forwards DNS Queries from Your VPCs to Your Network in the Amazon Route 53 Developer Guide.
Like Amazon VPC, Resolver is Regional. In each Region where you have VPCs, you can choose whether to forward queries from your VPCs to your network (outbound queries), from your network to your VPCs (inbound queries), or both.
Usage
route53resolver(
config = list(),
credentials = list(),
endpoint = NULL,
region = NULL
)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...)
, where svc
is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- route53resolver( config = list( credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string", close_connection = "logical", timeout = "numeric", s3_force_path_style = "logical", sts_regional_endpoint = "string" ), credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string" )
Operations
associate_firewall_rule_group | Associates a FirewallRuleGroup with a VPC, to provide DNS filtering for the VPC |
associate_resolver_endpoint_ip_address | Adds IP addresses to an inbound or an outbound Resolver endpoint |
associate_resolver_query_log_config | Associates an Amazon VPC with a specified query logging configuration |
associate_resolver_rule | Associates a Resolver rule with a VPC |
create_firewall_domain_list | Creates an empty firewall domain list for use in DNS Firewall rules |
create_firewall_rule | Creates a single DNS Firewall rule in the specified rule group, using the specified domain list |
create_firewall_rule_group | Creates an empty DNS Firewall rule group for filtering DNS network traffic in a VPC |
create_outpost_resolver | Creates a Route 53 Resolver on an Outpost |
create_resolver_endpoint | Creates a Resolver endpoint |
create_resolver_query_log_config | Creates a Resolver query logging configuration, which defines where you want Resolver to save DNS query logs that originate in your VPCs |
create_resolver_rule | For DNS queries that originate in your VPCs, specifies which Resolver endpoint the queries pass through, one domain name that you want to forward to your network, and the IP addresses of the DNS resolvers in your network |
delete_firewall_domain_list | Deletes the specified domain list |
delete_firewall_rule | Deletes the specified firewall rule |
delete_firewall_rule_group | Deletes the specified firewall rule group |
delete_outpost_resolver | Deletes a Resolver on the Outpost |
delete_resolver_endpoint | Deletes a Resolver endpoint |
delete_resolver_query_log_config | Deletes a query logging configuration |
delete_resolver_rule | Deletes a Resolver rule |
disassociate_firewall_rule_group | Disassociates a FirewallRuleGroup from a VPC, to remove DNS filtering from the VPC |
disassociate_resolver_endpoint_ip_address | Removes IP addresses from an inbound or an outbound Resolver endpoint |
disassociate_resolver_query_log_config | Disassociates a VPC from a query logging configuration |
disassociate_resolver_rule | Removes the association between a specified Resolver rule and a specified VPC |
get_firewall_config | Retrieves the configuration of the firewall behavior provided by DNS Firewall for a single VPC from Amazon Virtual Private Cloud (Amazon VPC) |
get_firewall_domain_list | Retrieves the specified firewall domain list |
get_firewall_rule_group | Retrieves the specified firewall rule group |
get_firewall_rule_group_association | Retrieves a firewall rule group association, which enables DNS filtering for a VPC with one rule group |
get_firewall_rule_group_policy | Returns the Identity and Access Management (Amazon Web Services IAM) policy for sharing the specified rule group |
get_outpost_resolver | Gets information about a specified Resolver on the Outpost, such as its instance count and type, name, and the current status of the Resolver |
get_resolver_config | Retrieves the behavior configuration of Route 53 Resolver behavior for a single VPC from Amazon Virtual Private Cloud |
get_resolver_dnssec_config | Gets DNSSEC validation information for a specified resource |
get_resolver_endpoint | Gets information about a specified Resolver endpoint, such as whether it's an inbound or an outbound Resolver endpoint, and the current status of the endpoint |
get_resolver_query_log_config | Gets information about a specified Resolver query logging configuration, such as the number of VPCs that the configuration is logging queries for and the location that logs are sent to |
get_resolver_query_log_config_association | Gets information about a specified association between a Resolver query logging configuration and an Amazon VPC |
get_resolver_query_log_config_policy | Gets information about a query logging policy |
get_resolver_rule | Gets information about a specified Resolver rule, such as the domain name that the rule forwards DNS queries for and the ID of the outbound Resolver endpoint that the rule is associated with |
get_resolver_rule_association | Gets information about an association between a specified Resolver rule and a VPC |
get_resolver_rule_policy | Gets information about the Resolver rule policy for a specified rule |
import_firewall_domains | Imports domain names from a file into a domain list, for use in a DNS firewall rule group |
list_firewall_configs | Retrieves the firewall configurations that you have defined |
list_firewall_domain_lists | Retrieves the firewall domain lists that you have defined |
list_firewall_domains | Retrieves the domains that you have defined for the specified firewall domain list |
list_firewall_rule_group_associations | Retrieves the firewall rule group associations that you have defined |
list_firewall_rule_groups | Retrieves the minimal high-level information for the rule groups that you have defined |
list_firewall_rules | Retrieves the firewall rules that you have defined for the specified firewall rule group |
list_outpost_resolvers | Lists all the Resolvers on Outposts that were created using the current Amazon Web Services account |
list_resolver_configs | Retrieves the Resolver configurations that you have defined |
list_resolver_dnssec_configs | Lists the configurations for DNSSEC validation that are associated with the current Amazon Web Services account |
list_resolver_endpoint_ip_addresses | Gets the IP addresses for a specified Resolver endpoint |
list_resolver_endpoints | Lists all the Resolver endpoints that were created using the current Amazon Web Services account |
list_resolver_query_log_config_associations | Lists information about associations between Amazon VPCs and query logging configurations |
list_resolver_query_log_configs | Lists information about the specified query logging configurations |
list_resolver_rule_associations | Lists the associations that were created between Resolver rules and VPCs using the current Amazon Web Services account |
list_resolver_rules | Lists the Resolver rules that were created using the current Amazon Web Services account |
list_tags_for_resource | Lists the tags that you associated with the specified resource |
put_firewall_rule_group_policy | Attaches an Identity and Access Management (Amazon Web Services IAM) policy for sharing the rule group |
put_resolver_query_log_config_policy | Specifies an Amazon Web Services account that you want to share a query logging configuration with, the query logging configuration that you want to share, and the operations that you want the account to be able to perform on the configuration |
put_resolver_rule_policy | Specifies an Amazon Web Services rule that you want to share with another account, the account that you want to share the rule with, and the operations that you want the account to be able to perform on the rule |
tag_resource | Adds one or more tags to a specified resource |
untag_resource | Removes one or more tags from a specified resource |
update_firewall_config | Updates the configuration of the firewall behavior provided by DNS Firewall for a single VPC from Amazon Virtual Private Cloud (Amazon VPC) |
update_firewall_domains | Updates the firewall domain list from an array of domain specifications |
update_firewall_rule | Updates the specified firewall rule |
update_firewall_rule_group_association | Changes the association of a FirewallRuleGroup with a VPC |
update_outpost_resolver | You can use UpdateOutpostResolver to update the instance count, type, or name of a Resolver on an Outpost |
update_resolver_config | Updates the behavior configuration of Route 53 Resolver behavior for a single VPC from Amazon Virtual Private Cloud |
update_resolver_dnssec_config | Updates an existing DNSSEC validation configuration |
update_resolver_endpoint | Updates the name, or endpoint type for an inbound or an outbound Resolver endpoint |
update_resolver_rule | Updates settings for a specified Resolver rule |
Examples
## Not run:
svc <- route53resolver()
svc$associate_firewall_rule_group(
Foo = 123
)
## End(Not run)
Associates a FirewallRuleGroup with a VPC, to provide DNS filtering for the VPC
Description
Associates a FirewallRuleGroup with a VPC, to provide DNS filtering for the VPC.
See https://www.paws-r-sdk.com/docs/route53resolver_associate_firewall_rule_group/ for full documentation.
Usage
route53resolver_associate_firewall_rule_group(
CreatorRequestId,
FirewallRuleGroupId,
VpcId,
Priority,
Name,
MutationProtection = NULL,
Tags = NULL
)
Arguments
CreatorRequestId |
[required] A unique string that identifies the request and that allows failed
requests to be retried without the risk of running the operation twice.
|
FirewallRuleGroupId |
[required] The unique identifier of the firewall rule group. |
VpcId |
[required] The unique identifier of the VPC that you want to associate with the rule group. |
Priority |
[required] The setting that determines the processing order of the rule group among the rule groups that you associate with the specified VPC. DNS Firewall filters VPC traffic starting from the rule group with the lowest numeric priority setting. You must specify a unique priority for each rule group that you associate with a single VPC. To make it easier to insert rule groups later, leave space between the numbers, for example, use 101, 200, and so on. You can change the priority setting for a rule group association after you create it. The allowed values for |
Name |
[required] A name that lets you identify the association, to manage and use it. |
MutationProtection |
If enabled, this setting disallows modification or removal of the
association, to help prevent against accidentally altering DNS firewall
protections. When you create the association, the default setting is
|
Tags |
A list of the tag keys and values that you want to associate with the rule group association. |
Adds IP addresses to an inbound or an outbound Resolver endpoint
Description
Adds IP addresses to an inbound or an outbound Resolver endpoint. If you want to add more than one IP address, submit one associate_resolver_endpoint_ip_address
request for each IP address.
See https://www.paws-r-sdk.com/docs/route53resolver_associate_resolver_endpoint_ip_address/ for full documentation.
Usage
route53resolver_associate_resolver_endpoint_ip_address(
ResolverEndpointId,
IpAddress
)
Arguments
ResolverEndpointId |
[required] The ID of the Resolver endpoint that you want to associate IP addresses with. |
IpAddress |
[required] Either the IPv4 address that you want to add to a Resolver endpoint or a subnet ID. If you specify a subnet ID, Resolver chooses an IP address for you from the available IPs in the specified subnet. |
Associates an Amazon VPC with a specified query logging configuration
Description
Associates an Amazon VPC with a specified query logging configuration. Route 53 Resolver logs DNS queries that originate in all of the Amazon VPCs that are associated with a specified query logging configuration. To associate more than one VPC with a configuration, submit one associate_resolver_query_log_config
request for each VPC.
See https://www.paws-r-sdk.com/docs/route53resolver_associate_resolver_query_log_config/ for full documentation.
Usage
route53resolver_associate_resolver_query_log_config(
ResolverQueryLogConfigId,
ResourceId
)
Arguments
ResolverQueryLogConfigId |
[required] The ID of the query logging configuration that you want to associate a VPC with. |
ResourceId |
[required] The ID of an Amazon VPC that you want this query logging configuration to log queries for. The VPCs and the query logging configuration must be in the same Region. |
Associates a Resolver rule with a VPC
Description
Associates a Resolver rule with a VPC. When you associate a rule with a VPC, Resolver forwards all DNS queries for the domain name that is specified in the rule and that originate in the VPC. The queries are forwarded to the IP addresses for the DNS resolvers that are specified in the rule. For more information about rules, see create_resolver_rule
.
See https://www.paws-r-sdk.com/docs/route53resolver_associate_resolver_rule/ for full documentation.
Usage
route53resolver_associate_resolver_rule(ResolverRuleId, Name = NULL, VPCId)
Arguments
ResolverRuleId |
[required] The ID of the Resolver rule that you want to associate with the VPC. To
list the existing Resolver rules, use
|
Name |
A name for the association that you're creating between a Resolver rule and a VPC. |
VPCId |
[required] The ID of the VPC that you want to associate the Resolver rule with. |
Creates an empty firewall domain list for use in DNS Firewall rules
Description
Creates an empty firewall domain list for use in DNS Firewall rules. You can populate the domains for the new list with a file, using import_firewall_domains
, or with domain strings, using update_firewall_domains
.
See https://www.paws-r-sdk.com/docs/route53resolver_create_firewall_domain_list/ for full documentation.
Usage
route53resolver_create_firewall_domain_list(
CreatorRequestId,
Name,
Tags = NULL
)
Arguments
CreatorRequestId |
[required] A unique string that identifies the request and that allows you to retry
failed requests without the risk of running the operation twice.
|
Name |
[required] A name that lets you identify the domain list to manage and use it. |
Tags |
A list of the tag keys and values that you want to associate with the domain list. |
Creates a single DNS Firewall rule in the specified rule group, using the specified domain list
Description
Creates a single DNS Firewall rule in the specified rule group, using the specified domain list.
See https://www.paws-r-sdk.com/docs/route53resolver_create_firewall_rule/ for full documentation.
Usage
route53resolver_create_firewall_rule(
CreatorRequestId,
FirewallRuleGroupId,
FirewallDomainListId = NULL,
Priority,
Action,
BlockResponse = NULL,
BlockOverrideDomain = NULL,
BlockOverrideDnsType = NULL,
BlockOverrideTtl = NULL,
Name,
FirewallDomainRedirectionAction = NULL,
Qtype = NULL,
DnsThreatProtection = NULL,
ConfidenceThreshold = NULL
)
Arguments
CreatorRequestId |
[required] A unique string that identifies the request and that allows you to retry
failed requests without the risk of running the operation twice.
|
FirewallRuleGroupId |
[required] The unique identifier of the firewall rule group where you want to create the rule. |
FirewallDomainListId |
The ID of the domain list that you want to use in the rule. Can't be
used together with |
Priority |
[required] The setting that determines the processing order of the rule in the rule group. DNS Firewall processes the rules in a rule group by order of priority, starting from the lowest setting. You must specify a unique priority for each rule in a rule group. To make it easier to insert rules later, leave space between the numbers, for example, use 100, 200, and so on. You can change the priority setting for the rules in a rule group at any time. |
Action |
[required] The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule's domain list, or a threat in a DNS Firewall Advanced rule:
|
BlockResponse |
The way that you want DNS Firewall to block the request, used with the
rule action setting
This setting is required if the rule action setting is |
BlockOverrideDomain |
The custom DNS record to send back in response to the query. Used for
the rule action This setting is required if the |
BlockOverrideDnsType |
The DNS record's type. This determines the format of the record value
that you provided in This setting is required if the |
BlockOverrideTtl |
The recommended amount of time, in seconds, for the DNS resolver or web
browser to cache the provided override record. Used for the rule action
This setting is required if the |
Name |
[required] A name that lets you identify the rule in the rule group. |
FirewallDomainRedirectionAction |
How you want the the rule to evaluate DNS redirection in the DNS redirection chain, such as CNAME or DNAME.
|
Qtype |
The DNS query type you want the rule to evaluate. Allowed values are;
|
DnsThreatProtection |
Use to create a DNS Firewall Advanced rule. |
ConfidenceThreshold |
The confidence threshold for DNS Firewall Advanced. You must provide this value when you create a DNS Firewall Advanced rule. The confidence level values mean:
|
Creates an empty DNS Firewall rule group for filtering DNS network traffic in a VPC
Description
Creates an empty DNS Firewall rule group for filtering DNS network traffic in a VPC. You can add rules to the new rule group by calling create_firewall_rule
.
See https://www.paws-r-sdk.com/docs/route53resolver_create_firewall_rule_group/ for full documentation.
Usage
route53resolver_create_firewall_rule_group(CreatorRequestId, Name, Tags = NULL)
Arguments
CreatorRequestId |
[required] A unique string defined by you to identify the request. This allows you to retry failed requests without the risk of running the operation twice. This can be any unique string, for example, a timestamp. |
Name |
[required] A name that lets you identify the rule group, to manage and use it. |
Tags |
A list of the tag keys and values that you want to associate with the rule group. |
Creates a Route 53 Resolver on an Outpost
Description
Creates a Route 53 Resolver on an Outpost.
See https://www.paws-r-sdk.com/docs/route53resolver_create_outpost_resolver/ for full documentation.
Usage
route53resolver_create_outpost_resolver(
CreatorRequestId,
Name,
InstanceCount = NULL,
PreferredInstanceType,
OutpostArn,
Tags = NULL
)
Arguments
CreatorRequestId |
[required] A unique string that identifies the request and that allows failed requests to be retried without the risk of running the operation twice.
|
Name |
[required] A friendly name that lets you easily find a configuration in the Resolver dashboard in the Route 53 console. |
InstanceCount |
Number of Amazon EC2 instances for the Resolver on Outpost. The default and minimal value is 4. |
PreferredInstanceType |
[required] The Amazon EC2 instance type. If you specify this, you must also specify
a value for the |
OutpostArn |
[required] The Amazon Resource Name (ARN) of the Outpost. If you specify this, you
must also specify a value for the |
Tags |
A string that helps identify the Route 53 Resolvers on Outpost. |
Creates a Resolver endpoint
Description
Creates a Resolver endpoint. There are two types of Resolver endpoints, inbound and outbound:
See https://www.paws-r-sdk.com/docs/route53resolver_create_resolver_endpoint/ for full documentation.
Usage
route53resolver_create_resolver_endpoint(
CreatorRequestId,
Name = NULL,
SecurityGroupIds,
Direction,
IpAddresses,
OutpostArn = NULL,
PreferredInstanceType = NULL,
Tags = NULL,
ResolverEndpointType = NULL,
Protocols = NULL
)
Arguments
CreatorRequestId |
[required] A unique string that identifies the request and that allows failed
requests to be retried without the risk of running the operation twice.
|
Name |
A friendly name that lets you easily find a configuration in the Resolver dashboard in the Route 53 console. |
SecurityGroupIds |
[required] The ID of one or more security groups that you want to use to control access to this VPC. The security group that you specify must include one or more inbound rules (for inbound Resolver endpoints) or outbound rules (for outbound Resolver endpoints). Inbound and outbound rules must allow TCP and UDP access. For inbound access, open port 53. For outbound access, open the port that you're using for DNS queries on your network. Some security group rules will cause your connection to be tracked. For outbound resolver endpoint, it can potentially impact the maximum queries per second from outbound endpoint to your target name server. For inbound resolver endpoint, it can bring down the overall maximum queries per second per IP address to as low as 1500. To avoid connection tracking caused by security group, see Untracked connections. |
Direction |
[required] Specify the applicable value:
|
IpAddresses |
[required] The subnets and IP addresses in your VPC that DNS queries originate from (for outbound endpoints) or that you forward DNS queries to (for inbound endpoints). The subnet ID uniquely identifies a VPC. Even though the minimum is 1, Route 53 requires that you create at least two. |
OutpostArn |
The Amazon Resource Name (ARN) of the Outpost. If you specify this, you
must also specify a value for the |
PreferredInstanceType |
The instance type. If you specify this, you must also specify a value
for the |
Tags |
A list of the tag keys and values that you want to associate with the endpoint. |
ResolverEndpointType |
For the endpoint type you can choose either IPv4, IPv6, or dual-stack. A dual-stack endpoint means that it will resolve via both IPv4 and IPv6. This endpoint type is applied to all IP addresses. |
Protocols |
The protocols you want to use for the endpoint. DoH-FIPS is applicable for inbound endpoints only. For an inbound endpoint you can apply the protocols as follows:
For an outbound endpoint you can apply the protocols as follows:
|
Creates a Resolver query logging configuration, which defines where you want Resolver to save DNS query logs that originate in your VPCs
Description
Creates a Resolver query logging configuration, which defines where you want Resolver to save DNS query logs that originate in your VPCs. Resolver can log queries only for VPCs that are in the same Region as the query logging configuration.
See https://www.paws-r-sdk.com/docs/route53resolver_create_resolver_query_log_config/ for full documentation.
Usage
route53resolver_create_resolver_query_log_config(
Name,
DestinationArn,
CreatorRequestId,
Tags = NULL
)
Arguments
Name |
[required] The name that you want to give the query logging configuration. |
DestinationArn |
[required] The ARN of the resource that you want Resolver to send query logs. You can send query logs to an S3 bucket, a CloudWatch Logs log group, or a Kinesis Data Firehose delivery stream. Examples of valid values include the following:
|
CreatorRequestId |
[required] A unique string that identifies the request and that allows failed
requests to be retried without the risk of running the operation twice.
|
Tags |
A list of the tag keys and values that you want to associate with the query logging configuration. |
For DNS queries that originate in your VPCs, specifies which Resolver endpoint the queries pass through, one domain name that you want to forward to your network, and the IP addresses of the DNS resolvers in your network
Description
For DNS queries that originate in your VPCs, specifies which Resolver endpoint the queries pass through, one domain name that you want to forward to your network, and the IP addresses of the DNS resolvers in your network.
See https://www.paws-r-sdk.com/docs/route53resolver_create_resolver_rule/ for full documentation.
Usage
route53resolver_create_resolver_rule(
CreatorRequestId,
Name = NULL,
RuleType,
DomainName = NULL,
TargetIps = NULL,
ResolverEndpointId = NULL,
Tags = NULL
)
Arguments
CreatorRequestId |
[required] A unique string that identifies the request and that allows failed
requests to be retried without the risk of running the operation twice.
|
Name |
A friendly name that lets you easily find a rule in the Resolver dashboard in the Route 53 console. |
RuleType |
[required] When you want to forward DNS queries for specified domain name to
resolvers on your network, specify When you have a forwarding rule to forward DNS queries for a domain to
your network and you want Resolver to process queries for a subdomain of
that domain, specify For example, to forward DNS queries for example.com to resolvers on your
network, you create a rule and specify Currently, only Resolver can create rules that have a value of
|
DomainName |
DNS queries for this domain name are forwarded to the IP addresses that
you specify in |
TargetIps |
The IPs that you want Resolver to forward DNS queries to. You can specify either Ipv4 or Ipv6 addresses but not both in the same rule. Separate IP addresses with a space.
|
ResolverEndpointId |
The ID of the outbound Resolver endpoint that you want to use to route
DNS queries to the IP addresses that you specify in |
Tags |
A list of the tag keys and values that you want to associate with the endpoint. |
Deletes the specified domain list
Description
Deletes the specified domain list.
See https://www.paws-r-sdk.com/docs/route53resolver_delete_firewall_domain_list/ for full documentation.
Usage
route53resolver_delete_firewall_domain_list(FirewallDomainListId)
Arguments
FirewallDomainListId |
[required] The ID of the domain list that you want to delete. |
Deletes the specified firewall rule
Description
Deletes the specified firewall rule.
See https://www.paws-r-sdk.com/docs/route53resolver_delete_firewall_rule/ for full documentation.
Usage
route53resolver_delete_firewall_rule(
FirewallRuleGroupId,
FirewallDomainListId = NULL,
FirewallThreatProtectionId = NULL,
Qtype = NULL
)
Arguments
FirewallRuleGroupId |
[required] The unique identifier of the firewall rule group that you want to delete the rule from. |
FirewallDomainListId |
The ID of the domain list that's used in the rule. |
FirewallThreatProtectionId |
The ID that is created for a DNS Firewall Advanced rule. |
Qtype |
The DNS query type that the rule you are deleting evaluates. Allowed values are;
|
Deletes the specified firewall rule group
Description
Deletes the specified firewall rule group.
See https://www.paws-r-sdk.com/docs/route53resolver_delete_firewall_rule_group/ for full documentation.
Usage
route53resolver_delete_firewall_rule_group(FirewallRuleGroupId)
Arguments
FirewallRuleGroupId |
[required] The unique identifier of the firewall rule group that you want to delete. |
Deletes a Resolver on the Outpost
Description
Deletes a Resolver on the Outpost.
See https://www.paws-r-sdk.com/docs/route53resolver_delete_outpost_resolver/ for full documentation.
Usage
route53resolver_delete_outpost_resolver(Id)
Arguments
Id |
[required] A unique string that identifies the Resolver on the Outpost. |
Deletes a Resolver endpoint
Description
Deletes a Resolver endpoint. The effect of deleting a Resolver endpoint depends on whether it's an inbound or an outbound Resolver endpoint:
See https://www.paws-r-sdk.com/docs/route53resolver_delete_resolver_endpoint/ for full documentation.
Usage
route53resolver_delete_resolver_endpoint(ResolverEndpointId)
Arguments
ResolverEndpointId |
[required] The ID of the Resolver endpoint that you want to delete. |
Deletes a query logging configuration
Description
Deletes a query logging configuration. When you delete a configuration, Resolver stops logging DNS queries for all of the Amazon VPCs that are associated with the configuration. This also applies if the query logging configuration is shared with other Amazon Web Services accounts, and the other accounts have associated VPCs with the shared configuration.
See https://www.paws-r-sdk.com/docs/route53resolver_delete_resolver_query_log_config/ for full documentation.
Usage
route53resolver_delete_resolver_query_log_config(ResolverQueryLogConfigId)
Arguments
ResolverQueryLogConfigId |
[required] The ID of the query logging configuration that you want to delete. |
Deletes a Resolver rule
Description
Deletes a Resolver rule. Before you can delete a Resolver rule, you must disassociate it from all the VPCs that you associated the Resolver rule with. For more information, see disassociate_resolver_rule
.
See https://www.paws-r-sdk.com/docs/route53resolver_delete_resolver_rule/ for full documentation.
Usage
route53resolver_delete_resolver_rule(ResolverRuleId)
Arguments
ResolverRuleId |
[required] The ID of the Resolver rule that you want to delete. |
Disassociates a FirewallRuleGroup from a VPC, to remove DNS filtering from the VPC
Description
Disassociates a FirewallRuleGroup from a VPC, to remove DNS filtering from the VPC.
See https://www.paws-r-sdk.com/docs/route53resolver_disassociate_firewall_rule_group/ for full documentation.
Usage
route53resolver_disassociate_firewall_rule_group(
FirewallRuleGroupAssociationId
)
Arguments
FirewallRuleGroupAssociationId |
[required] The identifier of the FirewallRuleGroupAssociation. |
Removes IP addresses from an inbound or an outbound Resolver endpoint
Description
Removes IP addresses from an inbound or an outbound Resolver endpoint. If you want to remove more than one IP address, submit one disassociate_resolver_endpoint_ip_address
request for each IP address.
See https://www.paws-r-sdk.com/docs/route53resolver_disassociate_resolver_endpoint_ip_address/ for full documentation.
Usage
route53resolver_disassociate_resolver_endpoint_ip_address(
ResolverEndpointId,
IpAddress
)
Arguments
ResolverEndpointId |
[required] The ID of the Resolver endpoint that you want to disassociate an IP address from. |
IpAddress |
[required] The IPv4 address that you want to remove from a Resolver endpoint. |
Disassociates a VPC from a query logging configuration
Description
Disassociates a VPC from a query logging configuration.
See https://www.paws-r-sdk.com/docs/route53resolver_disassociate_resolver_query_log_config/ for full documentation.
Usage
route53resolver_disassociate_resolver_query_log_config(
ResolverQueryLogConfigId,
ResourceId
)
Arguments
ResolverQueryLogConfigId |
[required] The ID of the query logging configuration that you want to disassociate a specified VPC from. |
ResourceId |
[required] The ID of the Amazon VPC that you want to disassociate from a specified query logging configuration. |
Removes the association between a specified Resolver rule and a specified VPC
Description
Removes the association between a specified Resolver rule and a specified VPC.
See https://www.paws-r-sdk.com/docs/route53resolver_disassociate_resolver_rule/ for full documentation.
Usage
route53resolver_disassociate_resolver_rule(VPCId, ResolverRuleId)
Arguments
VPCId |
[required] The ID of the VPC that you want to disassociate the Resolver rule from. |
ResolverRuleId |
[required] The ID of the Resolver rule that you want to disassociate from the specified VPC. |
Retrieves the configuration of the firewall behavior provided by DNS Firewall for a single VPC from Amazon Virtual Private Cloud (Amazon VPC)
Description
Retrieves the configuration of the firewall behavior provided by DNS Firewall for a single VPC from Amazon Virtual Private Cloud (Amazon VPC).
See https://www.paws-r-sdk.com/docs/route53resolver_get_firewall_config/ for full documentation.
Usage
route53resolver_get_firewall_config(ResourceId)
Arguments
ResourceId |
[required] The ID of the VPC from Amazon VPC that the configuration is for. |
Retrieves the specified firewall domain list
Description
Retrieves the specified firewall domain list.
See https://www.paws-r-sdk.com/docs/route53resolver_get_firewall_domain_list/ for full documentation.
Usage
route53resolver_get_firewall_domain_list(FirewallDomainListId)
Arguments
FirewallDomainListId |
[required] The ID of the domain list. |
Retrieves the specified firewall rule group
Description
Retrieves the specified firewall rule group.
See https://www.paws-r-sdk.com/docs/route53resolver_get_firewall_rule_group/ for full documentation.
Usage
route53resolver_get_firewall_rule_group(FirewallRuleGroupId)
Arguments
FirewallRuleGroupId |
[required] The unique identifier of the firewall rule group. |
Retrieves a firewall rule group association, which enables DNS filtering for a VPC with one rule group
Description
Retrieves a firewall rule group association, which enables DNS filtering for a VPC with one rule group. A VPC can have more than one firewall rule group association, and a rule group can be associated with more than one VPC.
See https://www.paws-r-sdk.com/docs/route53resolver_get_firewall_rule_group_association/ for full documentation.
Usage
route53resolver_get_firewall_rule_group_association(
FirewallRuleGroupAssociationId
)
Arguments
FirewallRuleGroupAssociationId |
[required] The identifier of the FirewallRuleGroupAssociation. |
Returns the Identity and Access Management (Amazon Web Services IAM) policy for sharing the specified rule group
Description
Returns the Identity and Access Management (Amazon Web Services IAM) policy for sharing the specified rule group. You can use the policy to share the rule group using Resource Access Manager (RAM).
See https://www.paws-r-sdk.com/docs/route53resolver_get_firewall_rule_group_policy/ for full documentation.
Usage
route53resolver_get_firewall_rule_group_policy(Arn)
Arguments
Arn |
[required] The ARN (Amazon Resource Name) for the rule group. |
Gets information about a specified Resolver on the Outpost, such as its instance count and type, name, and the current status of the Resolver
Description
Gets information about a specified Resolver on the Outpost, such as its instance count and type, name, and the current status of the Resolver.
See https://www.paws-r-sdk.com/docs/route53resolver_get_outpost_resolver/ for full documentation.
Usage
route53resolver_get_outpost_resolver(Id)
Arguments
Id |
[required] The ID of the Resolver on the Outpost. |
Retrieves the behavior configuration of Route 53 Resolver behavior for a single VPC from Amazon Virtual Private Cloud
Description
Retrieves the behavior configuration of Route 53 Resolver behavior for a single VPC from Amazon Virtual Private Cloud.
See https://www.paws-r-sdk.com/docs/route53resolver_get_resolver_config/ for full documentation.
Usage
route53resolver_get_resolver_config(ResourceId)
Arguments
ResourceId |
[required] Resource ID of the Amazon VPC that you want to get information about. |
Gets DNSSEC validation information for a specified resource
Description
Gets DNSSEC validation information for a specified resource.
See https://www.paws-r-sdk.com/docs/route53resolver_get_resolver_dnssec_config/ for full documentation.
Usage
route53resolver_get_resolver_dnssec_config(ResourceId)
Arguments
ResourceId |
[required] The ID of the virtual private cloud (VPC) for the DNSSEC validation status. |
Gets information about a specified Resolver endpoint, such as whether it's an inbound or an outbound Resolver endpoint, and the current status of the endpoint
Description
Gets information about a specified Resolver endpoint, such as whether it's an inbound or an outbound Resolver endpoint, and the current status of the endpoint.
See https://www.paws-r-sdk.com/docs/route53resolver_get_resolver_endpoint/ for full documentation.
Usage
route53resolver_get_resolver_endpoint(ResolverEndpointId)
Arguments
ResolverEndpointId |
[required] The ID of the Resolver endpoint that you want to get information about. |
Gets information about a specified Resolver query logging configuration, such as the number of VPCs that the configuration is logging queries for and the location that logs are sent to
Description
Gets information about a specified Resolver query logging configuration, such as the number of VPCs that the configuration is logging queries for and the location that logs are sent to.
See https://www.paws-r-sdk.com/docs/route53resolver_get_resolver_query_log_config/ for full documentation.
Usage
route53resolver_get_resolver_query_log_config(ResolverQueryLogConfigId)
Arguments
ResolverQueryLogConfigId |
[required] The ID of the Resolver query logging configuration that you want to get information about. |
Gets information about a specified association between a Resolver query logging configuration and an Amazon VPC
Description
Gets information about a specified association between a Resolver query logging configuration and an Amazon VPC. When you associate a VPC with a query logging configuration, Resolver logs DNS queries that originate in that VPC.
See https://www.paws-r-sdk.com/docs/route53resolver_get_resolver_query_log_config_association/ for full documentation.
Usage
route53resolver_get_resolver_query_log_config_association(
ResolverQueryLogConfigAssociationId
)
Arguments
ResolverQueryLogConfigAssociationId |
[required] The ID of the Resolver query logging configuration association that you want to get information about. |
Gets information about a query logging policy
Description
Gets information about a query logging policy. A query logging policy specifies the Resolver query logging operations and resources that you want to allow another Amazon Web Services account to be able to use.
See https://www.paws-r-sdk.com/docs/route53resolver_get_resolver_query_log_config_policy/ for full documentation.
Usage
route53resolver_get_resolver_query_log_config_policy(Arn)
Arguments
Arn |
[required] The ARN of the query logging configuration that you want to get the query logging policy for. |
Gets information about a specified Resolver rule, such as the domain name that the rule forwards DNS queries for and the ID of the outbound Resolver endpoint that the rule is associated with
Description
Gets information about a specified Resolver rule, such as the domain name that the rule forwards DNS queries for and the ID of the outbound Resolver endpoint that the rule is associated with.
See https://www.paws-r-sdk.com/docs/route53resolver_get_resolver_rule/ for full documentation.
Usage
route53resolver_get_resolver_rule(ResolverRuleId)
Arguments
ResolverRuleId |
[required] The ID of the Resolver rule that you want to get information about. |
Gets information about an association between a specified Resolver rule and a VPC
Description
Gets information about an association between a specified Resolver rule and a VPC. You associate a Resolver rule and a VPC using associate_resolver_rule
.
See https://www.paws-r-sdk.com/docs/route53resolver_get_resolver_rule_association/ for full documentation.
Usage
route53resolver_get_resolver_rule_association(ResolverRuleAssociationId)
Arguments
ResolverRuleAssociationId |
[required] The ID of the Resolver rule association that you want to get information about. |
Gets information about the Resolver rule policy for a specified rule
Description
Gets information about the Resolver rule policy for a specified rule. A Resolver rule policy includes the rule that you want to share with another account, the account that you want to share the rule with, and the Resolver operations that you want to allow the account to use.
See https://www.paws-r-sdk.com/docs/route53resolver_get_resolver_rule_policy/ for full documentation.
Usage
route53resolver_get_resolver_rule_policy(Arn)
Arguments
Arn |
[required] The ID of the Resolver rule that you want to get the Resolver rule policy for. |
Imports domain names from a file into a domain list, for use in a DNS firewall rule group
Description
Imports domain names from a file into a domain list, for use in a DNS firewall rule group.
See https://www.paws-r-sdk.com/docs/route53resolver_import_firewall_domains/ for full documentation.
Usage
route53resolver_import_firewall_domains(
FirewallDomainListId,
Operation,
DomainFileUrl
)
Arguments
FirewallDomainListId |
[required] The ID of the domain list that you want to modify with the import operation. |
Operation |
[required] What you want DNS Firewall to do with the domains that are listed in the
file. This must be set to |
DomainFileUrl |
[required] The fully qualified URL or URI of the file stored in Amazon Simple Storage Service (Amazon S3) that contains the list of domains to import. The file must be in an S3 bucket that's in the same Region as your DNS Firewall. The file must be a text file and must contain a single domain per line. |
Retrieves the firewall configurations that you have defined
Description
Retrieves the firewall configurations that you have defined. DNS Firewall uses the configurations to manage firewall behavior for your VPCs.
See https://www.paws-r-sdk.com/docs/route53resolver_list_firewall_configs/ for full documentation.
Usage
route53resolver_list_firewall_configs(MaxResults = NULL, NextToken = NULL)
Arguments
MaxResults |
The maximum number of objects that you want Resolver to return for this
request. If more objects are available, in the response, Resolver
provides a If you don't specify a value for |
NextToken |
For the first call to this list request, omit this value. When you request a list of objects, Resolver returns at most the number
of objects specified in |
Retrieves the firewall domain lists that you have defined
Description
Retrieves the firewall domain lists that you have defined. For each firewall domain list, you can retrieve the domains that are defined for a list by calling list_firewall_domains
.
See https://www.paws-r-sdk.com/docs/route53resolver_list_firewall_domain_lists/ for full documentation.
Usage
route53resolver_list_firewall_domain_lists(MaxResults = NULL, NextToken = NULL)
Arguments
MaxResults |
The maximum number of objects that you want Resolver to return for this
request. If more objects are available, in the response, Resolver
provides a If you don't specify a value for |
NextToken |
For the first call to this list request, omit this value. When you request a list of objects, Resolver returns at most the number
of objects specified in |
Retrieves the domains that you have defined for the specified firewall domain list
Description
Retrieves the domains that you have defined for the specified firewall domain list.
See https://www.paws-r-sdk.com/docs/route53resolver_list_firewall_domains/ for full documentation.
Usage
route53resolver_list_firewall_domains(
FirewallDomainListId,
MaxResults = NULL,
NextToken = NULL
)
Arguments
FirewallDomainListId |
[required] The ID of the domain list whose domains you want to retrieve. |
MaxResults |
The maximum number of objects that you want Resolver to return for this
request. If more objects are available, in the response, Resolver
provides a If you don't specify a value for |
NextToken |
For the first call to this list request, omit this value. When you request a list of objects, Resolver returns at most the number
of objects specified in |
Retrieves the firewall rule group associations that you have defined
Description
Retrieves the firewall rule group associations that you have defined. Each association enables DNS filtering for a VPC with one rule group.
See https://www.paws-r-sdk.com/docs/route53resolver_list_firewall_rule_group_associations/ for full documentation.
Usage
route53resolver_list_firewall_rule_group_associations(
FirewallRuleGroupId = NULL,
VpcId = NULL,
Priority = NULL,
Status = NULL,
MaxResults = NULL,
NextToken = NULL
)
Arguments
FirewallRuleGroupId |
The unique identifier of the firewall rule group that you want to retrieve the associations for. Leave this blank to retrieve associations for any rule group. |
VpcId |
The unique identifier of the VPC that you want to retrieve the associations for. Leave this blank to retrieve associations for any VPC. |
Priority |
The setting that determines the processing order of the rule group among the rule groups that are associated with a single VPC. DNS Firewall filters VPC traffic starting from the rule group with the lowest numeric priority setting. |
Status |
The association |
MaxResults |
The maximum number of objects that you want Resolver to return for this
request. If more objects are available, in the response, Resolver
provides a If you don't specify a value for |
NextToken |
For the first call to this list request, omit this value. When you request a list of objects, Resolver returns at most the number
of objects specified in |
Retrieves the minimal high-level information for the rule groups that you have defined
Description
Retrieves the minimal high-level information for the rule groups that you have defined.
See https://www.paws-r-sdk.com/docs/route53resolver_list_firewall_rule_groups/ for full documentation.
Usage
route53resolver_list_firewall_rule_groups(MaxResults = NULL, NextToken = NULL)
Arguments
MaxResults |
The maximum number of objects that you want Resolver to return for this
request. If more objects are available, in the response, Resolver
provides a If you don't specify a value for |
NextToken |
For the first call to this list request, omit this value. When you request a list of objects, Resolver returns at most the number
of objects specified in |
Retrieves the firewall rules that you have defined for the specified firewall rule group
Description
Retrieves the firewall rules that you have defined for the specified firewall rule group. DNS Firewall uses the rules in a rule group to filter DNS network traffic for a VPC.
See https://www.paws-r-sdk.com/docs/route53resolver_list_firewall_rules/ for full documentation.
Usage
route53resolver_list_firewall_rules(
FirewallRuleGroupId,
Priority = NULL,
Action = NULL,
MaxResults = NULL,
NextToken = NULL
)
Arguments
FirewallRuleGroupId |
[required] The unique identifier of the firewall rule group that you want to retrieve the rules for. |
Priority |
Optional additional filter for the rules to retrieve. The setting that determines the processing order of the rules in a rule group. DNS Firewall processes the rules in a rule group by order of priority, starting from the lowest setting. |
Action |
Optional additional filter for the rules to retrieve. The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule's domain list, or a threat in a DNS Firewall Advanced rule:
|
MaxResults |
The maximum number of objects that you want Resolver to return for this
request. If more objects are available, in the response, Resolver
provides a If you don't specify a value for |
NextToken |
For the first call to this list request, omit this value. When you request a list of objects, Resolver returns at most the number
of objects specified in |
Lists all the Resolvers on Outposts that were created using the current Amazon Web Services account
Description
Lists all the Resolvers on Outposts that were created using the current Amazon Web Services account.
See https://www.paws-r-sdk.com/docs/route53resolver_list_outpost_resolvers/ for full documentation.
Usage
route53resolver_list_outpost_resolvers(
OutpostArn = NULL,
MaxResults = NULL,
NextToken = NULL
)
Arguments
OutpostArn |
The Amazon Resource Name (ARN) of the Outpost. |
MaxResults |
The maximum number of Resolvers on the Outpost that you want to return
in the response to a |
NextToken |
For the first |
Retrieves the Resolver configurations that you have defined
Description
Retrieves the Resolver configurations that you have defined. Route 53 Resolver uses the configurations to manage DNS resolution behavior for your VPCs.
See https://www.paws-r-sdk.com/docs/route53resolver_list_resolver_configs/ for full documentation.
Usage
route53resolver_list_resolver_configs(MaxResults = NULL, NextToken = NULL)
Arguments
MaxResults |
The maximum number of Resolver configurations that you want to return in
the response to a
|
NextToken |
(Optional) If the current Amazon Web Services account has more than
For the first
For the second and subsequent requests, get the value of |
Lists the configurations for DNSSEC validation that are associated with the current Amazon Web Services account
Description
Lists the configurations for DNSSEC validation that are associated with the current Amazon Web Services account.
See https://www.paws-r-sdk.com/docs/route53resolver_list_resolver_dnssec_configs/ for full documentation.
Usage
route53resolver_list_resolver_dnssec_configs(
MaxResults = NULL,
NextToken = NULL,
Filters = NULL
)
Arguments
MaxResults |
Optional: An integer that specifies the maximum number of DNSSEC
configuration results that you want Amazon Route 53 to return. If you
don't specify a value for |
NextToken |
(Optional) If the current Amazon Web Services account has more than
For the first
For the second and subsequent requests, get the value of |
Filters |
An optional specification to return a subset of objects. |
Gets the IP addresses for a specified Resolver endpoint
Description
Gets the IP addresses for a specified Resolver endpoint.
See https://www.paws-r-sdk.com/docs/route53resolver_list_resolver_endpoint_ip_addresses/ for full documentation.
Usage
route53resolver_list_resolver_endpoint_ip_addresses(
ResolverEndpointId,
MaxResults = NULL,
NextToken = NULL
)
Arguments
ResolverEndpointId |
[required] The ID of the Resolver endpoint that you want to get IP addresses for. |
MaxResults |
The maximum number of IP addresses that you want to return in the
response to a
|
NextToken |
For the first
If the specified Resolver endpoint has more than |
Lists all the Resolver endpoints that were created using the current Amazon Web Services account
Description
Lists all the Resolver endpoints that were created using the current Amazon Web Services account.
See https://www.paws-r-sdk.com/docs/route53resolver_list_resolver_endpoints/ for full documentation.
Usage
route53resolver_list_resolver_endpoints(
MaxResults = NULL,
NextToken = NULL,
Filters = NULL
)
Arguments
MaxResults |
The maximum number of Resolver endpoints that you want to return in the
response to a
|
NextToken |
For the first
If you have more than |
Filters |
An optional specification to return a subset of Resolver endpoints, such as all inbound Resolver endpoints. If you submit a second or subsequent
|
Lists information about associations between Amazon VPCs and query logging configurations
Description
Lists information about associations between Amazon VPCs and query logging configurations.
See https://www.paws-r-sdk.com/docs/route53resolver_list_resolver_query_log_config_associations/ for full documentation.
Usage
route53resolver_list_resolver_query_log_config_associations(
MaxResults = NULL,
NextToken = NULL,
Filters = NULL,
SortBy = NULL,
SortOrder = NULL
)
Arguments
MaxResults |
The maximum number of query logging associations that you want to return
in the response to a
|
NextToken |
For the first
If there are more than |
Filters |
An optional specification to return a subset of query logging associations. If you submit a second or subsequent
|
SortBy |
The element that you want Resolver to sort query logging associations by. If you submit a second or subsequent
Valid values include the following elements:
|
SortOrder |
If you specified a value for If you submit a second or subsequent
|
Lists information about the specified query logging configurations
Description
Lists information about the specified query logging configurations. Each configuration defines where you want Resolver to save DNS query logs and specifies the VPCs that you want to log queries for.
See https://www.paws-r-sdk.com/docs/route53resolver_list_resolver_query_log_configs/ for full documentation.
Usage
route53resolver_list_resolver_query_log_configs(
MaxResults = NULL,
NextToken = NULL,
Filters = NULL,
SortBy = NULL,
SortOrder = NULL
)
Arguments
MaxResults |
The maximum number of query logging configurations that you want to
return in the response to a
|
NextToken |
For the first
If there are more than |
Filters |
An optional specification to return a subset of query logging configurations. If you submit a second or subsequent
|
SortBy |
The element that you want Resolver to sort query logging configurations by. If you submit a second or subsequent
Valid values include the following elements:
|
SortOrder |
If you specified a value for If you submit a second or subsequent
|
Lists the associations that were created between Resolver rules and VPCs using the current Amazon Web Services account
Description
Lists the associations that were created between Resolver rules and VPCs using the current Amazon Web Services account.
See https://www.paws-r-sdk.com/docs/route53resolver_list_resolver_rule_associations/ for full documentation.
Usage
route53resolver_list_resolver_rule_associations(
MaxResults = NULL,
NextToken = NULL,
Filters = NULL
)
Arguments
MaxResults |
The maximum number of rule associations that you want to return in the
response to a
|
NextToken |
For the first If you have more than |
Filters |
An optional specification to return a subset of Resolver rules, such as Resolver rules that are associated with the same VPC ID. If you submit a second or subsequent
|
Lists the Resolver rules that were created using the current Amazon Web Services account
Description
Lists the Resolver rules that were created using the current Amazon Web Services account.
See https://www.paws-r-sdk.com/docs/route53resolver_list_resolver_rules/ for full documentation.
Usage
route53resolver_list_resolver_rules(
MaxResults = NULL,
NextToken = NULL,
Filters = NULL
)
Arguments
MaxResults |
The maximum number of Resolver rules that you want to return in the
response to a
|
NextToken |
For the first
If you have more than |
Filters |
An optional specification to return a subset of Resolver rules, such as all Resolver rules that are associated with the same Resolver endpoint. If you submit a second or subsequent
|
Lists the tags that you associated with the specified resource
Description
Lists the tags that you associated with the specified resource.
See https://www.paws-r-sdk.com/docs/route53resolver_list_tags_for_resource/ for full documentation.
Usage
route53resolver_list_tags_for_resource(
ResourceArn,
MaxResults = NULL,
NextToken = NULL
)
Arguments
ResourceArn |
[required] The Amazon Resource Name (ARN) for the resource that you want to list tags for. |
MaxResults |
The maximum number of tags that you want to return in the response to a
|
NextToken |
For the first
If you have more than |
Attaches an Identity and Access Management (Amazon Web Services IAM) policy for sharing the rule group
Description
Attaches an Identity and Access Management (Amazon Web Services IAM) policy for sharing the rule group. You can use the policy to share the rule group using Resource Access Manager (RAM).
See https://www.paws-r-sdk.com/docs/route53resolver_put_firewall_rule_group_policy/ for full documentation.
Usage
route53resolver_put_firewall_rule_group_policy(Arn, FirewallRuleGroupPolicy)
Arguments
Arn |
[required] The ARN (Amazon Resource Name) for the rule group that you want to share. |
FirewallRuleGroupPolicy |
[required] The Identity and Access Management (Amazon Web Services IAM) policy to attach to the rule group. |
Specifies an Amazon Web Services account that you want to share a query logging configuration with, the query logging configuration that you want to share, and the operations that you want the account to be able to perform on the configuration
Description
Specifies an Amazon Web Services account that you want to share a query logging configuration with, the query logging configuration that you want to share, and the operations that you want the account to be able to perform on the configuration.
See https://www.paws-r-sdk.com/docs/route53resolver_put_resolver_query_log_config_policy/ for full documentation.
Usage
route53resolver_put_resolver_query_log_config_policy(
Arn,
ResolverQueryLogConfigPolicy
)
Arguments
Arn |
[required] The Amazon Resource Name (ARN) of the account that you want to share rules with. |
ResolverQueryLogConfigPolicy |
[required] An Identity and Access Management policy statement that lists the query
logging configurations that you want to share with another Amazon Web
Services account and the operations that you want the account to be able
to perform. You can specify the following operations in the
In the |
Specifies an Amazon Web Services rule that you want to share with another account, the account that you want to share the rule with, and the operations that you want the account to be able to perform on the rule
Description
Specifies an Amazon Web Services rule that you want to share with another account, the account that you want to share the rule with, and the operations that you want the account to be able to perform on the rule.
See https://www.paws-r-sdk.com/docs/route53resolver_put_resolver_rule_policy/ for full documentation.
Usage
route53resolver_put_resolver_rule_policy(Arn, ResolverRulePolicy)
Arguments
Arn |
[required] The Amazon Resource Name (ARN) of the rule that you want to share with another account. |
ResolverRulePolicy |
[required] An Identity and Access Management policy statement that lists the rules
that you want to share with another Amazon Web Services account and the
operations that you want the account to be able to perform. You can
specify the following operations in the
In the |
Adds one or more tags to a specified resource
Description
Adds one or more tags to a specified resource.
See https://www.paws-r-sdk.com/docs/route53resolver_tag_resource/ for full documentation.
Usage
route53resolver_tag_resource(ResourceArn, Tags)
Arguments
ResourceArn |
[required] The Amazon Resource Name (ARN) for the resource that you want to add
tags to. To get the ARN for a resource, use the applicable |
Tags |
[required] The tags that you want to add to the specified resource. |
Removes one or more tags from a specified resource
Description
Removes one or more tags from a specified resource.
See https://www.paws-r-sdk.com/docs/route53resolver_untag_resource/ for full documentation.
Usage
route53resolver_untag_resource(ResourceArn, TagKeys)
Arguments
ResourceArn |
[required] The Amazon Resource Name (ARN) for the resource that you want to remove
tags from. To get the ARN for a resource, use the applicable |
TagKeys |
[required] The tags that you want to remove to the specified resource. |
Updates the configuration of the firewall behavior provided by DNS Firewall for a single VPC from Amazon Virtual Private Cloud (Amazon VPC)
Description
Updates the configuration of the firewall behavior provided by DNS Firewall for a single VPC from Amazon Virtual Private Cloud (Amazon VPC).
See https://www.paws-r-sdk.com/docs/route53resolver_update_firewall_config/ for full documentation.
Usage
route53resolver_update_firewall_config(ResourceId, FirewallFailOpen)
Arguments
ResourceId |
[required] The ID of the VPC that the configuration is for. |
FirewallFailOpen |
[required] Determines how Route 53 Resolver handles queries during failures, for example when all traffic that is sent to DNS Firewall fails to receive a reply.
This behavior is only enforced for VPCs that have at least one DNS Firewall rule group association. |
Updates the firewall domain list from an array of domain specifications
Description
Updates the firewall domain list from an array of domain specifications.
See https://www.paws-r-sdk.com/docs/route53resolver_update_firewall_domains/ for full documentation.
Usage
route53resolver_update_firewall_domains(
FirewallDomainListId,
Operation,
Domains
)
Arguments
FirewallDomainListId |
[required] The ID of the domain list whose domains you want to update. |
Operation |
[required] What you want DNS Firewall to do with the domains that you are providing:
|
Domains |
[required] A list of domains to use in the update operation. There is a limit of 1000 domains per request. Each domain specification in your domain list must satisfy the following requirements:
|
Updates the specified firewall rule
Description
Updates the specified firewall rule.
See https://www.paws-r-sdk.com/docs/route53resolver_update_firewall_rule/ for full documentation.
Usage
route53resolver_update_firewall_rule(
FirewallRuleGroupId,
FirewallDomainListId = NULL,
FirewallThreatProtectionId = NULL,
Priority = NULL,
Action = NULL,
BlockResponse = NULL,
BlockOverrideDomain = NULL,
BlockOverrideDnsType = NULL,
BlockOverrideTtl = NULL,
Name = NULL,
FirewallDomainRedirectionAction = NULL,
Qtype = NULL,
DnsThreatProtection = NULL,
ConfidenceThreshold = NULL
)
Arguments
FirewallRuleGroupId |
[required] The unique identifier of the firewall rule group for the rule. |
FirewallDomainListId |
The ID of the domain list to use in the rule. |
FirewallThreatProtectionId |
The DNS Firewall Advanced rule ID. |
Priority |
The setting that determines the processing order of the rule in the rule group. DNS Firewall processes the rules in a rule group by order of priority, starting from the lowest setting. You must specify a unique priority for each rule in a rule group. To make it easier to insert rules later, leave space between the numbers, for example, use 100, 200, and so on. You can change the priority setting for the rules in a rule group at any time. |
Action |
The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule's domain list, or a threat in a DNS Firewall Advanced rule:
|
BlockResponse |
The way that you want DNS Firewall to block the request. Used for the
rule action setting
|
BlockOverrideDomain |
The custom DNS record to send back in response to the query. Used for
the rule action |
BlockOverrideDnsType |
The DNS record's type. This determines the format of the record value
that you provided in |
BlockOverrideTtl |
The recommended amount of time, in seconds, for the DNS resolver or web
browser to cache the provided override record. Used for the rule action
|
Name |
The name of the rule. |
FirewallDomainRedirectionAction |
How you want the the rule to evaluate DNS redirection in the DNS redirection chain, such as CNAME or DNAME.
|
Qtype |
The DNS query type you want the rule to evaluate. Allowed values are;
|
DnsThreatProtection |
The type of the DNS Firewall Advanced rule. Valid values are:
|
ConfidenceThreshold |
The confidence threshold for DNS Firewall Advanced. You must provide this value when you create a DNS Firewall Advanced rule. The confidence level values mean:
|
Changes the association of a FirewallRuleGroup with a VPC
Description
Changes the association of a FirewallRuleGroup with a VPC. The association enables DNS filtering for the VPC.
See https://www.paws-r-sdk.com/docs/route53resolver_update_firewall_rule_group_association/ for full documentation.
Usage
route53resolver_update_firewall_rule_group_association(
FirewallRuleGroupAssociationId,
Priority = NULL,
MutationProtection = NULL,
Name = NULL
)
Arguments
FirewallRuleGroupAssociationId |
[required] The identifier of the FirewallRuleGroupAssociation. |
Priority |
The setting that determines the processing order of the rule group among the rule groups that you associate with the specified VPC. DNS Firewall filters VPC traffic starting from the rule group with the lowest numeric priority setting. You must specify a unique priority for each rule group that you associate with a single VPC. To make it easier to insert rule groups later, leave space between the numbers, for example, use 100, 200, and so on. You can change the priority setting for a rule group association after you create it. |
MutationProtection |
If enabled, this setting disallows modification or removal of the association, to help prevent against accidentally altering DNS firewall protections. |
Name |
The name of the rule group association. |
You can use UpdateOutpostResolver to update the instance count, type, or name of a Resolver on an Outpost
Description
You can use update_outpost_resolver
to update the instance count, type, or name of a Resolver on an Outpost.
See https://www.paws-r-sdk.com/docs/route53resolver_update_outpost_resolver/ for full documentation.
Usage
route53resolver_update_outpost_resolver(
Id,
Name = NULL,
InstanceCount = NULL,
PreferredInstanceType = NULL
)
Arguments
Id |
[required] A unique string that identifies Resolver on an Outpost. |
Name |
Name of the Resolver on the Outpost. |
InstanceCount |
The Amazon EC2 instance count for a Resolver on the Outpost. |
PreferredInstanceType |
Amazon EC2 instance type. |
Updates the behavior configuration of Route 53 Resolver behavior for a single VPC from Amazon Virtual Private Cloud
Description
Updates the behavior configuration of Route 53 Resolver behavior for a single VPC from Amazon Virtual Private Cloud.
See https://www.paws-r-sdk.com/docs/route53resolver_update_resolver_config/ for full documentation.
Usage
route53resolver_update_resolver_config(ResourceId, AutodefinedReverseFlag)
Arguments
ResourceId |
[required] Resource ID of the Amazon VPC that you want to update the Resolver configuration for. |
AutodefinedReverseFlag |
[required] Indicates whether or not the Resolver will create autodefined rules for reverse DNS lookups. This is enabled by default. Disabling this option will also affect EC2-Classic instances using ClassicLink. For more information, see ClassicLink in the Amazon EC2 guide. We are retiring EC2-Classic on August 15, 2022. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 guide and the blog EC2-Classic Networking is Retiring – Here’s How to Prepare. It can take some time for the status change to be completed. |
Updates an existing DNSSEC validation configuration
Description
Updates an existing DNSSEC validation configuration. If there is no existing DNSSEC validation configuration, one is created.
See https://www.paws-r-sdk.com/docs/route53resolver_update_resolver_dnssec_config/ for full documentation.
Usage
route53resolver_update_resolver_dnssec_config(ResourceId, Validation)
Arguments
ResourceId |
[required] The ID of the virtual private cloud (VPC) that you're updating the DNSSEC validation status for. |
Validation |
[required] The new value that you are specifying for DNSSEC validation for the VPC.
The value can be |
Updates the name, or endpoint type for an inbound or an outbound Resolver endpoint
Description
Updates the name, or endpoint type for an inbound or an outbound Resolver endpoint. You can only update between IPV4 and DUALSTACK, IPV6 endpoint type can't be updated to other type.
See https://www.paws-r-sdk.com/docs/route53resolver_update_resolver_endpoint/ for full documentation.
Usage
route53resolver_update_resolver_endpoint(
ResolverEndpointId,
Name = NULL,
ResolverEndpointType = NULL,
UpdateIpAddresses = NULL,
Protocols = NULL
)
Arguments
ResolverEndpointId |
[required] The ID of the Resolver endpoint that you want to update. |
Name |
The name of the Resolver endpoint that you want to update. |
ResolverEndpointType |
Specifies the endpoint type for what type of IP address the endpoint uses to forward DNS queries. Updating to |
UpdateIpAddresses |
Specifies the IPv6 address when you update the Resolver endpoint from IPv4 to dual-stack. If you don't specify an IPv6 address, one will be automatically chosen from your subnet. |
Protocols |
The protocols you want to use for the endpoint. DoH-FIPS is applicable for inbound endpoints only. For an inbound endpoint you can apply the protocols as follows:
For an outbound endpoint you can apply the protocols as follows:
You can't change the protocol of an inbound endpoint directly from only Do53 to only DoH, or DoH-FIPS. This is to prevent a sudden disruption to incoming traffic that relies on Do53. To change the protocol from Do53 to DoH, or DoH-FIPS, you must first enable both Do53 and DoH, or Do53 and DoH-FIPS, to make sure that all incoming traffic has transferred to using the DoH protocol, or DoH-FIPS, and then remove the Do53. |
Updates settings for a specified Resolver rule
Description
Updates settings for a specified Resolver rule. ResolverRuleId
is required, and all other parameters are optional. If you don't specify a parameter, it retains its current value.
See https://www.paws-r-sdk.com/docs/route53resolver_update_resolver_rule/ for full documentation.
Usage
route53resolver_update_resolver_rule(ResolverRuleId, Config)
Arguments
ResolverRuleId |
[required] The ID of the Resolver rule that you want to update. |
Config |
[required] The new settings for the Resolver rule. |
AWS Cloud Map
Description
Cloud Map
With Cloud Map, you can configure public DNS, private DNS, or HTTP namespaces that your microservice applications run in. When an instance becomes available, you can call the Cloud Map API to register the instance with Cloud Map. For public or private DNS namespaces, Cloud Map automatically creates DNS records and an optional health check. Clients that submit public or private DNS queries, or HTTP requests, for the service receive an answer that contains up to eight healthy records.
Usage
servicediscovery(
config = list(),
credentials = list(),
endpoint = NULL,
region = NULL
)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...)
, where svc
is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- servicediscovery( config = list( credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string", close_connection = "logical", timeout = "numeric", s3_force_path_style = "logical", sts_regional_endpoint = "string" ), credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string" )
Operations
create_http_namespace | Creates an HTTP namespace |
create_private_dns_namespace | Creates a private namespace based on DNS, which is visible only inside a specified Amazon VPC |
create_public_dns_namespace | Creates a public namespace based on DNS, which is visible on the internet |
create_service | Creates a service |
delete_namespace | Deletes a namespace from the current account |
delete_service | Deletes a specified service and all associated service attributes |
delete_service_attributes | Deletes specific attributes associated with a service |
deregister_instance | Deletes the Amazon Route 53 DNS records and health check, if any, that Cloud Map created for the specified instance |
discover_instances | Discovers registered instances for a specified namespace and service |
discover_instances_revision | Discovers the increasing revision associated with an instance |
get_instance | Gets information about a specified instance |
get_instances_health_status | Gets the current health status (Healthy, Unhealthy, or Unknown) of one or more instances that are associated with a specified service |
get_namespace | Gets information about a namespace |
get_operation | Gets information about any operation that returns an operation ID in the response, such as a CreateHttpNamespace request |
get_service | Gets the settings for a specified service |
get_service_attributes | Returns the attributes associated with a specified service |
list_instances | Lists summary information about the instances that you registered by using a specified service |
list_namespaces | Lists summary information about the namespaces that were created by the current Amazon Web Services account |
list_operations | Lists operations that match the criteria that you specify |
list_services | Lists summary information for all the services that are associated with one or more namespaces |
list_tags_for_resource | Lists tags for the specified resource |
register_instance | Creates or updates one or more records and, optionally, creates a health check based on the settings in a specified service |
tag_resource | Adds one or more tags to the specified resource |
untag_resource | Removes one or more tags from the specified resource |
update_http_namespace | Updates an HTTP namespace |
update_instance_custom_health_status | Submits a request to change the health status of a custom health check to healthy or unhealthy |
update_private_dns_namespace | Updates a private DNS namespace |
update_public_dns_namespace | Updates a public DNS namespace |
update_service | Submits a request to perform the following operations: |
update_service_attributes | Submits a request to update a specified service to add service-level attributes |
Examples
## Not run:
svc <- servicediscovery()
# This example creates an HTTP namespace.
svc$create_http_namespace(
CreatorRequestId = "example-creator-request-id-0001",
Description = "Example.com AWS Cloud Map HTTP Namespace",
Name = "example-http.com"
)
## End(Not run)
Creates an HTTP namespace
Description
Creates an HTTP namespace. Service instances registered using an HTTP namespace can be discovered using a discover_instances
request but can't be discovered using DNS.
See https://www.paws-r-sdk.com/docs/servicediscovery_create_http_namespace/ for full documentation.
Usage
servicediscovery_create_http_namespace(
Name,
CreatorRequestId = NULL,
Description = NULL,
Tags = NULL
)
Arguments
Name |
[required] The name that you want to assign to this namespace. |
CreatorRequestId |
A unique string that identifies the request and that allows failed
|
Description |
A description for the namespace. |
Tags |
The tags to add to the namespace. Each tag consists of a key and an optional value that you define. Tags keys can be up to 128 characters in length, and tag values can be up to 256 characters in length. |
Creates a private namespace based on DNS, which is visible only inside a specified Amazon VPC
Description
Creates a private namespace based on DNS, which is visible only inside a specified Amazon VPC. The namespace defines your service naming scheme. For example, if you name your namespace example.com
and name your service backend
, the resulting DNS name for the service is backend.example.com
. Service instances that are registered using a private DNS namespace can be discovered using either a discover_instances
request or using DNS. For the current quota on the number of namespaces that you can create using the same Amazon Web Services account, see Cloud Map quotas in the Cloud Map Developer Guide.
See https://www.paws-r-sdk.com/docs/servicediscovery_create_private_dns_namespace/ for full documentation.
Usage
servicediscovery_create_private_dns_namespace(
Name,
CreatorRequestId = NULL,
Description = NULL,
Vpc,
Tags = NULL,
Properties = NULL
)
Arguments
Name |
[required] The name that you want to assign to this namespace. When you create a private DNS namespace, Cloud Map automatically creates an Amazon Route 53 private hosted zone that has the same name as the namespace. |
CreatorRequestId |
A unique string that identifies the request and that allows failed
|
Description |
A description for the namespace. |
Vpc |
[required] The ID of the Amazon VPC that you want to associate the namespace with. |
Tags |
The tags to add to the namespace. Each tag consists of a key and an optional value that you define. Tags keys can be up to 128 characters in length, and tag values can be up to 256 characters in length. |
Properties |
Properties for the private DNS namespace. |
Creates a public namespace based on DNS, which is visible on the internet
Description
Creates a public namespace based on DNS, which is visible on the internet. The namespace defines your service naming scheme. For example, if you name your namespace example.com
and name your service backend
, the resulting DNS name for the service is backend.example.com
. You can discover instances that were registered with a public DNS namespace by using either a discover_instances
request or using DNS. For the current quota on the number of namespaces that you can create using the same Amazon Web Services account, see Cloud Map quotas in the Cloud Map Developer Guide.
See https://www.paws-r-sdk.com/docs/servicediscovery_create_public_dns_namespace/ for full documentation.
Usage
servicediscovery_create_public_dns_namespace(
Name,
CreatorRequestId = NULL,
Description = NULL,
Tags = NULL,
Properties = NULL
)
Arguments
Name |
[required] The name that you want to assign to this namespace. Do not include sensitive information in the name. The name is publicly available using DNS queries. |
CreatorRequestId |
A unique string that identifies the request and that allows failed
|
Description |
A description for the namespace. |
Tags |
The tags to add to the namespace. Each tag consists of a key and an optional value that you define. Tags keys can be up to 128 characters in length, and tag values can be up to 256 characters in length. |
Properties |
Properties for the public DNS namespace. |
Creates a service
Description
Creates a service. This action defines the configuration for the following entities:
See https://www.paws-r-sdk.com/docs/servicediscovery_create_service/ for full documentation.
Usage
servicediscovery_create_service(
Name,
NamespaceId = NULL,
CreatorRequestId = NULL,
Description = NULL,
DnsConfig = NULL,
HealthCheckConfig = NULL,
HealthCheckCustomConfig = NULL,
Tags = NULL,
Type = NULL
)
Arguments
Name |
[required] The name that you want to assign to the service. Do not include sensitive information in the name if the namespace is discoverable by public DNS queries. If you want Cloud Map to create an
When you register an instance, Cloud Map creates an
For services that are accessible by DNS queries, you can't create multiple services with names that differ only by case (such as EXAMPLE and example). Otherwise, these services have the same DNS name and can't be distinguished. However, if you use a namespace that's only accessible by API calls, then you can create services that with names that differ only by case. |
NamespaceId |
The ID of the namespace that you want to use to create the service. The
namespace ID must be specified, but it can be specified either here or
in the |
CreatorRequestId |
A unique string that identifies the request and that allows failed
|
Description |
A description for the service. |
DnsConfig |
A complex type that contains information about the Amazon Route 53 records that you want Cloud Map to create when you register an instance. |
HealthCheckConfig |
Public DNS and HTTP namespaces only. A complex type that contains
settings for an optional Route 53 health check. If you specify settings
for a health check, Cloud Map associates the health check with all the
Route 53 DNS records that you specify in If you specify a health check configuration, you can specify either
For information about the charges for health checks, see Cloud Map Pricing. |
HealthCheckCustomConfig |
A complex type that contains information about an optional custom health check. If you specify a health check configuration, you can specify either
You can't add, update, or delete a |
Tags |
The tags to add to the service. Each tag consists of a key and an optional value that you define. Tags keys can be up to 128 characters in length, and tag values can be up to 256 characters in length. |
Type |
If present, specifies that the service instances are only discoverable
using the |
Deletes a namespace from the current account
Description
Deletes a namespace from the current account. If the namespace still contains one or more services, the request fails.
See https://www.paws-r-sdk.com/docs/servicediscovery_delete_namespace/ for full documentation.
Usage
servicediscovery_delete_namespace(Id)
Arguments
Id |
[required] The ID of the namespace that you want to delete. |
Deletes a specified service and all associated service attributes
Description
Deletes a specified service and all associated service attributes. If the service still contains one or more registered instances, the request fails.
See https://www.paws-r-sdk.com/docs/servicediscovery_delete_service/ for full documentation.
Usage
servicediscovery_delete_service(Id)
Arguments
Id |
[required] The ID of the service that you want to delete. |
Deletes specific attributes associated with a service
Description
Deletes specific attributes associated with a service.
See https://www.paws-r-sdk.com/docs/servicediscovery_delete_service_attributes/ for full documentation.
Usage
servicediscovery_delete_service_attributes(ServiceId, Attributes)
Arguments
ServiceId |
[required] The ID of the service from which the attributes will be deleted. |
Attributes |
[required] A list of keys corresponding to each attribute that you want to delete. |
Deletes the Amazon Route 53 DNS records and health check, if any, that Cloud Map created for the specified instance
Description
Deletes the Amazon Route 53 DNS records and health check, if any, that Cloud Map created for the specified instance.
See https://www.paws-r-sdk.com/docs/servicediscovery_deregister_instance/ for full documentation.
Usage
servicediscovery_deregister_instance(ServiceId, InstanceId)
Arguments
ServiceId |
[required] The ID of the service that the instance is associated with. |
InstanceId |
[required] The value that you specified for |
Discovers registered instances for a specified namespace and service
Description
Discovers registered instances for a specified namespace and service. You can use discover_instances
to discover instances for any type of namespace. discover_instances
returns a randomized list of instances allowing customers to distribute traffic evenly across instances. For public and private DNS namespaces, you can also use DNS queries to discover instances.
See https://www.paws-r-sdk.com/docs/servicediscovery_discover_instances/ for full documentation.
Usage
servicediscovery_discover_instances(
NamespaceName,
ServiceName,
MaxResults = NULL,
QueryParameters = NULL,
OptionalParameters = NULL,
HealthStatus = NULL
)
Arguments
NamespaceName |
[required] The |
ServiceName |
[required] The name of the service that you specified when you registered the instance. |
MaxResults |
The maximum number of instances that you want Cloud Map to return in the
response to a
|
QueryParameters |
Filters to scope the results based on custom attributes for the instance
(for example, |
OptionalParameters |
Opportunistic filters to scope the results based on custom attributes.
If there are instances that match both the filters specified in both the
|
HealthStatus |
The health status of the instances that you want to discover. This parameter is ignored for services that don't have a health check configured, and all instances are returned. HEALTHY Returns healthy instances. UNHEALTHY Returns unhealthy instances. ALL Returns all instances. HEALTHY_OR_ELSE_ALL Returns healthy instances, unless none are reporting a healthy state. In that case, return all instances. This is also called failing open. |
Discovers the increasing revision associated with an instance
Description
Discovers the increasing revision associated with an instance.
See https://www.paws-r-sdk.com/docs/servicediscovery_discover_instances_revision/ for full documentation.
Usage
servicediscovery_discover_instances_revision(NamespaceName, ServiceName)
Arguments
NamespaceName |
[required] The |
ServiceName |
[required] The name of the service that you specified when you registered the instance. |
Gets information about a specified instance
Description
Gets information about a specified instance.
See https://www.paws-r-sdk.com/docs/servicediscovery_get_instance/ for full documentation.
Usage
servicediscovery_get_instance(ServiceId, InstanceId)
Arguments
ServiceId |
[required] The ID of the service that the instance is associated with. |
InstanceId |
[required] The ID of the instance that you want to get information about. |
Gets the current health status (Healthy, Unhealthy, or Unknown) of one or more instances that are associated with a specified service
Description
Gets the current health status (Healthy
, Unhealthy
, or Unknown
) of one or more instances that are associated with a specified service.
See https://www.paws-r-sdk.com/docs/servicediscovery_get_instances_health_status/ for full documentation.
Usage
servicediscovery_get_instances_health_status(
ServiceId,
Instances = NULL,
MaxResults = NULL,
NextToken = NULL
)
Arguments
ServiceId |
[required] The ID of the service that the instance is associated with. |
Instances |
An array that contains the IDs of all the instances that you want to get the health status for. If you omit To get the IDs for the instances that you've registered by using a
specified service, submit a
|
MaxResults |
The maximum number of instances that you want Cloud Map to return in the
response to a
|
NextToken |
For the first
If more than |
Gets information about a namespace
Description
Gets information about a namespace.
See https://www.paws-r-sdk.com/docs/servicediscovery_get_namespace/ for full documentation.
Usage
servicediscovery_get_namespace(Id)
Arguments
Id |
[required] The ID of the namespace that you want to get information about. |
Gets information about any operation that returns an operation ID in the response, such as a CreateHttpNamespace request
Description
Gets information about any operation that returns an operation ID in the response, such as a create_http_namespace
request.
See https://www.paws-r-sdk.com/docs/servicediscovery_get_operation/ for full documentation.
Usage
servicediscovery_get_operation(OperationId)
Arguments
OperationId |
[required] The ID of the operation that you want to get more information about. |
Gets the settings for a specified service
Description
Gets the settings for a specified service.
See https://www.paws-r-sdk.com/docs/servicediscovery_get_service/ for full documentation.
Usage
servicediscovery_get_service(Id)
Arguments
Id |
[required] The ID of the service that you want to get settings for. |
Returns the attributes associated with a specified service
Description
Returns the attributes associated with a specified service.
See https://www.paws-r-sdk.com/docs/servicediscovery_get_service_attributes/ for full documentation.
Usage
servicediscovery_get_service_attributes(ServiceId)
Arguments
ServiceId |
[required] The ID of the service that you want to get attributes for. |
Lists summary information about the instances that you registered by using a specified service
Description
Lists summary information about the instances that you registered by using a specified service.
See https://www.paws-r-sdk.com/docs/servicediscovery_list_instances/ for full documentation.
Usage
servicediscovery_list_instances(ServiceId, NextToken = NULL, MaxResults = NULL)
Arguments
ServiceId |
[required] The ID of the service that you want to list instances for. |
NextToken |
For the first If more than |
MaxResults |
The maximum number of instances that you want Cloud Map to return in the
response to a |
Lists summary information about the namespaces that were created by the current Amazon Web Services account
Description
Lists summary information about the namespaces that were created by the current Amazon Web Services account.
See https://www.paws-r-sdk.com/docs/servicediscovery_list_namespaces/ for full documentation.
Usage
servicediscovery_list_namespaces(
NextToken = NULL,
MaxResults = NULL,
Filters = NULL
)
Arguments
NextToken |
For the first If the response contains Cloud Map gets |
MaxResults |
The maximum number of namespaces that you want Cloud Map to return in
the response to a |
Filters |
A complex type that contains specifications for the namespaces that you want to list. If you specify more than one filter, a namespace must match all filters
to be returned by |
Lists operations that match the criteria that you specify
Description
Lists operations that match the criteria that you specify.
See https://www.paws-r-sdk.com/docs/servicediscovery_list_operations/ for full documentation.
Usage
servicediscovery_list_operations(
NextToken = NULL,
MaxResults = NULL,
Filters = NULL
)
Arguments
NextToken |
For the first If the response contains Cloud Map gets |
MaxResults |
The maximum number of items that you want Cloud Map to return in the
response to a |
Filters |
A complex type that contains specifications for the operations that you want to list, for example, operations that you started between a specified start date and end date. If you specify more than one filter, an operation must match all filters
to be returned by |
Lists summary information for all the services that are associated with one or more namespaces
Description
Lists summary information for all the services that are associated with one or more namespaces.
See https://www.paws-r-sdk.com/docs/servicediscovery_list_services/ for full documentation.
Usage
servicediscovery_list_services(
NextToken = NULL,
MaxResults = NULL,
Filters = NULL
)
Arguments
NextToken |
For the first If the response contains Cloud Map gets |
MaxResults |
The maximum number of services that you want Cloud Map to return in the
response to a |
Filters |
A complex type that contains specifications for the namespaces that you want to list services for. If you specify more than one filter, an operation must match all filters
to be returned by |
Lists tags for the specified resource
Description
Lists tags for the specified resource.
See https://www.paws-r-sdk.com/docs/servicediscovery_list_tags_for_resource/ for full documentation.
Usage
servicediscovery_list_tags_for_resource(ResourceARN)
Arguments
ResourceARN |
[required] The Amazon Resource Name (ARN) of the resource that you want to retrieve tags for. |
Creates or updates one or more records and, optionally, creates a health check based on the settings in a specified service
Description
Creates or updates one or more records and, optionally, creates a health check based on the settings in a specified service. When you submit a register_instance
request, the following occurs:
See https://www.paws-r-sdk.com/docs/servicediscovery_register_instance/ for full documentation.
Usage
servicediscovery_register_instance(
ServiceId,
InstanceId,
CreatorRequestId = NULL,
Attributes
)
Arguments
ServiceId |
[required] The ID of the service that you want to use for settings for the instance. |
InstanceId |
[required] An identifier that you want to associate with the instance. Note the following:
Do not include sensitive information in |
CreatorRequestId |
A unique string that identifies the request and that allows failed
|
Attributes |
[required] A string map that contains the following information for the service
that you specify in
Do not include sensitive information in the attributes if the namespace is discoverable by public DNS queries. The following are the supported attribute keys. AWS_ALIAS_DNS_NAME If you want Cloud Map to create an Amazon Route 53 alias record that routes traffic to an Elastic Load Balancing load balancer, specify the DNS name that's associated with the load balancer. For information about how to get the DNS name, see "DNSName" in the topic AliasTarget in the Route 53 API Reference. Note the following:
AWS_EC2_INSTANCE_ID HTTP namespaces only. The Amazon EC2 instance ID for the instance. If
the AWS_INIT_HEALTH_STATUS If the service configuration includes AWS_INSTANCE_CNAME If the service configuration includes a This value is required if the service specified by AWS_INSTANCE_IPV4 If the service configuration includes an This value is required if the service specified by AWS_INSTANCE_IPV6 If the service configuration includes an This value is required if the service specified by AWS_INSTANCE_PORT If the service includes an If the service includes This value is required if you specified settings for an Custom attributes You can add up to 30 custom attributes. For each key-value pair, the maximum length of the attribute name is 255 characters, and the maximum length of the attribute value is 1,024 characters. The total size of all provided attributes (sum of all keys and values) must not exceed 5,000 characters. |
Adds one or more tags to the specified resource
Description
Adds one or more tags to the specified resource.
See https://www.paws-r-sdk.com/docs/servicediscovery_tag_resource/ for full documentation.
Usage
servicediscovery_tag_resource(ResourceARN, Tags)
Arguments
ResourceARN |
[required] The Amazon Resource Name (ARN) of the resource that you want to retrieve tags for. |
Tags |
[required] The tags to add to the specified resource. Specifying the tag key is required. You can set the value of a tag to an empty string, but you can't set the value of a tag to null. |
Removes one or more tags from the specified resource
Description
Removes one or more tags from the specified resource.
See https://www.paws-r-sdk.com/docs/servicediscovery_untag_resource/ for full documentation.
Usage
servicediscovery_untag_resource(ResourceARN, TagKeys)
Arguments
ResourceARN |
[required] The Amazon Resource Name (ARN) of the resource that you want to retrieve tags for. |
TagKeys |
[required] The tag keys to remove from the specified resource. |
Updates an HTTP namespace
Description
Updates an HTTP namespace.
See https://www.paws-r-sdk.com/docs/servicediscovery_update_http_namespace/ for full documentation.
Usage
servicediscovery_update_http_namespace(Id, UpdaterRequestId = NULL, Namespace)
Arguments
Id |
[required] The ID of the namespace that you want to update. |
UpdaterRequestId |
A unique string that identifies the request and that allows failed
|
Namespace |
[required] Updated properties for the the HTTP namespace. |
Submits a request to change the health status of a custom health check to healthy or unhealthy
Description
Submits a request to change the health status of a custom health check to healthy or unhealthy.
See https://www.paws-r-sdk.com/docs/servicediscovery_update_instance_custom_health_status/ for full documentation.
Usage
servicediscovery_update_instance_custom_health_status(
ServiceId,
InstanceId,
Status
)
Arguments
ServiceId |
[required] The ID of the service that includes the configuration for the custom health check that you want to change the status for. |
InstanceId |
[required] The ID of the instance that you want to change the health status for. |
Status |
[required] The new status of the instance, |
Updates a private DNS namespace
Description
Updates a private DNS namespace.
See https://www.paws-r-sdk.com/docs/servicediscovery_update_private_dns_namespace/ for full documentation.
Usage
servicediscovery_update_private_dns_namespace(
Id,
UpdaterRequestId = NULL,
Namespace
)
Arguments
Id |
[required] The ID of the namespace that you want to update. |
UpdaterRequestId |
A unique string that identifies the request and that allows failed
|
Namespace |
[required] Updated properties for the private DNS namespace. |
Updates a public DNS namespace
Description
Updates a public DNS namespace.
See https://www.paws-r-sdk.com/docs/servicediscovery_update_public_dns_namespace/ for full documentation.
Usage
servicediscovery_update_public_dns_namespace(
Id,
UpdaterRequestId = NULL,
Namespace
)
Arguments
Id |
[required] The ID of the namespace being updated. |
UpdaterRequestId |
A unique string that identifies the request and that allows failed
|
Namespace |
[required] Updated properties for the public DNS namespace. |
Submits a request to perform the following operations:
Description
Submits a request to perform the following operations:
See https://www.paws-r-sdk.com/docs/servicediscovery_update_service/ for full documentation.
Usage
servicediscovery_update_service(Id, Service)
Arguments
Id |
[required] The ID of the service that you want to update. |
Service |
[required] A complex type that contains the new settings for the service. You can specify a maximum of 30 attributes (key-value pairs). |
Submits a request to update a specified service to add service-level attributes
Description
Submits a request to update a specified service to add service-level attributes.
See https://www.paws-r-sdk.com/docs/servicediscovery_update_service_attributes/ for full documentation.
Usage
servicediscovery_update_service_attributes(ServiceId, Attributes)
Arguments
ServiceId |
[required] The ID of the service that you want to update. |
Attributes |
[required] A string map that contains attribute key-value pairs. |
AWS Telco Network Builder
Description
Amazon Web Services Telco Network Builder (TNB) is a network automation service that helps you deploy and manage telecom networks. AWS TNB helps you with the lifecycle management of your telecommunication network functions throughout planning, deployment, and post-deployment activities.
Usage
telconetworkbuilder(
config = list(),
credentials = list(),
endpoint = NULL,
region = NULL
)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...)
, where svc
is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- telconetworkbuilder( config = list( credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string", close_connection = "logical", timeout = "numeric", s3_force_path_style = "logical", sts_regional_endpoint = "string" ), credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string" )
Operations
cancel_sol_network_operation | Cancels a network operation |
create_sol_function_package | Creates a function package |
create_sol_network_instance | Creates a network instance |
create_sol_network_package | Creates a network package |
delete_sol_function_package | Deletes a function package |
delete_sol_network_instance | Deletes a network instance |
delete_sol_network_package | Deletes network package |
get_sol_function_instance | Gets the details of a network function instance, including the instantiation state and metadata from the function package descriptor in the network function package |
get_sol_function_package | Gets the details of an individual function package, such as the operational state and whether the package is in use |
get_sol_function_package_content | Gets the contents of a function package |
get_sol_function_package_descriptor | Gets a function package descriptor in a function package |
get_sol_network_instance | Gets the details of the network instance |
get_sol_network_operation | Gets the details of a network operation, including the tasks involved in the network operation and the status of the tasks |
get_sol_network_package | Gets the details of a network package |
get_sol_network_package_content | Gets the contents of a network package |
get_sol_network_package_descriptor | Gets the content of the network service descriptor |
instantiate_sol_network_instance | Instantiates a network instance |
list_sol_function_instances | Lists network function instances |
list_sol_function_packages | Lists information about function packages |
list_sol_network_instances | Lists your network instances |
list_sol_network_operations | Lists details for a network operation, including when the operation started and the status of the operation |
list_sol_network_packages | Lists network packages |
list_tags_for_resource | Lists tags for AWS TNB resources |
put_sol_function_package_content | Uploads the contents of a function package |
put_sol_network_package_content | Uploads the contents of a network package |
tag_resource | Tags an AWS TNB resource |
terminate_sol_network_instance | Terminates a network instance |
untag_resource | Untags an AWS TNB resource |
update_sol_function_package | Updates the operational state of function package |
update_sol_network_instance | Update a network instance |
update_sol_network_package | Updates the operational state of a network package |
validate_sol_function_package_content | Validates function package content |
validate_sol_network_package_content | Validates network package content |
Examples
## Not run:
svc <- telconetworkbuilder()
svc$cancel_sol_network_operation(
Foo = 123
)
## End(Not run)
Cancels a network operation
Description
Cancels a network operation.
See https://www.paws-r-sdk.com/docs/telconetworkbuilder_cancel_sol_network_operation/ for full documentation.
Usage
telconetworkbuilder_cancel_sol_network_operation(nsLcmOpOccId)
Arguments
nsLcmOpOccId |
[required] The identifier of the network operation. |
Creates a function package
Description
Creates a function package.
See https://www.paws-r-sdk.com/docs/telconetworkbuilder_create_sol_function_package/ for full documentation.
Usage
telconetworkbuilder_create_sol_function_package(tags = NULL)
Arguments
tags |
A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs. |
Creates a network instance
Description
Creates a network instance.
See https://www.paws-r-sdk.com/docs/telconetworkbuilder_create_sol_network_instance/ for full documentation.
Usage
telconetworkbuilder_create_sol_network_instance(
nsDescription = NULL,
nsName,
nsdInfoId,
tags = NULL
)
Arguments
nsDescription |
Network instance description. |
nsName |
[required] Network instance name. |
nsdInfoId |
[required] ID for network service descriptor. |
tags |
A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs. |
Creates a network package
Description
Creates a network package.
See https://www.paws-r-sdk.com/docs/telconetworkbuilder_create_sol_network_package/ for full documentation.
Usage
telconetworkbuilder_create_sol_network_package(tags = NULL)
Arguments
tags |
A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs. |
Deletes a function package
Description
Deletes a function package.
See https://www.paws-r-sdk.com/docs/telconetworkbuilder_delete_sol_function_package/ for full documentation.
Usage
telconetworkbuilder_delete_sol_function_package(vnfPkgId)
Arguments
vnfPkgId |
[required] ID of the function package. |
Deletes a network instance
Description
Deletes a network instance.
See https://www.paws-r-sdk.com/docs/telconetworkbuilder_delete_sol_network_instance/ for full documentation.
Usage
telconetworkbuilder_delete_sol_network_instance(nsInstanceId)
Arguments
nsInstanceId |
[required] Network instance ID. |
Deletes network package
Description
Deletes network package.
See https://www.paws-r-sdk.com/docs/telconetworkbuilder_delete_sol_network_package/ for full documentation.
Usage
telconetworkbuilder_delete_sol_network_package(nsdInfoId)
Arguments
nsdInfoId |
[required] ID of the network service descriptor in the network package. |
Gets the details of a network function instance, including the instantiation state and metadata from the function package descriptor in the network function package
Description
Gets the details of a network function instance, including the instantiation state and metadata from the function package descriptor in the network function package.
See https://www.paws-r-sdk.com/docs/telconetworkbuilder_get_sol_function_instance/ for full documentation.
Usage
telconetworkbuilder_get_sol_function_instance(vnfInstanceId)
Arguments
vnfInstanceId |
[required] ID of the network function. |
Gets the details of an individual function package, such as the operational state and whether the package is in use
Description
Gets the details of an individual function package, such as the operational state and whether the package is in use.
See https://www.paws-r-sdk.com/docs/telconetworkbuilder_get_sol_function_package/ for full documentation.
Usage
telconetworkbuilder_get_sol_function_package(vnfPkgId)
Arguments
vnfPkgId |
[required] ID of the function package. |
Gets the contents of a function package
Description
Gets the contents of a function package.
See https://www.paws-r-sdk.com/docs/telconetworkbuilder_get_sol_function_package_content/ for full documentation.
Usage
telconetworkbuilder_get_sol_function_package_content(accept, vnfPkgId)
Arguments
accept |
[required] The format of the package that you want to download from the function packages. |
vnfPkgId |
[required] ID of the function package. |
Gets a function package descriptor in a function package
Description
Gets a function package descriptor in a function package.
See https://www.paws-r-sdk.com/docs/telconetworkbuilder_get_sol_function_package_descriptor/ for full documentation.
Usage
telconetworkbuilder_get_sol_function_package_descriptor(accept, vnfPkgId)
Arguments
accept |
[required] Indicates which content types, expressed as MIME types, the client is able to understand. |
vnfPkgId |
[required] ID of the function package. |
Gets the details of the network instance
Description
Gets the details of the network instance.
See https://www.paws-r-sdk.com/docs/telconetworkbuilder_get_sol_network_instance/ for full documentation.
Usage
telconetworkbuilder_get_sol_network_instance(nsInstanceId)
Arguments
nsInstanceId |
[required] ID of the network instance. |
Gets the details of a network operation, including the tasks involved in the network operation and the status of the tasks
Description
Gets the details of a network operation, including the tasks involved in the network operation and the status of the tasks.
See https://www.paws-r-sdk.com/docs/telconetworkbuilder_get_sol_network_operation/ for full documentation.
Usage
telconetworkbuilder_get_sol_network_operation(nsLcmOpOccId)
Arguments
nsLcmOpOccId |
[required] The identifier of the network operation. |
Gets the details of a network package
Description
Gets the details of a network package.
See https://www.paws-r-sdk.com/docs/telconetworkbuilder_get_sol_network_package/ for full documentation.
Usage
telconetworkbuilder_get_sol_network_package(nsdInfoId)
Arguments
nsdInfoId |
[required] ID of the network service descriptor in the network package. |
Gets the contents of a network package
Description
Gets the contents of a network package.
See https://www.paws-r-sdk.com/docs/telconetworkbuilder_get_sol_network_package_content/ for full documentation.
Usage
telconetworkbuilder_get_sol_network_package_content(accept, nsdInfoId)
Arguments
accept |
[required] The format of the package you want to download from the network package. |
nsdInfoId |
[required] ID of the network service descriptor in the network package. |
Gets the content of the network service descriptor
Description
Gets the content of the network service descriptor.
See https://www.paws-r-sdk.com/docs/telconetworkbuilder_get_sol_network_package_descriptor/ for full documentation.
Usage
telconetworkbuilder_get_sol_network_package_descriptor(nsdInfoId)
Arguments
nsdInfoId |
[required] ID of the network service descriptor in the network package. |
Instantiates a network instance
Description
Instantiates a network instance.
See https://www.paws-r-sdk.com/docs/telconetworkbuilder_instantiate_sol_network_instance/ for full documentation.
Usage
telconetworkbuilder_instantiate_sol_network_instance(
additionalParamsForNs = NULL,
dryRun = NULL,
nsInstanceId,
tags = NULL
)
Arguments
additionalParamsForNs |
Provides values for the configurable properties. |
dryRun |
A check for whether you have the required permissions for the action
without actually making the request and provides an error response. If
you have the required permissions, the error response is
|
nsInstanceId |
[required] ID of the network instance. |
tags |
A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are only applied to the network operation that is created. These tags are not applied to the network instance. Use tags to search and filter your resources or track your Amazon Web Services costs. |
Lists network function instances
Description
Lists network function instances.
See https://www.paws-r-sdk.com/docs/telconetworkbuilder_list_sol_function_instances/ for full documentation.
Usage
telconetworkbuilder_list_sol_function_instances(
maxResults = NULL,
nextToken = NULL
)
Arguments
maxResults |
The maximum number of results to include in the response. |
nextToken |
The token for the next page of results. |
Lists information about function packages
Description
Lists information about function packages.
See https://www.paws-r-sdk.com/docs/telconetworkbuilder_list_sol_function_packages/ for full documentation.
Usage
telconetworkbuilder_list_sol_function_packages(
maxResults = NULL,
nextToken = NULL
)
Arguments
maxResults |
The maximum number of results to include in the response. |
nextToken |
The token for the next page of results. |
Lists your network instances
Description
Lists your network instances.
See https://www.paws-r-sdk.com/docs/telconetworkbuilder_list_sol_network_instances/ for full documentation.
Usage
telconetworkbuilder_list_sol_network_instances(
maxResults = NULL,
nextToken = NULL
)
Arguments
maxResults |
The maximum number of results to include in the response. |
nextToken |
The token for the next page of results. |
Lists details for a network operation, including when the operation started and the status of the operation
Description
Lists details for a network operation, including when the operation started and the status of the operation.
See https://www.paws-r-sdk.com/docs/telconetworkbuilder_list_sol_network_operations/ for full documentation.
Usage
telconetworkbuilder_list_sol_network_operations(
maxResults = NULL,
nextToken = NULL,
nsInstanceId = NULL
)
Arguments
maxResults |
The maximum number of results to include in the response. |
nextToken |
The token for the next page of results. |
nsInstanceId |
Network instance id filter, to retrieve network operations associated to a network instance. |
Lists network packages
Description
Lists network packages.
See https://www.paws-r-sdk.com/docs/telconetworkbuilder_list_sol_network_packages/ for full documentation.
Usage
telconetworkbuilder_list_sol_network_packages(
maxResults = NULL,
nextToken = NULL
)
Arguments
maxResults |
The maximum number of results to include in the response. |
nextToken |
The token for the next page of results. |
Lists tags for AWS TNB resources
Description
Lists tags for AWS TNB resources.
See https://www.paws-r-sdk.com/docs/telconetworkbuilder_list_tags_for_resource/ for full documentation.
Usage
telconetworkbuilder_list_tags_for_resource(resourceArn)
Arguments
resourceArn |
[required] Resource ARN. |
Uploads the contents of a function package
Description
Uploads the contents of a function package.
See https://www.paws-r-sdk.com/docs/telconetworkbuilder_put_sol_function_package_content/ for full documentation.
Usage
telconetworkbuilder_put_sol_function_package_content(
contentType = NULL,
file,
vnfPkgId
)
Arguments
contentType |
Function package content type. |
file |
[required] Function package file. |
vnfPkgId |
[required] Function package ID. |
Uploads the contents of a network package
Description
Uploads the contents of a network package.
See https://www.paws-r-sdk.com/docs/telconetworkbuilder_put_sol_network_package_content/ for full documentation.
Usage
telconetworkbuilder_put_sol_network_package_content(
contentType = NULL,
file,
nsdInfoId
)
Arguments
contentType |
Network package content type. |
file |
[required] Network package file. |
nsdInfoId |
[required] Network service descriptor info ID. |
Tags an AWS TNB resource
Description
Tags an AWS TNB resource.
See https://www.paws-r-sdk.com/docs/telconetworkbuilder_tag_resource/ for full documentation.
Usage
telconetworkbuilder_tag_resource(resourceArn, tags)
Arguments
resourceArn |
[required] Resource ARN. |
tags |
[required] A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs. |
Terminates a network instance
Description
Terminates a network instance.
See https://www.paws-r-sdk.com/docs/telconetworkbuilder_terminate_sol_network_instance/ for full documentation.
Usage
telconetworkbuilder_terminate_sol_network_instance(nsInstanceId, tags = NULL)
Arguments
nsInstanceId |
[required] ID of the network instance. |
tags |
A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are only applied to the network operation that is created. These tags are not applied to the network instance. Use tags to search and filter your resources or track your Amazon Web Services costs. |
Untags an AWS TNB resource
Description
Untags an AWS TNB resource.
See https://www.paws-r-sdk.com/docs/telconetworkbuilder_untag_resource/ for full documentation.
Usage
telconetworkbuilder_untag_resource(resourceArn, tagKeys)
Arguments
resourceArn |
[required] Resource ARN. |
tagKeys |
[required] Tag keys. |
Updates the operational state of function package
Description
Updates the operational state of function package.
See https://www.paws-r-sdk.com/docs/telconetworkbuilder_update_sol_function_package/ for full documentation.
Usage
telconetworkbuilder_update_sol_function_package(operationalState, vnfPkgId)
Arguments
operationalState |
[required] Operational state of the function package. |
vnfPkgId |
[required] ID of the function package. |
Update a network instance
Description
Update a network instance.
See https://www.paws-r-sdk.com/docs/telconetworkbuilder_update_sol_network_instance/ for full documentation.
Usage
telconetworkbuilder_update_sol_network_instance(
modifyVnfInfoData = NULL,
nsInstanceId,
tags = NULL,
updateNs = NULL,
updateType
)
Arguments
modifyVnfInfoData |
Identifies the network function information parameters and/or the configurable properties of the network function to be modified. Include this property only if the update type is
|
nsInstanceId |
[required] ID of the network instance. |
tags |
A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are only applied to the network operation that is created. These tags are not applied to the network instance. Use tags to search and filter your resources or track your Amazon Web Services costs. |
updateNs |
Identifies the network service descriptor and the configurable properties of the descriptor, to be used for the update. Include this property only if the update type is |
updateType |
[required] The type of update.
|
Updates the operational state of a network package
Description
Updates the operational state of a network package.
See https://www.paws-r-sdk.com/docs/telconetworkbuilder_update_sol_network_package/ for full documentation.
Usage
telconetworkbuilder_update_sol_network_package(nsdInfoId, nsdOperationalState)
Arguments
nsdInfoId |
[required] ID of the network service descriptor in the network package. |
nsdOperationalState |
[required] Operational state of the network service descriptor in the network package. |
Validates function package content
Description
Validates function package content. This can be used as a dry run before uploading function package content with put_sol_function_package_content
.
See https://www.paws-r-sdk.com/docs/telconetworkbuilder_validate_sol_function_package_content/ for full documentation.
Usage
telconetworkbuilder_validate_sol_function_package_content(
contentType = NULL,
file,
vnfPkgId
)
Arguments
contentType |
Function package content type. |
file |
[required] Function package file. |
vnfPkgId |
[required] Function package ID. |
Validates network package content
Description
Validates network package content. This can be used as a dry run before uploading network package content with put_sol_network_package_content
.
See https://www.paws-r-sdk.com/docs/telconetworkbuilder_validate_sol_network_package_content/ for full documentation.
Usage
telconetworkbuilder_validate_sol_network_package_content(
contentType = NULL,
file,
nsdInfoId
)
Arguments
contentType |
Network package content type. |
file |
[required] Network package file. |
nsdInfoId |
[required] Network service descriptor file. |
Amazon VPC Lattice
Description
Amazon VPC Lattice is a fully managed application networking service that you use to connect, secure, and monitor all of your services across multiple accounts and virtual private clouds (VPCs). Amazon VPC Lattice interconnects your microservices and legacy services within a logical boundary, so that you can discover and manage them more efficiently. For more information, see the Amazon VPC Lattice User Guide
Usage
vpclattice(
config = list(),
credentials = list(),
endpoint = NULL,
region = NULL
)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...)
, where svc
is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- vpclattice( config = list( credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string", close_connection = "logical", timeout = "numeric", s3_force_path_style = "logical", sts_regional_endpoint = "string" ), credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string" )
Operations
batch_update_rule | Updates the listener rules in a batch |
create_access_log_subscription | Enables access logs to be sent to Amazon CloudWatch, Amazon S3, and Amazon Kinesis Data Firehose |
create_listener | Creates a listener for a service |
create_resource_configuration | Creates a resource configuration |
create_resource_gateway | Creates a resource gateway |
create_rule | Creates a listener rule |
create_service | Creates a service |
create_service_network | Creates a service network |
create_service_network_resource_association | Associates the specified service network with the specified resource configuration |
create_service_network_service_association | Associates the specified service with the specified service network |
create_service_network_vpc_association | Associates a VPC with a service network |
create_target_group | Creates a target group |
delete_access_log_subscription | Deletes the specified access log subscription |
delete_auth_policy | Deletes the specified auth policy |
delete_listener | Deletes the specified listener |
delete_resource_configuration | Deletes the specified resource configuration |
delete_resource_endpoint_association | Disassociates the resource configuration from the resource VPC endpoint |
delete_resource_gateway | Deletes the specified resource gateway |
delete_resource_policy | Deletes the specified resource policy |
delete_rule | Deletes a listener rule |
delete_service | Deletes a service |
delete_service_network | Deletes a service network |
delete_service_network_resource_association | Deletes the association between a service network and a resource configuration |
delete_service_network_service_association | Deletes the association between a service and a service network |
delete_service_network_vpc_association | Disassociates the VPC from the service network |
delete_target_group | Deletes a target group |
deregister_targets | Deregisters the specified targets from the specified target group |
get_access_log_subscription | Retrieves information about the specified access log subscription |
get_auth_policy | Retrieves information about the auth policy for the specified service or service network |
get_listener | Retrieves information about the specified listener for the specified service |
get_resource_configuration | Retrieves information about the specified resource configuration |
get_resource_gateway | Retrieves information about the specified resource gateway |
get_resource_policy | Retrieves information about the specified resource policy |
get_rule | Retrieves information about the specified listener rules |
get_service | Retrieves information about the specified service |
get_service_network | Retrieves information about the specified service network |
get_service_network_resource_association | Retrieves information about the specified association between a service network and a resource configuration |
get_service_network_service_association | Retrieves information about the specified association between a service network and a service |
get_service_network_vpc_association | Retrieves information about the specified association between a service network and a VPC |
get_target_group | Retrieves information about the specified target group |
list_access_log_subscriptions | Lists the access log subscriptions for the specified service network or service |
list_listeners | Lists the listeners for the specified service |
list_resource_configurations | Lists the resource configurations owned by or shared with this account |
list_resource_endpoint_associations | Lists the associations for the specified VPC endpoint |
list_resource_gateways | Lists the resource gateways that you own or that were shared with you |
list_rules | Lists the rules for the specified listener |
list_service_network_resource_associations | Lists the associations between a service network and a resource configuration |
list_service_networks | Lists the service networks owned by or shared with this account |
list_service_network_service_associations | Lists the associations between a service network and a service |
list_service_network_vpc_associations | Lists the associations between a service network and a VPC |
list_service_network_vpc_endpoint_associations | Lists the associations between a service network and a VPC endpoint |
list_services | Lists the services owned by the caller account or shared with the caller account |
list_tags_for_resource | Lists the tags for the specified resource |
list_target_groups | Lists your target groups |
list_targets | Lists the targets for the target group |
put_auth_policy | Creates or updates the auth policy |
put_resource_policy | Attaches a resource-based permission policy to a service or service network |
register_targets | Registers the targets with the target group |
tag_resource | Adds the specified tags to the specified resource |
untag_resource | Removes the specified tags from the specified resource |
update_access_log_subscription | Updates the specified access log subscription |
update_listener | Updates the specified listener for the specified service |
update_resource_configuration | Updates the specified resource configuration |
update_resource_gateway | Updates the specified resource gateway |
update_rule | Updates a specified rule for the listener |
update_service | Updates the specified service |
update_service_network | Updates the specified service network |
update_service_network_vpc_association | Updates the service network and VPC association |
update_target_group | Updates the specified target group |
Examples
## Not run:
svc <- vpclattice()
svc$batch_update_rule(
Foo = 123
)
## End(Not run)
Updates the listener rules in a batch
Description
Updates the listener rules in a batch. You can use this operation to change the priority of listener rules. This can be useful when bulk updating or swapping rule priority.
See https://www.paws-r-sdk.com/docs/vpclattice_batch_update_rule/ for full documentation.
Usage
vpclattice_batch_update_rule(listenerIdentifier, rules, serviceIdentifier)
Arguments
listenerIdentifier |
[required] The ID or ARN of the listener. |
rules |
[required] The rules for the specified listener. |
serviceIdentifier |
[required] The ID or ARN of the service. |
Enables access logs to be sent to Amazon CloudWatch, Amazon S3, and Amazon Kinesis Data Firehose
Description
Enables access logs to be sent to Amazon CloudWatch, Amazon S3, and Amazon Kinesis Data Firehose. The service network owner can use the access logs to audit the services in the network. The service network owner can only see access logs from clients and services that are associated with their service network. Access log entries represent traffic originated from VPCs associated with that network. For more information, see Access logs in the Amazon VPC Lattice User Guide.
See https://www.paws-r-sdk.com/docs/vpclattice_create_access_log_subscription/ for full documentation.
Usage
vpclattice_create_access_log_subscription(
clientToken = NULL,
destinationArn,
resourceIdentifier,
serviceNetworkLogType = NULL,
tags = NULL
)
Arguments
clientToken |
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails. |
destinationArn |
[required] The Amazon Resource Name (ARN) of the destination. The supported destination types are CloudWatch Log groups, Kinesis Data Firehose delivery streams, and Amazon S3 buckets. |
resourceIdentifier |
[required] The ID or ARN of the service network or service. |
serviceNetworkLogType |
The type of log that monitors your Amazon VPC Lattice service networks. |
tags |
The tags for the access log subscription. |
Creates a listener for a service
Description
Creates a listener for a service. Before you start using your Amazon VPC Lattice service, you must add one or more listeners. A listener is a process that checks for connection requests to your services. For more information, see Listeners in the Amazon VPC Lattice User Guide.
See https://www.paws-r-sdk.com/docs/vpclattice_create_listener/ for full documentation.
Usage
vpclattice_create_listener(
clientToken = NULL,
defaultAction,
name,
port = NULL,
protocol,
serviceIdentifier,
tags = NULL
)
Arguments
clientToken |
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails. |
defaultAction |
[required] The action for the default rule. Each listener has a default rule. The default rule is used if no other rules match. |
name |
[required] The name of the listener. A listener name must be unique within a service. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen. |
port |
The listener port. You can specify a value from 1 to 65535. For HTTP, the default is 80. For HTTPS, the default is 443. |
protocol |
[required] The listener protocol. |
serviceIdentifier |
[required] The ID or ARN of the service. |
tags |
The tags for the listener. |
Creates a resource configuration
Description
Creates a resource configuration. A resource configuration defines a specific resource. You can associate a resource configuration with a service network or a VPC endpoint.
See https://www.paws-r-sdk.com/docs/vpclattice_create_resource_configuration/ for full documentation.
Usage
vpclattice_create_resource_configuration(
allowAssociationToShareableServiceNetwork = NULL,
clientToken = NULL,
name,
portRanges = NULL,
protocol = NULL,
resourceConfigurationDefinition = NULL,
resourceConfigurationGroupIdentifier = NULL,
resourceGatewayIdentifier = NULL,
tags = NULL,
type
)
Arguments
allowAssociationToShareableServiceNetwork |
(SINGLE, GROUP, ARN) Specifies whether the resource configuration can be associated with a sharable service network. The default is false. |
clientToken |
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails. |
name |
[required] The name of the resource configuration. The name must be unique within the account. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen. |
portRanges |
(SINGLE, GROUP, CHILD) The TCP port ranges that a consumer can use to access a resource configuration (for example: 1-65535). You can separate port ranges using commas (for example: 1,2,22-30). |
protocol |
(SINGLE, GROUP) The protocol accepted by the resource configuration. |
resourceConfigurationDefinition |
(SINGLE, CHILD, ARN) The resource configuration. |
resourceConfigurationGroupIdentifier |
(CHILD) The ID or ARN of the parent resource configuration (type is
|
resourceGatewayIdentifier |
(SINGLE, GROUP, ARN) The ID or ARN of the resource gateway used to connect to the resource configuration. For a child resource configuration, this value is inherited from the parent resource configuration. |
tags |
The tags for the resource configuration. |
type |
[required] The type of resource configuration.
|
Creates a resource gateway
Description
Creates a resource gateway.
See https://www.paws-r-sdk.com/docs/vpclattice_create_resource_gateway/ for full documentation.
Usage
vpclattice_create_resource_gateway(
clientToken = NULL,
ipAddressType = NULL,
name,
securityGroupIds = NULL,
subnetIds,
tags = NULL,
vpcIdentifier
)
Arguments
clientToken |
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails. |
ipAddressType |
The type of IP address used by the resource gateway. |
name |
[required] The name of the resource gateway. |
securityGroupIds |
The IDs of the security groups to apply to the resource gateway. The security groups must be in the same VPC. |
subnetIds |
[required] The IDs of the VPC subnets in which to create the resource gateway. |
tags |
The tags for the resource gateway. |
vpcIdentifier |
[required] The ID of the VPC for the resource gateway. |
Creates a listener rule
Description
Creates a listener rule. Each listener has a default rule for checking connection requests, but you can define additional rules. Each rule consists of a priority, one or more actions, and one or more conditions. For more information, see Listener rules in the Amazon VPC Lattice User Guide.
See https://www.paws-r-sdk.com/docs/vpclattice_create_rule/ for full documentation.
Usage
vpclattice_create_rule(
action,
clientToken = NULL,
listenerIdentifier,
match,
name,
priority,
serviceIdentifier,
tags = NULL
)
Arguments
action |
[required] The action for the default rule. |
clientToken |
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails. |
listenerIdentifier |
[required] The ID or ARN of the listener. |
match |
[required] The rule match. |
name |
[required] The name of the rule. The name must be unique within the listener. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen. |
priority |
[required] The priority assigned to the rule. Each rule for a specific listener must have a unique priority. The lower the priority number the higher the priority. |
serviceIdentifier |
[required] The ID or ARN of the service. |
tags |
The tags for the rule. |
Creates a service
Description
Creates a service. A service is any software application that can run on instances containers, or serverless functions within an account or virtual private cloud (VPC).
See https://www.paws-r-sdk.com/docs/vpclattice_create_service/ for full documentation.
Usage
vpclattice_create_service(
authType = NULL,
certificateArn = NULL,
clientToken = NULL,
customDomainName = NULL,
name,
tags = NULL
)
Arguments
authType |
The type of IAM policy.
|
certificateArn |
The Amazon Resource Name (ARN) of the certificate. |
clientToken |
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails. |
customDomainName |
The custom domain name of the service. |
name |
[required] The name of the service. The name must be unique within the account. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen. |
tags |
The tags for the service. |
Creates a service network
Description
Creates a service network. A service network is a logical boundary for a collection of services. You can associate services and VPCs with a service network.
See https://www.paws-r-sdk.com/docs/vpclattice_create_service_network/ for full documentation.
Usage
vpclattice_create_service_network(
authType = NULL,
clientToken = NULL,
name,
sharingConfig = NULL,
tags = NULL
)
Arguments
authType |
The type of IAM policy.
|
clientToken |
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails. |
name |
[required] The name of the service network. The name must be unique to the account. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen. |
sharingConfig |
Specify if the service network should be enabled for sharing. |
tags |
The tags for the service network. |
Associates the specified service network with the specified resource configuration
Description
Associates the specified service network with the specified resource configuration. This allows the resource configuration to receive connections through the service network, including through a service network VPC endpoint.
See https://www.paws-r-sdk.com/docs/vpclattice_create_service_network_resource_association/ for full documentation.
Usage
vpclattice_create_service_network_resource_association(
clientToken = NULL,
resourceConfigurationIdentifier,
serviceNetworkIdentifier,
tags = NULL
)
Arguments
clientToken |
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails. |
resourceConfigurationIdentifier |
[required] The ID of the resource configuration to associate with the service network. |
serviceNetworkIdentifier |
[required] The ID of the service network to associate with the resource configuration. |
tags |
The tags for the association. |
Associates the specified service with the specified service network
Description
Associates the specified service with the specified service network. For more information, see Manage service associations in the Amazon VPC Lattice User Guide.
See https://www.paws-r-sdk.com/docs/vpclattice_create_service_network_service_association/ for full documentation.
Usage
vpclattice_create_service_network_service_association(
clientToken = NULL,
serviceIdentifier,
serviceNetworkIdentifier,
tags = NULL
)
Arguments
clientToken |
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails. |
serviceIdentifier |
[required] The ID or ARN of the service. |
serviceNetworkIdentifier |
[required] The ID or ARN of the service network. You must use an ARN if the resources are in different accounts. |
tags |
The tags for the association. |
Associates a VPC with a service network
Description
Associates a VPC with a service network. When you associate a VPC with the service network, it enables all the resources within that VPC to be clients and communicate with other services in the service network. For more information, see Manage VPC associations in the Amazon VPC Lattice User Guide.
See https://www.paws-r-sdk.com/docs/vpclattice_create_service_network_vpc_association/ for full documentation.
Usage
vpclattice_create_service_network_vpc_association(
clientToken = NULL,
securityGroupIds = NULL,
serviceNetworkIdentifier,
tags = NULL,
vpcIdentifier
)
Arguments
clientToken |
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails. |
securityGroupIds |
The IDs of the security groups. Security groups aren't added by default. You can add a security group to apply network level controls to control which resources in a VPC are allowed to access the service network and its services. For more information, see Control traffic to resources using security groups in the Amazon VPC User Guide. |
serviceNetworkIdentifier |
[required] The ID or ARN of the service network. You must use an ARN if the resources are in different accounts. |
tags |
The tags for the association. |
vpcIdentifier |
[required] The ID of the VPC. |
Creates a target group
Description
Creates a target group. A target group is a collection of targets, or compute resources, that run your application or service. A target group can only be used by a single service.
See https://www.paws-r-sdk.com/docs/vpclattice_create_target_group/ for full documentation.
Usage
vpclattice_create_target_group(
clientToken = NULL,
config = NULL,
name,
tags = NULL,
type
)
Arguments
clientToken |
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails. |
config |
The target group configuration. |
name |
[required] The name of the target group. The name must be unique within the account. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen. |
tags |
The tags for the target group. |
type |
[required] The type of target group. |
Deletes the specified access log subscription
Description
Deletes the specified access log subscription.
See https://www.paws-r-sdk.com/docs/vpclattice_delete_access_log_subscription/ for full documentation.
Usage
vpclattice_delete_access_log_subscription(accessLogSubscriptionIdentifier)
Arguments
accessLogSubscriptionIdentifier |
[required] The ID or ARN of the access log subscription. |
Deletes the specified auth policy
Description
Deletes the specified auth policy. If an auth is set to AWS_IAM
and the auth policy is deleted, all requests are denied. If you are trying to remove the auth policy completely, you must set the auth type to NONE
. If auth is enabled on the resource, but no auth policy is set, all requests are denied.
See https://www.paws-r-sdk.com/docs/vpclattice_delete_auth_policy/ for full documentation.
Usage
vpclattice_delete_auth_policy(resourceIdentifier)
Arguments
resourceIdentifier |
[required] The ID or ARN of the resource. |
Deletes the specified listener
Description
Deletes the specified listener.
See https://www.paws-r-sdk.com/docs/vpclattice_delete_listener/ for full documentation.
Usage
vpclattice_delete_listener(listenerIdentifier, serviceIdentifier)
Arguments
listenerIdentifier |
[required] The ID or ARN of the listener. |
serviceIdentifier |
[required] The ID or ARN of the service. |
Deletes the specified resource configuration
Description
Deletes the specified resource configuration.
See https://www.paws-r-sdk.com/docs/vpclattice_delete_resource_configuration/ for full documentation.
Usage
vpclattice_delete_resource_configuration(resourceConfigurationIdentifier)
Arguments
resourceConfigurationIdentifier |
[required] The ID or ARN of the resource configuration. |
Disassociates the resource configuration from the resource VPC endpoint
Description
Disassociates the resource configuration from the resource VPC endpoint.
See https://www.paws-r-sdk.com/docs/vpclattice_delete_resource_endpoint_association/ for full documentation.
Usage
vpclattice_delete_resource_endpoint_association(
resourceEndpointAssociationIdentifier
)
Arguments
resourceEndpointAssociationIdentifier |
[required] The ID or ARN of the association. |
Deletes the specified resource gateway
Description
Deletes the specified resource gateway.
See https://www.paws-r-sdk.com/docs/vpclattice_delete_resource_gateway/ for full documentation.
Usage
vpclattice_delete_resource_gateway(resourceGatewayIdentifier)
Arguments
resourceGatewayIdentifier |
[required] The ID or ARN of the resource gateway. |
Deletes the specified resource policy
Description
Deletes the specified resource policy.
See https://www.paws-r-sdk.com/docs/vpclattice_delete_resource_policy/ for full documentation.
Usage
vpclattice_delete_resource_policy(resourceArn)
Arguments
resourceArn |
[required] The Amazon Resource Name (ARN) of the resource. |
Deletes a listener rule
Description
Deletes a listener rule. Each listener has a default rule for checking connection requests, but you can define additional rules. Each rule consists of a priority, one or more actions, and one or more conditions. You can delete additional listener rules, but you cannot delete the default rule.
See https://www.paws-r-sdk.com/docs/vpclattice_delete_rule/ for full documentation.
Usage
vpclattice_delete_rule(listenerIdentifier, ruleIdentifier, serviceIdentifier)
Arguments
listenerIdentifier |
[required] The ID or ARN of the listener. |
ruleIdentifier |
[required] The ID or ARN of the rule. |
serviceIdentifier |
[required] The ID or ARN of the service. |
Deletes a service
Description
Deletes a service. A service can't be deleted if it's associated with a service network. If you delete a service, all resources related to the service, such as the resource policy, auth policy, listeners, listener rules, and access log subscriptions, are also deleted. For more information, see Delete a service in the Amazon VPC Lattice User Guide.
See https://www.paws-r-sdk.com/docs/vpclattice_delete_service/ for full documentation.
Usage
vpclattice_delete_service(serviceIdentifier)
Arguments
serviceIdentifier |
[required] The ID or ARN of the service. |
Deletes a service network
Description
Deletes a service network. You can only delete the service network if there is no service or VPC associated with it. If you delete a service network, all resources related to the service network, such as the resource policy, auth policy, and access log subscriptions, are also deleted. For more information, see Delete a service network in the Amazon VPC Lattice User Guide.
See https://www.paws-r-sdk.com/docs/vpclattice_delete_service_network/ for full documentation.
Usage
vpclattice_delete_service_network(serviceNetworkIdentifier)
Arguments
serviceNetworkIdentifier |
[required] The ID or ARN of the service network. |
Deletes the association between a service network and a resource configuration
Description
Deletes the association between a service network and a resource configuration.
See https://www.paws-r-sdk.com/docs/vpclattice_delete_service_network_resource_association/ for full documentation.
Usage
vpclattice_delete_service_network_resource_association(
serviceNetworkResourceAssociationIdentifier
)
Arguments
serviceNetworkResourceAssociationIdentifier |
[required] The ID of the association. |
Deletes the association between a service and a service network
Description
Deletes the association between a service and a service network. This operation fails if an association is still in progress.
See https://www.paws-r-sdk.com/docs/vpclattice_delete_service_network_service_association/ for full documentation.
Usage
vpclattice_delete_service_network_service_association(
serviceNetworkServiceAssociationIdentifier
)
Arguments
serviceNetworkServiceAssociationIdentifier |
[required] The ID or ARN of the association. |
Disassociates the VPC from the service network
Description
Disassociates the VPC from the service network. You can't disassociate the VPC if there is a create or update association in progress.
See https://www.paws-r-sdk.com/docs/vpclattice_delete_service_network_vpc_association/ for full documentation.
Usage
vpclattice_delete_service_network_vpc_association(
serviceNetworkVpcAssociationIdentifier
)
Arguments
serviceNetworkVpcAssociationIdentifier |
[required] The ID or ARN of the association. |
Deletes a target group
Description
Deletes a target group. You can't delete a target group if it is used in a listener rule or if the target group creation is in progress.
See https://www.paws-r-sdk.com/docs/vpclattice_delete_target_group/ for full documentation.
Usage
vpclattice_delete_target_group(targetGroupIdentifier)
Arguments
targetGroupIdentifier |
[required] The ID or ARN of the target group. |
Deregisters the specified targets from the specified target group
Description
Deregisters the specified targets from the specified target group.
See https://www.paws-r-sdk.com/docs/vpclattice_deregister_targets/ for full documentation.
Usage
vpclattice_deregister_targets(targetGroupIdentifier, targets)
Arguments
targetGroupIdentifier |
[required] The ID or ARN of the target group. |
targets |
[required] The targets to deregister. |
Retrieves information about the specified access log subscription
Description
Retrieves information about the specified access log subscription.
See https://www.paws-r-sdk.com/docs/vpclattice_get_access_log_subscription/ for full documentation.
Usage
vpclattice_get_access_log_subscription(accessLogSubscriptionIdentifier)
Arguments
accessLogSubscriptionIdentifier |
[required] The ID or ARN of the access log subscription. |
Retrieves information about the auth policy for the specified service or service network
Description
Retrieves information about the auth policy for the specified service or service network.
See https://www.paws-r-sdk.com/docs/vpclattice_get_auth_policy/ for full documentation.
Usage
vpclattice_get_auth_policy(resourceIdentifier)
Arguments
resourceIdentifier |
[required] The ID or ARN of the service network or service. |
Retrieves information about the specified listener for the specified service
Description
Retrieves information about the specified listener for the specified service.
See https://www.paws-r-sdk.com/docs/vpclattice_get_listener/ for full documentation.
Usage
vpclattice_get_listener(listenerIdentifier, serviceIdentifier)
Arguments
listenerIdentifier |
[required] The ID or ARN of the listener. |
serviceIdentifier |
[required] The ID or ARN of the service. |
Retrieves information about the specified resource configuration
Description
Retrieves information about the specified resource configuration.
See https://www.paws-r-sdk.com/docs/vpclattice_get_resource_configuration/ for full documentation.
Usage
vpclattice_get_resource_configuration(resourceConfigurationIdentifier)
Arguments
resourceConfigurationIdentifier |
[required] The ID of the resource configuration. |
Retrieves information about the specified resource gateway
Description
Retrieves information about the specified resource gateway.
See https://www.paws-r-sdk.com/docs/vpclattice_get_resource_gateway/ for full documentation.
Usage
vpclattice_get_resource_gateway(resourceGatewayIdentifier)
Arguments
resourceGatewayIdentifier |
[required] The ID of the resource gateway. |
Retrieves information about the specified resource policy
Description
Retrieves information about the specified resource policy. The resource policy is an IAM policy created on behalf of the resource owner when they share a resource.
See https://www.paws-r-sdk.com/docs/vpclattice_get_resource_policy/ for full documentation.
Usage
vpclattice_get_resource_policy(resourceArn)
Arguments
resourceArn |
[required] The Amazon Resource Name (ARN) of the service network or service. |
Retrieves information about the specified listener rules
Description
Retrieves information about the specified listener rules. You can also retrieve information about the default listener rule. For more information, see Listener rules in the Amazon VPC Lattice User Guide.
See https://www.paws-r-sdk.com/docs/vpclattice_get_rule/ for full documentation.
Usage
vpclattice_get_rule(listenerIdentifier, ruleIdentifier, serviceIdentifier)
Arguments
listenerIdentifier |
[required] The ID or ARN of the listener. |
ruleIdentifier |
[required] The ID or ARN of the listener rule. |
serviceIdentifier |
[required] The ID or ARN of the service. |
Retrieves information about the specified service
Description
Retrieves information about the specified service.
See https://www.paws-r-sdk.com/docs/vpclattice_get_service/ for full documentation.
Usage
vpclattice_get_service(serviceIdentifier)
Arguments
serviceIdentifier |
[required] The ID or ARN of the service. |
Retrieves information about the specified service network
Description
Retrieves information about the specified service network.
See https://www.paws-r-sdk.com/docs/vpclattice_get_service_network/ for full documentation.
Usage
vpclattice_get_service_network(serviceNetworkIdentifier)
Arguments
serviceNetworkIdentifier |
[required] The ID or ARN of the service network. |
Retrieves information about the specified association between a service network and a resource configuration
Description
Retrieves information about the specified association between a service network and a resource configuration.
See https://www.paws-r-sdk.com/docs/vpclattice_get_service_network_resource_association/ for full documentation.
Usage
vpclattice_get_service_network_resource_association(
serviceNetworkResourceAssociationIdentifier
)
Arguments
serviceNetworkResourceAssociationIdentifier |
[required] The ID of the association. |
Retrieves information about the specified association between a service network and a service
Description
Retrieves information about the specified association between a service network and a service.
See https://www.paws-r-sdk.com/docs/vpclattice_get_service_network_service_association/ for full documentation.
Usage
vpclattice_get_service_network_service_association(
serviceNetworkServiceAssociationIdentifier
)
Arguments
serviceNetworkServiceAssociationIdentifier |
[required] The ID or ARN of the association. |
Retrieves information about the specified association between a service network and a VPC
Description
Retrieves information about the specified association between a service network and a VPC.
See https://www.paws-r-sdk.com/docs/vpclattice_get_service_network_vpc_association/ for full documentation.
Usage
vpclattice_get_service_network_vpc_association(
serviceNetworkVpcAssociationIdentifier
)
Arguments
serviceNetworkVpcAssociationIdentifier |
[required] The ID or ARN of the association. |
Retrieves information about the specified target group
Description
Retrieves information about the specified target group.
See https://www.paws-r-sdk.com/docs/vpclattice_get_target_group/ for full documentation.
Usage
vpclattice_get_target_group(targetGroupIdentifier)
Arguments
targetGroupIdentifier |
[required] The ID or ARN of the target group. |
Lists the access log subscriptions for the specified service network or service
Description
Lists the access log subscriptions for the specified service network or service.
See https://www.paws-r-sdk.com/docs/vpclattice_list_access_log_subscriptions/ for full documentation.
Usage
vpclattice_list_access_log_subscriptions(
maxResults = NULL,
nextToken = NULL,
resourceIdentifier
)
Arguments
maxResults |
The maximum number of results to return. |
nextToken |
A pagination token for the next page of results. |
resourceIdentifier |
[required] The ID or ARN of the service network or service. |
Lists the listeners for the specified service
Description
Lists the listeners for the specified service.
See https://www.paws-r-sdk.com/docs/vpclattice_list_listeners/ for full documentation.
Usage
vpclattice_list_listeners(
maxResults = NULL,
nextToken = NULL,
serviceIdentifier
)
Arguments
maxResults |
The maximum number of results to return. |
nextToken |
A pagination token for the next page of results. |
serviceIdentifier |
[required] The ID or ARN of the service. |
Lists the resource configurations owned by or shared with this account
Description
Lists the resource configurations owned by or shared with this account.
See https://www.paws-r-sdk.com/docs/vpclattice_list_resource_configurations/ for full documentation.
Usage
vpclattice_list_resource_configurations(
maxResults = NULL,
nextToken = NULL,
resourceConfigurationGroupIdentifier = NULL,
resourceGatewayIdentifier = NULL
)
Arguments
maxResults |
The maximum page size. |
nextToken |
A pagination token for the next page of results. |
resourceConfigurationGroupIdentifier |
The ID of the group resource configuration. |
resourceGatewayIdentifier |
The ID of the resource gateway for the resource configuration. |
Lists the associations for the specified VPC endpoint
Description
Lists the associations for the specified VPC endpoint.
See https://www.paws-r-sdk.com/docs/vpclattice_list_resource_endpoint_associations/ for full documentation.
Usage
vpclattice_list_resource_endpoint_associations(
maxResults = NULL,
nextToken = NULL,
resourceConfigurationIdentifier,
resourceEndpointAssociationIdentifier = NULL,
vpcEndpointId = NULL,
vpcEndpointOwner = NULL
)
Arguments
maxResults |
The maximum page size. |
nextToken |
A pagination token for the next page of results. |
resourceConfigurationIdentifier |
[required] The ID for the resource configuration associated with the VPC endpoint. |
resourceEndpointAssociationIdentifier |
The ID of the association. |
vpcEndpointId |
The ID of the VPC endpoint in the association. |
vpcEndpointOwner |
The owner of the VPC endpoint in the association. |
Lists the resource gateways that you own or that were shared with you
Description
Lists the resource gateways that you own or that were shared with you.
See https://www.paws-r-sdk.com/docs/vpclattice_list_resource_gateways/ for full documentation.
Usage
vpclattice_list_resource_gateways(maxResults = NULL, nextToken = NULL)
Arguments
maxResults |
The maximum page size. |
nextToken |
If there are additional results, a pagination token for the next page of results. |
Lists the rules for the specified listener
Description
Lists the rules for the specified listener.
See https://www.paws-r-sdk.com/docs/vpclattice_list_rules/ for full documentation.
Usage
vpclattice_list_rules(
listenerIdentifier,
maxResults = NULL,
nextToken = NULL,
serviceIdentifier
)
Arguments
listenerIdentifier |
[required] The ID or ARN of the listener. |
maxResults |
The maximum number of results to return. |
nextToken |
A pagination token for the next page of results. |
serviceIdentifier |
[required] The ID or ARN of the service. |
Lists the associations between a service network and a resource configuration
Description
Lists the associations between a service network and a resource configuration.
See https://www.paws-r-sdk.com/docs/vpclattice_list_service_network_resource_associations/ for full documentation.
Usage
vpclattice_list_service_network_resource_associations(
maxResults = NULL,
nextToken = NULL,
resourceConfigurationIdentifier = NULL,
serviceNetworkIdentifier = NULL
)
Arguments
maxResults |
The maximum page size. |
nextToken |
If there are additional results, a pagination token for the next page of results. |
resourceConfigurationIdentifier |
The ID of the resource configurationk. |
serviceNetworkIdentifier |
The ID of the service network. |
Lists the associations between a service network and a service
Description
Lists the associations between a service network and a service. You can filter the list either by service or service network. You must provide either the service network identifier or the service identifier.
See https://www.paws-r-sdk.com/docs/vpclattice_list_service_network_service_associations/ for full documentation.
Usage
vpclattice_list_service_network_service_associations(
maxResults = NULL,
nextToken = NULL,
serviceIdentifier = NULL,
serviceNetworkIdentifier = NULL
)
Arguments
maxResults |
The maximum number of results to return. |
nextToken |
A pagination token for the next page of results. |
serviceIdentifier |
The ID or ARN of the service. |
serviceNetworkIdentifier |
The ID or ARN of the service network. |
Lists the associations between a service network and a VPC
Description
Lists the associations between a service network and a VPC. You can filter the list either by VPC or service network. You must provide either the ID of the service network identifier or the ID of the VPC.
See https://www.paws-r-sdk.com/docs/vpclattice_list_service_network_vpc_associations/ for full documentation.
Usage
vpclattice_list_service_network_vpc_associations(
maxResults = NULL,
nextToken = NULL,
serviceNetworkIdentifier = NULL,
vpcIdentifier = NULL
)
Arguments
maxResults |
The maximum number of results to return. |
nextToken |
A pagination token for the next page of results. |
serviceNetworkIdentifier |
The ID or ARN of the service network. |
vpcIdentifier |
The ID or ARN of the VPC. |
Lists the associations between a service network and a VPC endpoint
Description
Lists the associations between a service network and a VPC endpoint.
See https://www.paws-r-sdk.com/docs/vpclattice_list_service_network_vpc_endpoint_associations/ for full documentation.
Usage
vpclattice_list_service_network_vpc_endpoint_associations(
maxResults = NULL,
nextToken = NULL,
serviceNetworkIdentifier
)
Arguments
maxResults |
The maximum page size. |
nextToken |
If there are additional results, a pagination token for the next page of results. |
serviceNetworkIdentifier |
[required] The ID of the service network associated with the VPC endpoint. |
Lists the service networks owned by or shared with this account
Description
Lists the service networks owned by or shared with this account. The account ID in the ARN shows which account owns the service network.
See https://www.paws-r-sdk.com/docs/vpclattice_list_service_networks/ for full documentation.
Usage
vpclattice_list_service_networks(maxResults = NULL, nextToken = NULL)
Arguments
maxResults |
The maximum number of results to return. |
nextToken |
A pagination token for the next page of results. |
Lists the services owned by the caller account or shared with the caller account
Description
Lists the services owned by the caller account or shared with the caller account.
See https://www.paws-r-sdk.com/docs/vpclattice_list_services/ for full documentation.
Usage
vpclattice_list_services(maxResults = NULL, nextToken = NULL)
Arguments
maxResults |
The maximum number of results to return. |
nextToken |
A pagination token for the next page of results. |
Lists the tags for the specified resource
Description
Lists the tags for the specified resource.
See https://www.paws-r-sdk.com/docs/vpclattice_list_tags_for_resource/ for full documentation.
Usage
vpclattice_list_tags_for_resource(resourceArn)
Arguments
resourceArn |
[required] The Amazon Resource Name (ARN) of the resource. |
Lists your target groups
Description
Lists your target groups. You can narrow your search by using the filters below in your request.
See https://www.paws-r-sdk.com/docs/vpclattice_list_target_groups/ for full documentation.
Usage
vpclattice_list_target_groups(
maxResults = NULL,
nextToken = NULL,
targetGroupType = NULL,
vpcIdentifier = NULL
)
Arguments
maxResults |
The maximum number of results to return. |
nextToken |
A pagination token for the next page of results. |
targetGroupType |
The target group type. |
vpcIdentifier |
The ID or ARN of the VPC. |
Lists the targets for the target group
Description
Lists the targets for the target group. By default, all targets are included. You can use this API to check the health status of targets. You can also filter the results by target.
See https://www.paws-r-sdk.com/docs/vpclattice_list_targets/ for full documentation.
Usage
vpclattice_list_targets(
maxResults = NULL,
nextToken = NULL,
targetGroupIdentifier,
targets = NULL
)
Arguments
maxResults |
The maximum number of results to return. |
nextToken |
A pagination token for the next page of results. |
targetGroupIdentifier |
[required] The ID or ARN of the target group. |
targets |
The targets. |
Creates or updates the auth policy
Description
Creates or updates the auth policy. The policy string in JSON must not contain newlines or blank lines.
See https://www.paws-r-sdk.com/docs/vpclattice_put_auth_policy/ for full documentation.
Usage
vpclattice_put_auth_policy(policy, resourceIdentifier)
Arguments
policy |
[required] The auth policy. The policy string in JSON must not contain newlines or blank lines. |
resourceIdentifier |
[required] The ID or ARN of the service network or service for which the policy is created. |
Attaches a resource-based permission policy to a service or service network
Description
Attaches a resource-based permission policy to a service or service network. The policy must contain the same actions and condition statements as the Amazon Web Services Resource Access Manager permission for sharing services and service networks.
See https://www.paws-r-sdk.com/docs/vpclattice_put_resource_policy/ for full documentation.
Usage
vpclattice_put_resource_policy(policy, resourceArn)
Arguments
policy |
[required] An IAM policy. The policy string in JSON must not contain newlines or blank lines. |
resourceArn |
[required] The ID or ARN of the service network or service for which the policy is created. |
Registers the targets with the target group
Description
Registers the targets with the target group. If it's a Lambda target, you can only have one target in a target group.
See https://www.paws-r-sdk.com/docs/vpclattice_register_targets/ for full documentation.
Usage
vpclattice_register_targets(targetGroupIdentifier, targets)
Arguments
targetGroupIdentifier |
[required] The ID or ARN of the target group. |
targets |
[required] The targets. |
Adds the specified tags to the specified resource
Description
Adds the specified tags to the specified resource.
See https://www.paws-r-sdk.com/docs/vpclattice_tag_resource/ for full documentation.
Usage
vpclattice_tag_resource(resourceArn, tags)
Arguments
resourceArn |
[required] The Amazon Resource Name (ARN) of the resource. |
tags |
[required] The tags for the resource. |
Removes the specified tags from the specified resource
Description
Removes the specified tags from the specified resource.
See https://www.paws-r-sdk.com/docs/vpclattice_untag_resource/ for full documentation.
Usage
vpclattice_untag_resource(resourceArn, tagKeys)
Arguments
resourceArn |
[required] The Amazon Resource Name (ARN) of the resource. |
tagKeys |
[required] The tag keys of the tags to remove. |
Updates the specified access log subscription
Description
Updates the specified access log subscription.
See https://www.paws-r-sdk.com/docs/vpclattice_update_access_log_subscription/ for full documentation.
Usage
vpclattice_update_access_log_subscription(
accessLogSubscriptionIdentifier,
destinationArn
)
Arguments
accessLogSubscriptionIdentifier |
[required] The ID or ARN of the access log subscription. |
destinationArn |
[required] The Amazon Resource Name (ARN) of the access log destination. |
Updates the specified listener for the specified service
Description
Updates the specified listener for the specified service.
See https://www.paws-r-sdk.com/docs/vpclattice_update_listener/ for full documentation.
Usage
vpclattice_update_listener(
defaultAction,
listenerIdentifier,
serviceIdentifier
)
Arguments
defaultAction |
[required] The action for the default rule. |
listenerIdentifier |
[required] The ID or ARN of the listener. |
serviceIdentifier |
[required] The ID or ARN of the service. |
Updates the specified resource configuration
Description
Updates the specified resource configuration.
See https://www.paws-r-sdk.com/docs/vpclattice_update_resource_configuration/ for full documentation.
Usage
vpclattice_update_resource_configuration(
allowAssociationToShareableServiceNetwork = NULL,
portRanges = NULL,
resourceConfigurationDefinition = NULL,
resourceConfigurationIdentifier
)
Arguments
allowAssociationToShareableServiceNetwork |
Indicates whether to add the resource configuration to service networks that are shared with other accounts. |
portRanges |
The TCP port ranges that a consumer can use to access a resource configuration. You can separate port ranges with a comma. Example: 1-65535 or 1,2,22-30 |
resourceConfigurationDefinition |
The resource configuration. |
resourceConfigurationIdentifier |
[required] The ID of the resource configuration. |
Updates the specified resource gateway
Description
Updates the specified resource gateway.
See https://www.paws-r-sdk.com/docs/vpclattice_update_resource_gateway/ for full documentation.
Usage
vpclattice_update_resource_gateway(
resourceGatewayIdentifier,
securityGroupIds = NULL
)
Arguments
resourceGatewayIdentifier |
[required] The ID or ARN of the resource gateway. |
securityGroupIds |
The IDs of the security groups associated with the resource gateway. |
Updates a specified rule for the listener
Description
Updates a specified rule for the listener. You can't modify a default listener rule. To modify a default listener rule, use update_listener
.
See https://www.paws-r-sdk.com/docs/vpclattice_update_rule/ for full documentation.
Usage
vpclattice_update_rule(
action = NULL,
listenerIdentifier,
match = NULL,
priority = NULL,
ruleIdentifier,
serviceIdentifier
)
Arguments
action |
Information about the action for the specified listener rule. |
listenerIdentifier |
[required] The ID or ARN of the listener. |
match |
The rule match. |
priority |
The rule priority. A listener can't have multiple rules with the same priority. |
ruleIdentifier |
[required] The ID or ARN of the rule. |
serviceIdentifier |
[required] The ID or ARN of the service. |
Updates the specified service
Description
Updates the specified service.
See https://www.paws-r-sdk.com/docs/vpclattice_update_service/ for full documentation.
Usage
vpclattice_update_service(
authType = NULL,
certificateArn = NULL,
serviceIdentifier
)
Arguments
authType |
The type of IAM policy.
|
certificateArn |
The Amazon Resource Name (ARN) of the certificate. |
serviceIdentifier |
[required] The ID or ARN of the service. |
Updates the specified service network
Description
Updates the specified service network.
See https://www.paws-r-sdk.com/docs/vpclattice_update_service_network/ for full documentation.
Usage
vpclattice_update_service_network(authType, serviceNetworkIdentifier)
Arguments
authType |
[required] The type of IAM policy.
|
serviceNetworkIdentifier |
[required] The ID or ARN of the service network. |
Updates the service network and VPC association
Description
Updates the service network and VPC association. If you add a security group to the service network and VPC association, the association must continue to have at least one security group. You can add or edit security groups at any time. However, to remove all security groups, you must first delete the association and then recreate it without security groups.
See https://www.paws-r-sdk.com/docs/vpclattice_update_service_network_vpc_association/ for full documentation.
Usage
vpclattice_update_service_network_vpc_association(
securityGroupIds,
serviceNetworkVpcAssociationIdentifier
)
Arguments
securityGroupIds |
[required] The IDs of the security groups. |
serviceNetworkVpcAssociationIdentifier |
[required] The ID or ARN of the association. |
Updates the specified target group
Description
Updates the specified target group.
See https://www.paws-r-sdk.com/docs/vpclattice_update_target_group/ for full documentation.
Usage
vpclattice_update_target_group(healthCheck, targetGroupIdentifier)
Arguments
healthCheck |
[required] The health check configuration. |
targetGroupIdentifier |
[required] The ID or ARN of the target group. |