Class CreateServiceRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateServiceRequest.Builder,
CreateServiceRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic CreateServiceRequest.Builder
builder()
final String
A unique string that identifies the request and that allows failedCreateService
requests to be retried without the risk of running the operation twice.final String
A description for the service.final 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.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final HealthCheckConfig
Public DNS and HTTP namespaces only. A complex type that contains settings for an optional Route 53 health check.final HealthCheckCustomConfig
A complex type that contains information about an optional custom health check.final String
name()
The name that you want to assign to the service.final String
The ID of the namespace that you want to use to create the service.static Class
<? extends CreateServiceRequest.Builder> tags()
The tags to add to the service.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final ServiceTypeOption
type()
If present, specifies that the service instances are only discoverable using theDiscoverInstances
API operation.final String
If present, specifies that the service instances are only discoverable using theDiscoverInstances
API operation.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 specificSRV
format, such as HAProxy, specify the following forName
:-
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 specificSRV
format, such as HAProxy, specify the following forName
:-
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.
-
-
-
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:
- 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.
-
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:
- 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).
-
description
A description for the service.
- Returns:
- 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.
- 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.
-
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
orHealthCheckConfig
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
orHealthCheckConfig
but not both.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
HealthCheckCustomConfig
orHealthCheckConfig
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
orHealthCheckConfig
but not both.You can't add, update, or delete a
HealthCheckCustomConfig
configuration from an existing service.
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTags()
method.- 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.
-
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 isHTTP
.If the service returns an enum value that is not available in the current SDK version,
type
will returnServiceTypeOption.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- 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 isHTTP
. - See Also:
-
typeAsString
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 isHTTP
.If the service returns an enum value that is not available in the current SDK version,
type
will returnServiceTypeOption.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- 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 isHTTP
. - See Also:
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateServiceRequest.Builder,
CreateServiceRequest> - Specified by:
toBuilder
in classServiceDiscoveryRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-