Network.AWS.IAM.UploadServerCertificate

Uploads a server certificate entity for the AWS account. The server certificate entity includes a public key certificate, a private key, and an optional certificate chain, which should all be PEM-encoded.

We recommend that you use AWS Certificate Manager to provision, manage, and deploy your server certificates. With ACM you can request a certificate, deploy it to AWS resources, and let ACM handle certificate renewals for you. Certificates provided by ACM are free. For more information about using ACM, see the AWS Certificate Manager User Guide .

For more information about working with server certificates, see Working with Server Certificates in the IAM User Guide . This topic includes a list of AWS services that can use the server certificates that you manage with IAM.

For information about the number of server certificates you can upload, see Limitations on IAM Entities and Objects in the IAM User Guide .

Creating a Request

uploadServerCertificate

Arguments

:: Text

uscServerCertificateName

-> Text

uscCertificateBody

-> Text

uscPrivateKey

-> UploadServerCertificate

Creates a value of UploadServerCertificate with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• uscPath - 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 (per its <http:wikipedia.orgwikiregex 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 ! (u0021) through the DEL character (u007F), including most punctuation characters, digits, and upper and lowercased letters.
• uscCertificateChain - 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 (u0020) through the end of the ASCII character range * The printable characters in the Basic Latin and Latin-1 Supplement character set (through u00FF) * The special characters tab (u0009), line feed (u000A), and carriage return (u000D)
• uscServerCertificateName - 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 (per 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: _+=,.@-
• uscCertificateBody - 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 (u0020) through the end of the ASCII character range * The printable characters in the Basic Latin and Latin-1 Supplement character set (through u00FF) * The special characters tab (u0009), line feed (u000A), and carriage return (u000D)
• uscPrivateKey - 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 (u0020) through the end of the ASCII character range * The printable characters in the Basic Latin and Latin-1 Supplement character set (through u00FF) * The special characters tab (u0009), line feed (u000A), and carriage return (u000D)

data UploadServerCertificate

See: uploadServerCertificate smart constructor.

Instances

Eq UploadServerCertificate

Methods

(==) :: UploadServerCertificate -> UploadServerCertificate -> Bool

(/=) :: UploadServerCertificate -> UploadServerCertificate -> Bool

Data UploadServerCertificate

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UploadServerCertificate -> c UploadServerCertificate

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UploadServerCertificate

toConstr :: UploadServerCertificate -> Constr

dataTypeOf :: UploadServerCertificate -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c UploadServerCertificate)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UploadServerCertificate)

gmapT :: (forall b. Data b => b -> b) -> UploadServerCertificate -> UploadServerCertificate

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UploadServerCertificate -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UploadServerCertificate -> r

gmapQ :: (forall d. Data d => d -> u) -> UploadServerCertificate -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> UploadServerCertificate -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UploadServerCertificate -> m UploadServerCertificate

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UploadServerCertificate -> m UploadServerCertificate

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UploadServerCertificate -> m UploadServerCertificate

Show UploadServerCertificate

Methods

showsPrec :: Int -> UploadServerCertificate -> ShowS

show :: UploadServerCertificate -> String

showList :: [UploadServerCertificate] -> ShowS

Generic UploadServerCertificate

Associated Types

type Rep UploadServerCertificate :: * -> *

Methods

from :: UploadServerCertificate -> Rep UploadServerCertificate x

to :: Rep UploadServerCertificate x -> UploadServerCertificate

Hashable UploadServerCertificate

Methods

hashWithSalt :: Int -> UploadServerCertificate -> Int

hash :: UploadServerCertificate -> Int

NFData UploadServerCertificate

Methods

rnf :: UploadServerCertificate -> ()

AWSRequest UploadServerCertificate

Associated Types

type Rs UploadServerCertificate :: *

Methods

request :: UploadServerCertificate -> Request UploadServerCertificate

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * UploadServerCertificate -> ClientResponse -> m (Response UploadServerCertificate)

ToHeaders UploadServerCertificate

Methods

toHeaders :: UploadServerCertificate -> [Header]

ToPath UploadServerCertificate

Methods

toPath :: UploadServerCertificate -> ByteString

ToQuery UploadServerCertificate

Methods

toQuery :: UploadServerCertificate -> QueryString

type Rep UploadServerCertificate

