Package software.amazon.awssdk.services.cloudfront.model

Class UpdateDistributionTenantRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.cloudfront.model.CloudFrontRequest

software.amazon.awssdk.services.cloudfront.model.UpdateDistributionTenantRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateDistributionTenantRequest.Builder,UpdateDistributionTenantRequest>

@Generated("software.amazon.awssdk:codegen")
public final class UpdateDistributionTenantRequest
extends CloudFrontRequest
implements ToCopyableBuilder<UpdateDistributionTenantRequest.Builder,UpdateDistributionTenantRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdateDistributionTenantRequest.Builder

Method Summary

Modifier and Type	Method	Description
static UpdateDistributionTenantRequest.Builder	builder()
String	connectionGroupId()	The ID of the target connection group.
Customizations	customizations()	Customizations for the distribution tenant.
String	distributionId()	The ID for the multi-tenant distribution.
List<DomainItem>	domains()	The domains to update for the distribution tenant.
Boolean	enabled()	Indicates whether the distribution tenant should be updated to an enabled state.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDomains()	For responses, this returns true if the service returned a value for the Domains property.
int	hashCode()
boolean	hasParameters()	For responses, this returns true if the service returned a value for the Parameters property.
String	id()	The ID of the distribution tenant.
String	ifMatch()	The value of the ETag header that you received when retrieving the distribution tenant to update.
ManagedCertificateRequest	managedCertificateRequest()	An object that contains the CloudFront managed ACM certificate request.
List<Parameter>	parameters()	A list of parameter values to add to the resource.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateDistributionTenantRequest.Builder>	serializableBuilderClass()
UpdateDistributionTenantRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

id

public final String id()

The ID of the distribution tenant.

Returns:

The ID of the distribution tenant.

distributionId

public final String distributionId()

The ID for the multi-tenant distribution.

Returns:

The ID for the multi-tenant distribution.

hasDomains

public final boolean hasDomains()

For responses, this returns true if the service returned a value for the Domains property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

domains

public final List<DomainItem> domains()

The domains to update for the distribution tenant. A domain object can contain only a domain property. You must specify at least one domain. Each distribution tenant can have up to 5 domains.

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 hasDomains() method.

Returns:

The domains to update for the distribution tenant. A domain object can contain only a domain property. You must specify at least one domain. Each distribution tenant can have up to 5 domains.

customizations

public final Customizations customizations()

Customizations for the distribution tenant. For each distribution tenant, you can specify the geographic restrictions, and the Amazon Resource Names (ARNs) for the ACM certificate and WAF web ACL. These are specific values that you can override or disable from the multi-tenant distribution that was used to create the distribution tenant.

Returns:

Customizations for the distribution tenant. For each distribution tenant, you can specify the geographic restrictions, and the Amazon Resource Names (ARNs) for the ACM certificate and WAF web ACL. These are specific values that you can override or disable from the multi-tenant distribution that was used to create the distribution tenant.

hasParameters

public final boolean hasParameters()

For responses, this returns true if the service returned a value for the Parameters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

parameters

public final List<Parameter> parameters()

A list of parameter values to add to the resource. A parameter is specified as a key-value pair. A valid parameter value must exist for any parameter that is marked as required in the multi-tenant distribution.

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 hasParameters() method.

Returns:

A list of parameter values to add to the resource. A parameter is specified as a key-value pair. A valid parameter value must exist for any parameter that is marked as required in the multi-tenant distribution.

connectionGroupId

public final String connectionGroupId()

The ID of the target connection group.

Returns:

The ID of the target connection group.

ifMatch

public final String ifMatch()

The value of the ETag header that you received when retrieving the distribution tenant to update. This value is returned in the response of the GetDistributionTenant API operation.

Returns:

The value of the ETag header that you received when retrieving the distribution tenant to update. This value is returned in the response of the GetDistributionTenant API operation.

managedCertificateRequest

public final ManagedCertificateRequest managedCertificateRequest()

An object that contains the CloudFront managed ACM certificate request.

Returns:

An object that contains the CloudFront managed ACM certificate request.

enabled

public final Boolean enabled()

Indicates whether the distribution tenant should be updated to an enabled state. If you update the distribution tenant and it's not enabled, the distribution tenant won't serve traffic.

Returns:

Indicates whether the distribution tenant should be updated to an enabled state. If you update the distribution tenant and it's not enabled, the distribution tenant won't serve traffic.

toBuilder

public UpdateDistributionTenantRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateDistributionTenantRequest.Builder,UpdateDistributionTenantRequest>

Specified by:

toBuilder in class CloudFrontRequest

builder

public static UpdateDistributionTenantRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateDistributionTenantRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo