Class UploadServerCertificateRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<UploadServerCertificateRequest.Builder,
UploadServerCertificateRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
The contents of the public key certificate in PEM-encoded format.final String
The contents of the certificate chain.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 String
path()
The path for the server certificate.final String
The contents of the private key in PEM-encoded format.static Class
<? extends UploadServerCertificateRequest.Builder> final String
The name for the server certificate.tags()
A list of tags that you want to attach to the new IAM server certificate resource.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.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
path
parameter. The path must begin with/cloudfront
and 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
path
parameter. The path must begin with/cloudfront
and must include a trailing slash (for example,/cloudfront/test/
).
-
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
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 (
-
The printable characters in the Basic Latin and Latin-1 Supplement character set (through
ÿ
) -
The special characters tab (
- 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 (
-
The printable characters in the Basic Latin and Latin-1 Supplement character set (through
ÿ
) -
The special characters tab (
-
-
-
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 (
-
The printable characters in the Basic Latin and Latin-1 Supplement character set (through
ÿ
) -
The special characters tab (
- 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 (
-
The printable characters in the Basic Latin and Latin-1 Supplement character set (through
ÿ
) -
The special characters tab (
-
-
-
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 (
-
The printable characters in the Basic Latin and Latin-1 Supplement character set (through
ÿ
) -
The special characters tab (
- 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 (
-
The printable characters in the Basic Latin and Latin-1 Supplement character set (through
ÿ
) -
The special characters tab (
-
-
-
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
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
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<UploadServerCertificateRequest.Builder,
UploadServerCertificateRequest> - Specified by:
toBuilder
in classIamRequest
- 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
-