type Rep UploadServerCertificate = D1 * (MetaData "UploadServerCertificate" "Network.AWS.IAM.UploadServerCertificate" "amazonka-iam-1.6.0-CI3f7XZIc4eD0Ehb04tNY7" False) (C1 * (MetaCons "UploadServerCertificate'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_uscPath") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_uscCertificateChain") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_uscServerCertificateName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) ((:*:) * (S1 * (MetaSel (Just Symbol "_uscCertificateBody") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_uscPrivateKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Sensitive Text)))))))

type Rs UploadServerCertificate

type Rs UploadServerCertificate = UploadServerCertificateResponse

Request Lenses

uscPath :: Lens' UploadServerCertificate (Maybe Text)

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 (per its <http:wikipedia.orgwikiregex 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 ! (u0021) through the DEL character (u007F), including most punctuation characters, digits, and upper and lowercased letters.

uscCertificateChain :: Lens' UploadServerCertificate (Maybe Text)

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 (u0020) through the end of the ASCII character range * The printable characters in the Basic Latin and Latin-1 Supplement character set (through u00FF) * The special characters tab (u0009), line feed (u000A), and carriage return (u000D)

uscServerCertificateName :: Lens' UploadServerCertificate Text

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 (per 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: _+=,.@-

uscCertificateBody :: Lens' UploadServerCertificate Text

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 (u0020) through the end of the ASCII character range * The printable characters in the Basic Latin and Latin-1 Supplement character set (through u00FF) * The special characters tab (u0009), line feed (u000A), and carriage return (u000D)

uscPrivateKey :: Lens' UploadServerCertificate Text

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 (u0020) through the end of the ASCII character range * The printable characters in the Basic Latin and Latin-1 Supplement character set (through u00FF) * The special characters tab (u0009), line feed (u000A), and carriage return (u000D)

Destructuring the Response

uploadServerCertificateResponse

Arguments

:: Int

ursResponseStatus

-> UploadServerCertificateResponse

Creates a value of UploadServerCertificateResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ursServerCertificateMetadata - The meta information of the uploaded server certificate without its certificate body, certificate chain, and private key.
• ursResponseStatus - -- | The response status code.

data UploadServerCertificateResponse

Contains the response to a successful UploadServerCertificate request.

See: uploadServerCertificateResponse smart constructor.

Instances

Eq UploadServerCertificateResponse

Methods

(==) :: UploadServerCertificateResponse -> UploadServerCertificateResponse -> Bool

(/=) :: UploadServerCertificateResponse -> UploadServerCertificateResponse -> Bool

Data UploadServerCertificateResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UploadServerCertificateResponse -> c UploadServerCertificateResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UploadServerCertificateResponse

toConstr :: UploadServerCertificateResponse -> Constr

dataTypeOf :: UploadServerCertificateResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c UploadServerCertificateResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UploadServerCertificateResponse)

gmapT :: (forall b. Data b => b -> b) -> UploadServerCertificateResponse -> UploadServerCertificateResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UploadServerCertificateResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UploadServerCertificateResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> UploadServerCertificateResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> UploadServerCertificateResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UploadServerCertificateResponse -> m UploadServerCertificateResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UploadServerCertificateResponse -> m UploadServerCertificateResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UploadServerCertificateResponse -> m UploadServerCertificateResponse

Read UploadServerCertificateResponse

Methods

readsPrec :: Int -> ReadS UploadServerCertificateResponse

readList :: ReadS [UploadServerCertificateResponse]

readPrec :: ReadPrec UploadServerCertificateResponse

readListPrec :: ReadPrec [UploadServerCertificateResponse]

Show UploadServerCertificateResponse

Methods

showsPrec :: Int -> UploadServerCertificateResponse -> ShowS

show :: UploadServerCertificateResponse -> String

showList :: [UploadServerCertificateResponse] -> ShowS

Generic UploadServerCertificateResponse

Associated Types

type Rep UploadServerCertificateResponse :: * -> *

Methods

from :: UploadServerCertificateResponse -> Rep UploadServerCertificateResponse x

to :: Rep UploadServerCertificateResponse x -> UploadServerCertificateResponse

NFData UploadServerCertificateResponse

Methods

rnf :: UploadServerCertificateResponse -> ()

type Rep UploadServerCertificateResponse

type Rep UploadServerCertificateResponse = D1 * (MetaData "UploadServerCertificateResponse" "Network.AWS.IAM.UploadServerCertificate" "amazonka-iam-1.6.0-CI3f7XZIc4eD0Ehb04tNY7" False) (C1 * (MetaCons "UploadServerCertificateResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_ursServerCertificateMetadata") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe ServerCertificateMetadata))) (S1 * (MetaSel (Just Symbol "_ursResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

Response Lenses

ursServerCertificateMetadata :: Lens' UploadServerCertificateResponse (Maybe ServerCertificateMetadata)

The meta information of the uploaded server certificate without its certificate body, certificate chain, and private key.

ursResponseStatus :: Lens' UploadServerCertificateResponse Int

• - | The response status code.