Interface Api.Builder
-
- All Superinterfaces:
Buildable,CopyableBuilder<Api.Builder,Api>,SdkBuilder<Api.Builder,Api>,SdkPojo
- Enclosing class:
- Api
public static interface Api.Builder extends SdkPojo, CopyableBuilder<Api.Builder,Api>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description Api.BuilderapiArn(String apiArn)The Amazon Resource Name (ARN) for theApi.Api.BuilderapiId(String apiId)TheApiID.Api.Buildercreated(Instant created)The date and time that theApiwas created.Api.Builderdns(Map<String,String> dns)The DNS records for the API.default Api.BuildereventConfig(Consumer<EventConfig.Builder> eventConfig)The Event API configuration.Api.BuildereventConfig(EventConfig eventConfig)The Event API configuration.Api.Buildername(String name)The name of theApi.Api.BuilderownerContact(String ownerContact)The owner contact information for theApiApi.Buildertags(Map<String,String> tags)Sets the value of the Tags property for this object.Api.BuilderwafWebAclArn(String wafWebAclArn)The Amazon Resource Name (ARN) of the WAF web access control list (web ACL) associated with thisApi, if one exists.Api.BuilderxrayEnabled(Boolean xrayEnabled)A flag indicating whether to use X-Ray tracing for thisApi.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
-
-
-
Method Detail
-
apiId
Api.Builder apiId(String apiId)
The
ApiID.- Parameters:
apiId- TheApiID.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
name
Api.Builder name(String name)
The name of the
Api.- Parameters:
name- The name of theApi.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
ownerContact
Api.Builder ownerContact(String ownerContact)
The owner contact information for the
Api- Parameters:
ownerContact- The owner contact information for theApi- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
Api.Builder tags(Map<String,String> tags)
Sets the value of the Tags property for this object.- Parameters:
tags- The new value for the Tags property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dns
Api.Builder dns(Map<String,String> dns)
The DNS records for the API. This will include an HTTP and a real-time endpoint.
- Parameters:
dns- The DNS records for the API. This will include an HTTP and a real-time endpoint.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
apiArn
Api.Builder apiArn(String apiArn)
The Amazon Resource Name (ARN) for the
Api.- Parameters:
apiArn- The Amazon Resource Name (ARN) for theApi.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
created
Api.Builder created(Instant created)
The date and time that the
Apiwas created.- Parameters:
created- The date and time that theApiwas created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
xrayEnabled
Api.Builder xrayEnabled(Boolean xrayEnabled)
A flag indicating whether to use X-Ray tracing for this
Api.- Parameters:
xrayEnabled- A flag indicating whether to use X-Ray tracing for thisApi.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
wafWebAclArn
Api.Builder wafWebAclArn(String wafWebAclArn)
The Amazon Resource Name (ARN) of the WAF web access control list (web ACL) associated with this
Api, if one exists.- Parameters:
wafWebAclArn- The Amazon Resource Name (ARN) of the WAF web access control list (web ACL) associated with thisApi, if one exists.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
eventConfig
Api.Builder eventConfig(EventConfig eventConfig)
The Event API configuration. This includes the default authorization configuration for connecting, publishing, and subscribing to an Event API.
- Parameters:
eventConfig- The Event API configuration. This includes the default authorization configuration for connecting, publishing, and subscribing to an Event API.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
eventConfig
default Api.Builder eventConfig(Consumer<EventConfig.Builder> eventConfig)
The Event API configuration. This includes the default authorization configuration for connecting, publishing, and subscribing to an Event API.
This is a convenience method that creates an instance of theEventConfig.Builderavoiding the need to create one manually viaEventConfig.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toeventConfig(EventConfig).- Parameters:
eventConfig- a consumer that will call methods onEventConfig.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
eventConfig(EventConfig)
-
-