com.amazonaws.services.servicediscovery.model

Class CreateServiceRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.servicediscovery.model.CreateServiceRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateServiceRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateServiceRequest()

Method Summary

Modifier and Type	Method and Description
CreateServiceRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getCreatorRequestId() A unique string that identifies the request and that allows failed CreateService requests to be retried without the risk of running the operation twice.
String	getDescription() A description for the service.
DnsConfig	getDnsConfig() 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	getHealthCheckConfig() Public DNS and HTTP namespaces only. A complex type that contains settings for an optional Route 53 health check.
HealthCheckCustomConfig	getHealthCheckCustomConfig() A complex type that contains information about an optional custom health check.
String	getName() The name that you want to assign to the service.
String	getNamespaceId() The ID of the namespace that you want to use to create the service.
List<Tag>	getTags() The tags to add to the service.
String	getType() If present, specifies that the service instances are only discoverable using the DiscoverInstances API operation.
int	hashCode()
void	setCreatorRequestId(String creatorRequestId) A unique string that identifies the request and that allows failed CreateService requests to be retried without the risk of running the operation twice.
void	setDescription(String description) A description for the service.
void	setDnsConfig(DnsConfig 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.
void	setHealthCheckConfig(HealthCheckConfig healthCheckConfig) Public DNS and HTTP namespaces only. A complex type that contains settings for an optional Route 53 health check.
void	setHealthCheckCustomConfig(HealthCheckCustomConfig healthCheckCustomConfig) A complex type that contains information about an optional custom health check.
void	setName(String name) The name that you want to assign to the service.
void	setNamespaceId(String namespaceId) The ID of the namespace that you want to use to create the service.
void	setTags(Collection<Tag> tags) The tags to add to the service.
void	setType(String type) If present, specifies that the service instances are only discoverable using the DiscoverInstances API operation.
String	toString() Returns a string representation of this object.
CreateServiceRequest	withCreatorRequestId(String creatorRequestId) A unique string that identifies the request and that allows failed CreateService requests to be retried without the risk of running the operation twice.
CreateServiceRequest	withDescription(String description) A description for the service.
CreateServiceRequest	withDnsConfig(DnsConfig 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.
CreateServiceRequest	withHealthCheckConfig(HealthCheckConfig healthCheckConfig) Public DNS and HTTP namespaces only. A complex type that contains settings for an optional Route 53 health check.
CreateServiceRequest	withHealthCheckCustomConfig(HealthCheckCustomConfig healthCheckCustomConfig) A complex type that contains information about an optional custom health check.
CreateServiceRequest	withName(String name) The name that you want to assign to the service.
CreateServiceRequest	withNamespaceId(String namespaceId) The ID of the namespace that you want to use to create the service.
CreateServiceRequest	withTags(Collection<Tag> tags) The tags to add to the service.
CreateServiceRequest	withTags(Tag... tags) The tags to add to the service.
CreateServiceRequest	withType(ServiceTypeOption type) If present, specifies that the service instances are only discoverable using the DiscoverInstances API operation.
CreateServiceRequest	withType(String type) If present, specifies that the service instances are only discoverable using the DiscoverInstances API operation.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateServiceRequest

public CreateServiceRequest()

Method Detail

setName

public void setName(String name)

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

Parameters:

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

getName

public String getName()

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

Returns:

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

withName

public CreateServiceRequest withName(String name)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setNamespaceId

public void setNamespaceId(String 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 DnsConfig object.

Parameters:

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

getNamespaceId

public String getNamespaceId()

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.

Returns:

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.

withNamespaceId

public CreateServiceRequest withNamespaceId(String 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 DnsConfig object.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setCreatorRequestId

public void setCreatorRequestId(String creatorRequestId)

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

Parameters:

creatorRequestId - 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).

getCreatorRequestId

public String getCreatorRequestId()

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

Returns:

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

withCreatorRequestId

public CreateServiceRequest withCreatorRequestId(String creatorRequestId)

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

Parameters:

creatorRequestId - 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).

Returns:

Returns a reference to this object so that method calls can be chained together.

setDescription

public void setDescription(String description)

A description for the service.

Parameters:

description - A description for the service.

getDescription

public String getDescription()

A description for the service.

Returns:

A description for the service.

withDescription

public CreateServiceRequest withDescription(String description)

A description for the service.

Parameters:

description - A description for the service.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDnsConfig

public void setDnsConfig(DnsConfig 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.

Parameters:

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.

getDnsConfig

public DnsConfig getDnsConfig()

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

Returns:

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

withDnsConfig

public CreateServiceRequest withDnsConfig(DnsConfig 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setHealthCheckConfig

public void setHealthCheckConfig(HealthCheckConfig 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 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.

Parameters:

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

getHealthCheckConfig

public HealthCheckConfig getHealthCheckConfig()

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.

Returns:

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.

withHealthCheckConfig

public CreateServiceRequest withHealthCheckConfig(HealthCheckConfig 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 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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setHealthCheckCustomConfig

public void setHealthCheckCustomConfig(HealthCheckCustomConfig healthCheckCustomConfig)

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.

Parameters:

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

getHealthCheckCustomConfig

public HealthCheckCustomConfig getHealthCheckCustomConfig()

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.

Returns:

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.

withHealthCheckCustomConfig

public CreateServiceRequest withHealthCheckCustomConfig(HealthCheckCustomConfig healthCheckCustomConfig)

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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

getTags

public List<Tag> getTags()

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.

Returns:

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.

setTags

public void setTags(Collection<Tag> 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.

Parameters:

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.

withTags

public CreateServiceRequest withTags(Tag... 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.

NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

withTags

public CreateServiceRequest withTags(Collection<Tag> 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setType

public void setType(String type)

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.

Parameters:

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

See Also:

ServiceTypeOption

getType

public String getType()

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.

Returns:

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.

See Also:

ServiceTypeOption

withType

public CreateServiceRequest withType(String type)

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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ServiceTypeOption

withType

public CreateServiceRequest withType(ServiceTypeOption type)

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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ServiceTypeOption

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateServiceRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()