Create Load Balancer
lightsail_create_load_balancer | R Documentation |
Creates a Lightsail load balancer¶
Description¶
Creates a Lightsail load balancer. To learn more about deciding whether to load balance your application, see Configure your Lightsail instances for load balancing. You can create up to 5 load balancers per AWS Region in your account.
When you create a load balancer, you can specify a unique name and port
settings. To change additional load balancer settings, use the
update_load_balancer_attribute
operation.
The create load balancer
operation supports tag-based access control
via request tags. For more information, see the Amazon Lightsail
Developer
Guide.
Usage¶
lightsail_create_load_balancer(loadBalancerName, instancePort,
healthCheckPath, certificateName, certificateDomainName,
certificateAlternativeNames, tags, ipAddressType, tlsPolicyName)
Arguments¶
loadBalancerName
[required] The name of your load balancer.
instancePort
[required] The instance port where you're creating your load balancer.
healthCheckPath
The path you provided to perform the load balancer health check. If you didn't specify a health check path, Lightsail uses the root path of your website (
"/"
).You may want to specify a custom health check path other than the root of your application if your home page loads slowly or has a lot of media or scripting on it.
certificateName
The name of the SSL/TLS certificate.
If you specify
certificateName
, thencertificateDomainName
is required (and vice-versa).certificateDomainName
The domain name with which your certificate is associated (
example.com
).If you specify
certificateDomainName
, thencertificateName
is required (and vice-versa).certificateAlternativeNames
The optional alternative domains and subdomains to use with your SSL/TLS certificate (
www.example.com
,example.com
,m.example.com
,blog.example.com
).tags
The tag keys and optional values to add to the resource during create.
Use the
tag_resource
action to tag a resource after it's created.ipAddressType
The IP address type for the load balancer.
The possible values are
ipv4
for IPv4 only,ipv6
for IPv6 only, anddualstack
for IPv4 and IPv6.The default value is
dualstack
.tlsPolicyName
The name of the TLS policy to apply to the load balancer.
Use the
get_load_balancer_tls_policies
action to get a list of TLS policy names that you can specify.For more information about load balancer TLS policies, see Configuring TLS security policies on your Amazon Lightsail load balancers in the Amazon Lightsail Developer Guide.
Value¶
A list with the following syntax:
list(
operations = list(
list(
id = "string",
resourceName = "string",
resourceType = "ContainerService"|"Instance"|"StaticIp"|"KeyPair"|"InstanceSnapshot"|"Domain"|"PeeredVpc"|"LoadBalancer"|"LoadBalancerTlsCertificate"|"Disk"|"DiskSnapshot"|"RelationalDatabase"|"RelationalDatabaseSnapshot"|"ExportSnapshotRecord"|"CloudFormationStackRecord"|"Alarm"|"ContactMethod"|"Distribution"|"Certificate"|"Bucket",
createdAt = as.POSIXct(
"2015-01-01"
),
location = list(
availabilityZone = "string",
regionName = "us-east-1"|"us-east-2"|"us-west-1"|"us-west-2"|"eu-west-1"|"eu-west-2"|"eu-west-3"|"eu-central-1"|"ca-central-1"|"ap-south-1"|"ap-southeast-1"|"ap-southeast-2"|"ap-northeast-1"|"ap-northeast-2"|"eu-north-1"
),
isTerminal = TRUE|FALSE,
operationDetails = "string",
operationType = "DeleteKnownHostKeys"|"DeleteInstance"|"CreateInstance"|"StopInstance"|"StartInstance"|"RebootInstance"|"OpenInstancePublicPorts"|"PutInstancePublicPorts"|"CloseInstancePublicPorts"|"AllocateStaticIp"|"ReleaseStaticIp"|"AttachStaticIp"|"DetachStaticIp"|"UpdateDomainEntry"|"DeleteDomainEntry"|"CreateDomain"|"DeleteDomain"|"CreateInstanceSnapshot"|"DeleteInstanceSnapshot"|"CreateInstancesFromSnapshot"|"CreateLoadBalancer"|"DeleteLoadBalancer"|"AttachInstancesToLoadBalancer"|"DetachInstancesFromLoadBalancer"|"UpdateLoadBalancerAttribute"|"CreateLoadBalancerTlsCertificate"|"DeleteLoadBalancerTlsCertificate"|"AttachLoadBalancerTlsCertificate"|"CreateDisk"|"DeleteDisk"|"AttachDisk"|"DetachDisk"|"CreateDiskSnapshot"|"DeleteDiskSnapshot"|"CreateDiskFromSnapshot"|"CreateRelationalDatabase"|"UpdateRelationalDatabase"|"DeleteRelationalDatabase"|"CreateRelationalDatabaseFromSnapshot"|"CreateRelationalDatabaseSnapshot"|"DeleteRelationalDatabaseSnapshot"|"UpdateRelationalDatabaseParameters"|"StartRelationalDatabase"|"RebootRelationalDatabase"|"StopRelationalDatabase"|"EnableAddOn"|"DisableAddOn"|"PutAlarm"|"GetAlarms"|"DeleteAlarm"|"TestAlarm"|"CreateContactMethod"|"GetContactMethods"|"SendContactMethodVerification"|"DeleteContactMethod"|"CreateDistribution"|"UpdateDistribution"|"DeleteDistribution"|"ResetDistributionCache"|"AttachCertificateToDistribution"|"DetachCertificateFromDistribution"|"UpdateDistributionBundle"|"SetIpAddressType"|"CreateCertificate"|"DeleteCertificate"|"CreateContainerService"|"UpdateContainerService"|"DeleteContainerService"|"CreateContainerServiceDeployment"|"CreateContainerServiceRegistryLogin"|"RegisterContainerImage"|"DeleteContainerImage"|"CreateBucket"|"DeleteBucket"|"CreateBucketAccessKey"|"DeleteBucketAccessKey"|"UpdateBucketBundle"|"UpdateBucket"|"SetResourceAccessForBucket"|"UpdateInstanceMetadataOptions"|"StartGUISession"|"StopGUISession"|"SetupInstanceHttps",
status = "NotStarted"|"Started"|"Failed"|"Completed"|"Succeeded",
statusChangedAt = as.POSIXct(
"2015-01-01"
),
errorCode = "string",
errorDetails = "string"
)
)
)
Request syntax¶
svc$create_load_balancer(
loadBalancerName = "string",
instancePort = 123,
healthCheckPath = "string",
certificateName = "string",
certificateDomainName = "string",
certificateAlternativeNames = list(
"string"
),
tags = list(
list(
key = "string",
value = "string"
)
),
ipAddressType = "dualstack"|"ipv4"|"ipv6",
tlsPolicyName = "string"
)