Method: Aws::IAM::SamlProvider#update

Defined in:
lib/aws-sdk-iam/saml_provider.rb

#update(options = {}) ⇒ Types::UpdateSAMLProviderResponse

Examples:

Request syntax with placeholder values


saml_provider.update({
  saml_metadata_document: "SAMLMetadataDocumentType",
  assertion_encryption_mode: "Required", # accepts Required, Allowed
  add_private_key: "privateKeyType",
  remove_private_key: "privateKeyIdType",
})

Parameters:

  • options (Hash) (defaults to: {}) —

    ({})

Options Hash (options):

  • :saml_metadata_document (String) —

    An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document includes the issuer’s name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that are received from the IdP. You must generate the metadata document using the identity management software that is used as your IdP.

  • :assertion_encryption_mode (String) —

    Specifies the encryption setting for the SAML provider.

  • :add_private_key (String) —

    Specifies the new private key from your external identity provider. The private key must be a .pem file that uses AES-GCM or AES-CBC encryption algorithm to decrypt SAML assertions.

  • :remove_private_key (String) —

    The Key ID of the private key to remove.

Returns:



262
263
264
265
266
267
268
 
# File 'lib/aws-sdk-iam/saml_provider.rb', line 262

def update(options = {})
  options = options.merge(saml_provider_arn: @arn)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.update_saml_provider(options)
  end
  resp.data
end