public static final class CfnSAMLProvider.Builder
extends java.lang.Object
CfnSAMLProvider
.Modifier and Type | Method and Description |
---|---|
CfnSAMLProvider |
build() |
static CfnSAMLProvider.Builder |
create(Construct scope,
java.lang.String id) |
CfnSAMLProvider.Builder |
name(java.lang.String name)
The name of the provider to create.
|
CfnSAMLProvider.Builder |
samlMetadataDocument(java.lang.String samlMetadataDocument)
An XML document generated by an identity provider (IdP) that supports SAML 2.0.
|
CfnSAMLProvider.Builder |
tags(java.util.List<? extends CfnTag> tags)
A list of tags that you want to attach to the new IAM SAML provider.
|
public static CfnSAMLProvider.Builder create(Construct scope, java.lang.String id)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.CfnSAMLProvider.Builder
.public CfnSAMLProvider.Builder samlMetadataDocument(java.lang.String samlMetadataDocument)
For more information, see About SAML 2.0-based federation in the IAM User Guide
samlMetadataDocument
- 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 organization's IdP. This parameter is required.this
public CfnSAMLProvider.Builder name(java.lang.String name)
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: _+=,.@-
name
- The name of the provider to create. This parameter is required.this
public CfnSAMLProvider.Builder tags(java.util.List<? extends CfnTag> tags)
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.
tags
- A list of tags that you want to attach to the new IAM SAML provider. This parameter is required.this
public CfnSAMLProvider build()