Class UploadServerCertificateRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.iam.model.IamRequest
-
- software.amazon.awssdk.services.iam.model.UploadServerCertificateRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<UploadServerCertificateRequest.Builder,UploadServerCertificateRequest>
@Generated("software.amazon.awssdk:codegen") public final class UploadServerCertificateRequest extends IamRequest implements ToCopyableBuilder<UploadServerCertificateRequest.Builder,UploadServerCertificateRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceUploadServerCertificateRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static UploadServerCertificateRequest.Builderbuilder()StringcertificateBody()The contents of the public key certificate in PEM-encoded format.StringcertificateChain()The contents of the certificate chain.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.Stringpath()The path for the server certificate.StringprivateKey()The contents of the private key in PEM-encoded format.List<SdkField<?>>sdkFields()static Class<? extends UploadServerCertificateRequest.Builder>serializableBuilderClass()StringserverCertificateName()The name for the server certificate.List<Tag>tags()A list of tags that you want to attach to the new IAM server certificate resource.UploadServerCertificateRequest.BuildertoBuilder()StringtoString()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
-
path
public final String path()
The path for the server certificate. For more information about paths, see IAM identifiers in the IAM User Guide.
This parameter is optional. If it is not included, it defaults to a slash (/). This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (
!) through the DEL character (), including most punctuation characters, digits, and upper and lowercased letters.If you are uploading a server certificate specifically for use with Amazon CloudFront distributions, you must specify a path using the
pathparameter. The path must begin with/cloudfrontand must include a trailing slash (for example,/cloudfront/test/).- Returns:
- The path for the server certificate. For more information about paths, see IAM identifiers in the
IAM User Guide.
This parameter is optional. If it is not included, it defaults to a slash (/). This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (
!) through the DEL character (), including most punctuation characters, digits, and upper and lowercased letters.If you are uploading a server certificate specifically for use with Amazon CloudFront distributions, you must specify a path using the
pathparameter. The path must begin with/cloudfrontand must include a trailing slash (for example,/cloudfront/test/).
-
serverCertificateName
public final String serverCertificateName()
The name for the server certificate. Do not include the path in this value. The name of the certificate cannot contain any spaces.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
- Returns:
- The name for the server certificate. Do not include the path in this value. The name of the certificate
cannot contain any spaces.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
-
certificateBody
public final String certificateBody()
The contents of the public key certificate in PEM-encoded format.
The regex pattern used to validate this parameter is a string of characters consisting of the following:
-
Any printable ASCII character ranging from the space character (
) through the end of the ASCII character range -
The printable characters in the Basic Latin and Latin-1 Supplement character set (through
ÿ) -
The special characters tab (
), line feed (), and carriage return ()
- Returns:
- The contents of the public key certificate in PEM-encoded format.
The regex pattern used to validate this parameter is a string of characters consisting of the following:
-
Any printable ASCII character ranging from the space character (
) through the end of the ASCII character range -
The printable characters in the Basic Latin and Latin-1 Supplement character set (through
ÿ) -
The special characters tab (
), line feed (), and carriage return ()
-
-
-
privateKey
public final String privateKey()
The contents of the private key in PEM-encoded format.
The regex pattern used to validate this parameter is a string of characters consisting of the following:
-
Any printable ASCII character ranging from the space character (
) through the end of the ASCII character range -
The printable characters in the Basic Latin and Latin-1 Supplement character set (through
ÿ) -
The special characters tab (
), line feed (), and carriage return ()
- Returns:
- The contents of the private key in PEM-encoded format.
The regex pattern used to validate this parameter is a string of characters consisting of the following:
-
Any printable ASCII character ranging from the space character (
) through the end of the ASCII character range -
The printable characters in the Basic Latin and Latin-1 Supplement character set (through
ÿ) -
The special characters tab (
), line feed (), and carriage return ()
-
-
-
certificateChain
public final String certificateChain()
The contents of the certificate chain. This is typically a concatenation of the PEM-encoded public key certificates of the chain.
The regex pattern used to validate this parameter is a string of characters consisting of the following:
-
Any printable ASCII character ranging from the space character (
) through the end of the ASCII character range -
The printable characters in the Basic Latin and Latin-1 Supplement character set (through
ÿ) -
The special characters tab (
), line feed (), and carriage return ()
- Returns:
- The contents of the certificate chain. This is typically a concatenation of the PEM-encoded public key
certificates of the chain.
The regex pattern used to validate this parameter is a string of characters consisting of the following:
-
Any printable ASCII character ranging from the space character (
) through the end of the ASCII character range -
The printable characters in the Basic Latin and Latin-1 Supplement character set (through
ÿ) -
The special characters tab (
), line feed (), and carriage return ()
-
-
-
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
public final List<Tag> tags()
A list of tags that you want to attach to the new IAM server certificate resource. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.
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:
- A list of tags that you want to attach to the new IAM server certificate resource. Each tag consists of a
key name and an associated value. For more information about tagging, see Tagging IAM resources in the
IAM User Guide.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.
-
toBuilder
public UploadServerCertificateRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<UploadServerCertificateRequest.Builder,UploadServerCertificateRequest>- Specified by:
toBuilderin classIamRequest
-
builder
public static UploadServerCertificateRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends UploadServerCertificateRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
-