AWS SDK for C++  1.9.104
AWS SDK for C++
Public Member Functions | List of all members
Aws::ServiceDiscovery::Model::CreateServiceRequest Class Reference

#include <CreateServiceRequest.h>

+ Inheritance diagram for Aws::ServiceDiscovery::Model::CreateServiceRequest:

Public Member Functions

 CreateServiceRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
CreateServiceRequestWithName (const Aws::String &value)
 
CreateServiceRequestWithName (Aws::String &&value)
 
CreateServiceRequestWithName (const char *value)
 
const Aws::StringGetNamespaceId () const
 
bool NamespaceIdHasBeenSet () const
 
void SetNamespaceId (const Aws::String &value)
 
void SetNamespaceId (Aws::String &&value)
 
void SetNamespaceId (const char *value)
 
CreateServiceRequestWithNamespaceId (const Aws::String &value)
 
CreateServiceRequestWithNamespaceId (Aws::String &&value)
 
CreateServiceRequestWithNamespaceId (const char *value)
 
const Aws::StringGetCreatorRequestId () const
 
bool CreatorRequestIdHasBeenSet () const
 
void SetCreatorRequestId (const Aws::String &value)
 
void SetCreatorRequestId (Aws::String &&value)
 
void SetCreatorRequestId (const char *value)
 
CreateServiceRequestWithCreatorRequestId (const Aws::String &value)
 
CreateServiceRequestWithCreatorRequestId (Aws::String &&value)
 
CreateServiceRequestWithCreatorRequestId (const char *value)
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
CreateServiceRequestWithDescription (const Aws::String &value)
 
CreateServiceRequestWithDescription (Aws::String &&value)
 
CreateServiceRequestWithDescription (const char *value)
 
const DnsConfigGetDnsConfig () const
 
bool DnsConfigHasBeenSet () const
 
void SetDnsConfig (const DnsConfig &value)
 
void SetDnsConfig (DnsConfig &&value)
 
CreateServiceRequestWithDnsConfig (const DnsConfig &value)
 
CreateServiceRequestWithDnsConfig (DnsConfig &&value)
 
const HealthCheckConfigGetHealthCheckConfig () const
 
bool HealthCheckConfigHasBeenSet () const
 
void SetHealthCheckConfig (const HealthCheckConfig &value)
 
void SetHealthCheckConfig (HealthCheckConfig &&value)
 
CreateServiceRequestWithHealthCheckConfig (const HealthCheckConfig &value)
 
CreateServiceRequestWithHealthCheckConfig (HealthCheckConfig &&value)
 
const HealthCheckCustomConfigGetHealthCheckCustomConfig () const
 
bool HealthCheckCustomConfigHasBeenSet () const
 
void SetHealthCheckCustomConfig (const HealthCheckCustomConfig &value)
 
void SetHealthCheckCustomConfig (HealthCheckCustomConfig &&value)
 
CreateServiceRequestWithHealthCheckCustomConfig (const HealthCheckCustomConfig &value)
 
CreateServiceRequestWithHealthCheckCustomConfig (HealthCheckCustomConfig &&value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
CreateServiceRequestWithTags (const Aws::Vector< Tag > &value)
 
CreateServiceRequestWithTags (Aws::Vector< Tag > &&value)
 
CreateServiceRequestAddTags (const Tag &value)
 
CreateServiceRequestAddTags (Tag &&value)
 
const ServiceTypeOptionGetType () const
 
bool TypeHasBeenSet () const
 
void SetType (const ServiceTypeOption &value)
 
void SetType (ServiceTypeOption &&value)
 
CreateServiceRequestWithType (const ServiceTypeOption &value)
 
CreateServiceRequestWithType (ServiceTypeOption &&value)
 
- Public Member Functions inherited from Aws::ServiceDiscovery::ServiceDiscoveryRequest
virtual ~ServiceDiscoveryRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 28 of file CreateServiceRequest.h.

Constructor & Destructor Documentation

◆ CreateServiceRequest()

Aws::ServiceDiscovery::Model::CreateServiceRequest::CreateServiceRequest ( )

Member Function Documentation

◆ AddTags() [1/2]

CreateServiceRequest& Aws::ServiceDiscovery::Model::CreateServiceRequest::AddTags ( const Tag value)
inline

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.

Definition at line 584 of file CreateServiceRequest.h.

◆ AddTags() [2/2]

CreateServiceRequest& Aws::ServiceDiscovery::Model::CreateServiceRequest::AddTags ( Tag &&  value)
inline

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.

Definition at line 591 of file CreateServiceRequest.h.

◆ CreatorRequestIdHasBeenSet()

bool Aws::ServiceDiscovery::Model::CreateServiceRequest::CreatorRequestIdHasBeenSet ( ) const
inline

A unique string that identifies the request and that allows failed CreateService requests to be retried without the risk of running the operation twice. CreatorRequestId can be any unique string (for example, a date/timestamp).

Definition at line 268 of file CreateServiceRequest.h.

◆ DescriptionHasBeenSet()

bool Aws::ServiceDiscovery::Model::CreateServiceRequest::DescriptionHasBeenSet ( ) const
inline

A description for the service.

Definition at line 327 of file CreateServiceRequest.h.

◆ DnsConfigHasBeenSet()

bool Aws::ServiceDiscovery::Model::CreateServiceRequest::DnsConfigHasBeenSet ( ) const
inline

A complex type that contains information about the Amazon Route 53 records that you want Cloud Map to create when you register an instance.

Definition at line 370 of file CreateServiceRequest.h.

◆ GetCreatorRequestId()

const Aws::String& Aws::ServiceDiscovery::Model::CreateServiceRequest::GetCreatorRequestId ( ) const
inline

A unique string that identifies the request and that allows failed CreateService requests to be retried without the risk of running the operation twice. CreatorRequestId can be any unique string (for example, a date/timestamp).

Definition at line 260 of file CreateServiceRequest.h.

◆ GetDescription()

const Aws::String& Aws::ServiceDiscovery::Model::CreateServiceRequest::GetDescription ( ) const
inline

A description for the service.

Definition at line 322 of file CreateServiceRequest.h.

◆ GetDnsConfig()

const DnsConfig& Aws::ServiceDiscovery::Model::CreateServiceRequest::GetDnsConfig ( ) const
inline

A complex type that contains information about the Amazon Route 53 records that you want Cloud Map to create when you register an instance.

Definition at line 364 of file CreateServiceRequest.h.

◆ GetHealthCheckConfig()

const HealthCheckConfig& Aws::ServiceDiscovery::Model::CreateServiceRequest::GetHealthCheckConfig ( ) const
inline

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 DnsConfig.

If you specify a health check configuration, you can specify either HealthCheckCustomConfig or HealthCheckConfig but not both.

For information about the charges for health checks, see Cloud Map Pricing.

Definition at line 408 of file CreateServiceRequest.h.

◆ GetHealthCheckCustomConfig()

const HealthCheckCustomConfig& Aws::ServiceDiscovery::Model::CreateServiceRequest::GetHealthCheckCustomConfig ( ) const
inline

A complex type that contains information about an optional custom health check.

If you specify a health check configuration, you can specify either HealthCheckCustomConfig or HealthCheckConfig but not both.

You can't add, update, or delete a HealthCheckCustomConfig configuration from an existing service.

Definition at line 484 of file CreateServiceRequest.h.

◆ GetName()

const Aws::String& Aws::ServiceDiscovery::Model::CreateServiceRequest::GetName ( ) const
inline

The name that you want to assign to the service.

If you want Cloud Map to create an SRV record when you register an instance and you're using a system that requires a specific SRV format, such as HAProxy, specify the following for Name:

  • Start the name with an underscore (_), such as _exampleservice.

  • End the name with ._protocol, such as ._tcp.

When you register an instance, Cloud Map creates an SRV record and assigns a name to the record by concatenating the service name and the namespace name (for example,

_exampleservice._tcp.example.com).

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.

Definition at line 61 of file CreateServiceRequest.h.

◆ GetNamespaceId()

const Aws::String& Aws::ServiceDiscovery::Model::CreateServiceRequest::GetNamespaceId ( ) const
inline

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 DnsConfig object.

Definition at line 202 of file CreateServiceRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::ServiceDiscovery::Model::CreateServiceRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetServiceRequestName()

virtual const char* Aws::ServiceDiscovery::Model::CreateServiceRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 37 of file CreateServiceRequest.h.

◆ GetTags()

const Aws::Vector<Tag>& Aws::ServiceDiscovery::Model::CreateServiceRequest::GetTags ( ) const
inline

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.

Definition at line 542 of file CreateServiceRequest.h.

◆ GetType()

const ServiceTypeOption& Aws::ServiceDiscovery::Model::CreateServiceRequest::GetType ( ) const
inline

If present, specifies that the service instances are only discoverable using the DiscoverInstances API operation. No DNS records is registered for the service instances. The only valid value is HTTP.

Definition at line 599 of file CreateServiceRequest.h.

◆ HealthCheckConfigHasBeenSet()

bool Aws::ServiceDiscovery::Model::CreateServiceRequest::HealthCheckConfigHasBeenSet ( ) const
inline

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 DnsConfig.

If you specify a health check configuration, you can specify either HealthCheckCustomConfig or HealthCheckConfig but not both.

For information about the charges for health checks, see Cloud Map Pricing.

Definition at line 421 of file CreateServiceRequest.h.

◆ HealthCheckCustomConfigHasBeenSet()

bool Aws::ServiceDiscovery::Model::CreateServiceRequest::HealthCheckCustomConfigHasBeenSet ( ) const
inline

A complex type that contains information about an optional custom health check.

If you specify a health check configuration, you can specify either HealthCheckCustomConfig or HealthCheckConfig but not both.

You can't add, update, or delete a HealthCheckCustomConfig configuration from an existing service.

Definition at line 494 of file CreateServiceRequest.h.

◆ NameHasBeenSet()

bool Aws::ServiceDiscovery::Model::CreateServiceRequest::NameHasBeenSet ( ) const
inline

The name that you want to assign to the service.

If you want Cloud Map to create an SRV record when you register an instance and you're using a system that requires a specific SRV format, such as HAProxy, specify the following for Name:

  • Start the name with an underscore (_), such as _exampleservice.

  • End the name with ._protocol, such as ._tcp.

When you register an instance, Cloud Map creates an SRV record and assigns a name to the record by concatenating the service name and the namespace name (for example,

_exampleservice._tcp.example.com).

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.

Definition at line 80 of file CreateServiceRequest.h.

◆ NamespaceIdHasBeenSet()

bool Aws::ServiceDiscovery::Model::CreateServiceRequest::NamespaceIdHasBeenSet ( ) const
inline

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 DnsConfig object.

Definition at line 209 of file CreateServiceRequest.h.

◆ SerializePayload()

Aws::String Aws::ServiceDiscovery::Model::CreateServiceRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetCreatorRequestId() [1/3]

void Aws::ServiceDiscovery::Model::CreateServiceRequest::SetCreatorRequestId ( Aws::String &&  value)
inline

A unique string that identifies the request and that allows failed CreateService requests to be retried without the risk of running the operation twice. CreatorRequestId can be any unique string (for example, a date/timestamp).

Definition at line 284 of file CreateServiceRequest.h.

◆ SetCreatorRequestId() [2/3]

void Aws::ServiceDiscovery::Model::CreateServiceRequest::SetCreatorRequestId ( const Aws::String value)
inline

A unique string that identifies the request and that allows failed CreateService requests to be retried without the risk of running the operation twice. CreatorRequestId can be any unique string (for example, a date/timestamp).

Definition at line 276 of file CreateServiceRequest.h.

◆ SetCreatorRequestId() [3/3]

void Aws::ServiceDiscovery::Model::CreateServiceRequest::SetCreatorRequestId ( const char *  value)
inline

A unique string that identifies the request and that allows failed CreateService requests to be retried without the risk of running the operation twice. CreatorRequestId can be any unique string (for example, a date/timestamp).

Definition at line 292 of file CreateServiceRequest.h.

◆ SetDescription() [1/3]

void Aws::ServiceDiscovery::Model::CreateServiceRequest::SetDescription ( Aws::String &&  value)
inline

A description for the service.

Definition at line 337 of file CreateServiceRequest.h.

◆ SetDescription() [2/3]

void Aws::ServiceDiscovery::Model::CreateServiceRequest::SetDescription ( const Aws::String value)
inline

A description for the service.

Definition at line 332 of file CreateServiceRequest.h.

◆ SetDescription() [3/3]

void Aws::ServiceDiscovery::Model::CreateServiceRequest::SetDescription ( const char *  value)
inline

A description for the service.

Definition at line 342 of file CreateServiceRequest.h.

◆ SetDnsConfig() [1/2]

void Aws::ServiceDiscovery::Model::CreateServiceRequest::SetDnsConfig ( const DnsConfig value)
inline

A complex type that contains information about the Amazon Route 53 records that you want Cloud Map to create when you register an instance.

Definition at line 376 of file CreateServiceRequest.h.

◆ SetDnsConfig() [2/2]

void Aws::ServiceDiscovery::Model::CreateServiceRequest::SetDnsConfig ( DnsConfig &&  value)
inline

A complex type that contains information about the Amazon Route 53 records that you want Cloud Map to create when you register an instance.

Definition at line 382 of file CreateServiceRequest.h.

◆ SetHealthCheckConfig() [1/2]

void Aws::ServiceDiscovery::Model::CreateServiceRequest::SetHealthCheckConfig ( const HealthCheckConfig value)
inline

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 DnsConfig.

If you specify a health check configuration, you can specify either HealthCheckCustomConfig or HealthCheckConfig but not both.

For information about the charges for health checks, see Cloud Map Pricing.

Definition at line 434 of file CreateServiceRequest.h.

◆ SetHealthCheckConfig() [2/2]

void Aws::ServiceDiscovery::Model::CreateServiceRequest::SetHealthCheckConfig ( HealthCheckConfig &&  value)
inline

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 DnsConfig.

If you specify a health check configuration, you can specify either HealthCheckCustomConfig or HealthCheckConfig but not both.

For information about the charges for health checks, see Cloud Map Pricing.

Definition at line 447 of file CreateServiceRequest.h.

◆ SetHealthCheckCustomConfig() [1/2]

void Aws::ServiceDiscovery::Model::CreateServiceRequest::SetHealthCheckCustomConfig ( const HealthCheckCustomConfig value)
inline

A complex type that contains information about an optional custom health check.

If you specify a health check configuration, you can specify either HealthCheckCustomConfig or HealthCheckConfig but not both.

You can't add, update, or delete a HealthCheckCustomConfig configuration from an existing service.

Definition at line 504 of file CreateServiceRequest.h.

◆ SetHealthCheckCustomConfig() [2/2]

void Aws::ServiceDiscovery::Model::CreateServiceRequest::SetHealthCheckCustomConfig ( HealthCheckCustomConfig &&  value)
inline

A complex type that contains information about an optional custom health check.

If you specify a health check configuration, you can specify either HealthCheckCustomConfig or HealthCheckConfig but not both.

You can't add, update, or delete a HealthCheckCustomConfig configuration from an existing service.

Definition at line 514 of file CreateServiceRequest.h.

◆ SetName() [1/3]

void Aws::ServiceDiscovery::Model::CreateServiceRequest::SetName ( Aws::String &&  value)
inline

The name that you want to assign to the service.

If you want Cloud Map to create an SRV record when you register an instance and you're using a system that requires a specific SRV format, such as HAProxy, specify the following for Name:

  • Start the name with an underscore (_), such as _exampleservice.

  • End the name with ._protocol, such as ._tcp.

When you register an instance, Cloud Map creates an SRV record and assigns a name to the record by concatenating the service name and the namespace name (for example,

_exampleservice._tcp.example.com).

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.

Definition at line 118 of file CreateServiceRequest.h.

◆ SetName() [2/3]

void Aws::ServiceDiscovery::Model::CreateServiceRequest::SetName ( const Aws::String value)
inline

The name that you want to assign to the service.

If you want Cloud Map to create an SRV record when you register an instance and you're using a system that requires a specific SRV format, such as HAProxy, specify the following for Name:

  • Start the name with an underscore (_), such as _exampleservice.

  • End the name with ._protocol, such as ._tcp.

When you register an instance, Cloud Map creates an SRV record and assigns a name to the record by concatenating the service name and the namespace name (for example,

_exampleservice._tcp.example.com).

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.

Definition at line 99 of file CreateServiceRequest.h.

◆ SetName() [3/3]

void Aws::ServiceDiscovery::Model::CreateServiceRequest::SetName ( const char *  value)
inline

The name that you want to assign to the service.

If you want Cloud Map to create an SRV record when you register an instance and you're using a system that requires a specific SRV format, such as HAProxy, specify the following for Name:

  • Start the name with an underscore (_), such as _exampleservice.

  • End the name with ._protocol, such as ._tcp.

When you register an instance, Cloud Map creates an SRV record and assigns a name to the record by concatenating the service name and the namespace name (for example,

_exampleservice._tcp.example.com).

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.

Definition at line 137 of file CreateServiceRequest.h.

◆ SetNamespaceId() [1/3]

void Aws::ServiceDiscovery::Model::CreateServiceRequest::SetNamespaceId ( Aws::String &&  value)
inline

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 DnsConfig object.

Definition at line 223 of file CreateServiceRequest.h.

◆ SetNamespaceId() [2/3]

void Aws::ServiceDiscovery::Model::CreateServiceRequest::SetNamespaceId ( const Aws::String value)
inline

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 DnsConfig object.

Definition at line 216 of file CreateServiceRequest.h.

◆ SetNamespaceId() [3/3]

void Aws::ServiceDiscovery::Model::CreateServiceRequest::SetNamespaceId ( const char *  value)
inline

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 DnsConfig object.

Definition at line 230 of file CreateServiceRequest.h.

◆ SetTags() [1/2]

void Aws::ServiceDiscovery::Model::CreateServiceRequest::SetTags ( Aws::Vector< Tag > &&  value)
inline

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.

Definition at line 563 of file CreateServiceRequest.h.

◆ SetTags() [2/2]

void Aws::ServiceDiscovery::Model::CreateServiceRequest::SetTags ( const Aws::Vector< Tag > &  value)
inline

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.

Definition at line 556 of file CreateServiceRequest.h.

◆ SetType() [1/2]

void Aws::ServiceDiscovery::Model::CreateServiceRequest::SetType ( const ServiceTypeOption value)
inline

If present, specifies that the service instances are only discoverable using the DiscoverInstances API operation. No DNS records is registered for the service instances. The only valid value is HTTP.

Definition at line 613 of file CreateServiceRequest.h.

◆ SetType() [2/2]

void Aws::ServiceDiscovery::Model::CreateServiceRequest::SetType ( ServiceTypeOption &&  value)
inline

If present, specifies that the service instances are only discoverable using the DiscoverInstances API operation. No DNS records is registered for the service instances. The only valid value is HTTP.

Definition at line 620 of file CreateServiceRequest.h.

◆ TagsHasBeenSet()

bool Aws::ServiceDiscovery::Model::CreateServiceRequest::TagsHasBeenSet ( ) const
inline

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.

Definition at line 549 of file CreateServiceRequest.h.

◆ TypeHasBeenSet()

bool Aws::ServiceDiscovery::Model::CreateServiceRequest::TypeHasBeenSet ( ) const
inline

If present, specifies that the service instances are only discoverable using the DiscoverInstances API operation. No DNS records is registered for the service instances. The only valid value is HTTP.

Definition at line 606 of file CreateServiceRequest.h.

◆ WithCreatorRequestId() [1/3]

CreateServiceRequest& Aws::ServiceDiscovery::Model::CreateServiceRequest::WithCreatorRequestId ( Aws::String &&  value)
inline

A unique string that identifies the request and that allows failed CreateService requests to be retried without the risk of running the operation twice. CreatorRequestId can be any unique string (for example, a date/timestamp).

Definition at line 308 of file CreateServiceRequest.h.

◆ WithCreatorRequestId() [2/3]

CreateServiceRequest& Aws::ServiceDiscovery::Model::CreateServiceRequest::WithCreatorRequestId ( const Aws::String value)
inline

A unique string that identifies the request and that allows failed CreateService requests to be retried without the risk of running the operation twice. CreatorRequestId can be any unique string (for example, a date/timestamp).

Definition at line 300 of file CreateServiceRequest.h.

◆ WithCreatorRequestId() [3/3]

CreateServiceRequest& Aws::ServiceDiscovery::Model::CreateServiceRequest::WithCreatorRequestId ( const char *  value)
inline

A unique string that identifies the request and that allows failed CreateService requests to be retried without the risk of running the operation twice. CreatorRequestId can be any unique string (for example, a date/timestamp).

Definition at line 316 of file CreateServiceRequest.h.

◆ WithDescription() [1/3]

CreateServiceRequest& Aws::ServiceDiscovery::Model::CreateServiceRequest::WithDescription ( Aws::String &&  value)
inline

A description for the service.

Definition at line 352 of file CreateServiceRequest.h.

◆ WithDescription() [2/3]

CreateServiceRequest& Aws::ServiceDiscovery::Model::CreateServiceRequest::WithDescription ( const Aws::String value)
inline

A description for the service.

Definition at line 347 of file CreateServiceRequest.h.

◆ WithDescription() [3/3]

CreateServiceRequest& Aws::ServiceDiscovery::Model::CreateServiceRequest::WithDescription ( const char *  value)
inline

A description for the service.

Definition at line 357 of file CreateServiceRequest.h.

◆ WithDnsConfig() [1/2]

CreateServiceRequest& Aws::ServiceDiscovery::Model::CreateServiceRequest::WithDnsConfig ( const DnsConfig value)
inline

A complex type that contains information about the Amazon Route 53 records that you want Cloud Map to create when you register an instance.

Definition at line 388 of file CreateServiceRequest.h.

◆ WithDnsConfig() [2/2]

CreateServiceRequest& Aws::ServiceDiscovery::Model::CreateServiceRequest::WithDnsConfig ( DnsConfig &&  value)
inline

A complex type that contains information about the Amazon Route 53 records that you want Cloud Map to create when you register an instance.

Definition at line 394 of file CreateServiceRequest.h.

◆ WithHealthCheckConfig() [1/2]

CreateServiceRequest& Aws::ServiceDiscovery::Model::CreateServiceRequest::WithHealthCheckConfig ( const HealthCheckConfig value)
inline

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 DnsConfig.

If you specify a health check configuration, you can specify either HealthCheckCustomConfig or HealthCheckConfig but not both.

For information about the charges for health checks, see Cloud Map Pricing.

Definition at line 460 of file CreateServiceRequest.h.

◆ WithHealthCheckConfig() [2/2]

CreateServiceRequest& Aws::ServiceDiscovery::Model::CreateServiceRequest::WithHealthCheckConfig ( HealthCheckConfig &&  value)
inline

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 DnsConfig.

If you specify a health check configuration, you can specify either HealthCheckCustomConfig or HealthCheckConfig but not both.

For information about the charges for health checks, see Cloud Map Pricing.

Definition at line 473 of file CreateServiceRequest.h.

◆ WithHealthCheckCustomConfig() [1/2]

CreateServiceRequest& Aws::ServiceDiscovery::Model::CreateServiceRequest::WithHealthCheckCustomConfig ( const HealthCheckCustomConfig value)
inline

A complex type that contains information about an optional custom health check.

If you specify a health check configuration, you can specify either HealthCheckCustomConfig or HealthCheckConfig but not both.

You can't add, update, or delete a HealthCheckCustomConfig configuration from an existing service.

Definition at line 524 of file CreateServiceRequest.h.

◆ WithHealthCheckCustomConfig() [2/2]

CreateServiceRequest& Aws::ServiceDiscovery::Model::CreateServiceRequest::WithHealthCheckCustomConfig ( HealthCheckCustomConfig &&  value)
inline

A complex type that contains information about an optional custom health check.

If you specify a health check configuration, you can specify either HealthCheckCustomConfig or HealthCheckConfig but not both.

You can't add, update, or delete a HealthCheckCustomConfig configuration from an existing service.

Definition at line 534 of file CreateServiceRequest.h.

◆ WithName() [1/3]

CreateServiceRequest& Aws::ServiceDiscovery::Model::CreateServiceRequest::WithName ( Aws::String &&  value)
inline

The name that you want to assign to the service.

If you want Cloud Map to create an SRV record when you register an instance and you're using a system that requires a specific SRV format, such as HAProxy, specify the following for Name:

  • Start the name with an underscore (_), such as _exampleservice.

  • End the name with ._protocol, such as ._tcp.

When you register an instance, Cloud Map creates an SRV record and assigns a name to the record by concatenating the service name and the namespace name (for example,

_exampleservice._tcp.example.com).

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.

Definition at line 175 of file CreateServiceRequest.h.

◆ WithName() [2/3]

CreateServiceRequest& Aws::ServiceDiscovery::Model::CreateServiceRequest::WithName ( const Aws::String value)
inline

The name that you want to assign to the service.

If you want Cloud Map to create an SRV record when you register an instance and you're using a system that requires a specific SRV format, such as HAProxy, specify the following for Name:

  • Start the name with an underscore (_), such as _exampleservice.

  • End the name with ._protocol, such as ._tcp.

When you register an instance, Cloud Map creates an SRV record and assigns a name to the record by concatenating the service name and the namespace name (for example,

_exampleservice._tcp.example.com).

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.

Definition at line 156 of file CreateServiceRequest.h.

◆ WithName() [3/3]

CreateServiceRequest& Aws::ServiceDiscovery::Model::CreateServiceRequest::WithName ( const char *  value)
inline

The name that you want to assign to the service.

If you want Cloud Map to create an SRV record when you register an instance and you're using a system that requires a specific SRV format, such as HAProxy, specify the following for Name:

  • Start the name with an underscore (_), such as _exampleservice.

  • End the name with ._protocol, such as ._tcp.

When you register an instance, Cloud Map creates an SRV record and assigns a name to the record by concatenating the service name and the namespace name (for example,

_exampleservice._tcp.example.com).

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.

Definition at line 194 of file CreateServiceRequest.h.

◆ WithNamespaceId() [1/3]

CreateServiceRequest& Aws::ServiceDiscovery::Model::CreateServiceRequest::WithNamespaceId ( Aws::String &&  value)
inline

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 DnsConfig object.

Definition at line 244 of file CreateServiceRequest.h.

◆ WithNamespaceId() [2/3]

CreateServiceRequest& Aws::ServiceDiscovery::Model::CreateServiceRequest::WithNamespaceId ( const Aws::String value)
inline

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 DnsConfig object.

Definition at line 237 of file CreateServiceRequest.h.

◆ WithNamespaceId() [3/3]

CreateServiceRequest& Aws::ServiceDiscovery::Model::CreateServiceRequest::WithNamespaceId ( const char *  value)
inline

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 DnsConfig object.

Definition at line 251 of file CreateServiceRequest.h.

◆ WithTags() [1/2]

CreateServiceRequest& Aws::ServiceDiscovery::Model::CreateServiceRequest::WithTags ( Aws::Vector< Tag > &&  value)
inline

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.

Definition at line 577 of file CreateServiceRequest.h.

◆ WithTags() [2/2]

CreateServiceRequest& Aws::ServiceDiscovery::Model::CreateServiceRequest::WithTags ( const Aws::Vector< Tag > &  value)
inline

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.

Definition at line 570 of file CreateServiceRequest.h.

◆ WithType() [1/2]

CreateServiceRequest& Aws::ServiceDiscovery::Model::CreateServiceRequest::WithType ( const ServiceTypeOption value)
inline

If present, specifies that the service instances are only discoverable using the DiscoverInstances API operation. No DNS records is registered for the service instances. The only valid value is HTTP.

Definition at line 627 of file CreateServiceRequest.h.

◆ WithType() [2/2]

CreateServiceRequest& Aws::ServiceDiscovery::Model::CreateServiceRequest::WithType ( ServiceTypeOption &&  value)
inline

If present, specifies that the service instances are only discoverable using the DiscoverInstances API operation. No DNS records is registered for the service instances. The only valid value is HTTP.

Definition at line 634 of file CreateServiceRequest.h.


The documentation for this class was generated from the following file: