software.amazon.awssdk.services.iam.model

Interface CreateSamlProviderRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateSamlProviderRequest.Builder,CreateSamlProviderRequest>, IamRequest.Builder, SdkBuilder<CreateSamlProviderRequest.Builder,CreateSamlProviderRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateSamlProviderRequest

public static interface CreateSamlProviderRequest.Builder
extends IamRequest.Builder, SdkPojo, CopyableBuilder<CreateSamlProviderRequest.Builder,CreateSamlProviderRequest>

Method Summary

Modifier and Type	Method and Description
CreateSamlProviderRequest.Builder	name(String name) The name of the provider to create.
CreateSamlProviderRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateSamlProviderRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateSamlProviderRequest.Builder	samlMetadataDocument(String samlMetadataDocument) An XML document generated by an identity provider (IdP) that supports SAML 2.0.
CreateSamlProviderRequest.Builder	tags(Collection<Tag> tags) A list of tags that you want to attach to the new IAM SAML provider.
CreateSamlProviderRequest.Builder	tags(Consumer<Tag.Builder>... tags) A list of tags that you want to attach to the new IAM SAML provider.
CreateSamlProviderRequest.Builder	tags(Tag... tags) A list of tags that you want to attach to the new IAM SAML provider.

Methods inherited from interface software.amazon.awssdk.services.iam.model.IamRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

samlMetadataDocument

CreateSamlProviderRequest.Builder samlMetadataDocument(String 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.

For more information, see About SAML 2.0-based federation in the IAM User Guide

Parameters:

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.

For more information, see About SAML 2.0-based federation in the IAM User Guide

Returns:

Returns a reference to this object so that method calls can be chained together.

name

CreateSamlProviderRequest.Builder name(String name)

The name of the provider to create.

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

Parameters:

name - The name of the provider to create.

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:

Returns a reference to this object so that method calls can be chained together.

tags

CreateSamlProviderRequest.Builder tags(Collection<Tag> tags)

A list of tags that you want to attach to the new IAM SAML provider. 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.

Parameters:

tags - A list of tags that you want to attach to the new IAM SAML provider. 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

CreateSamlProviderRequest.Builder tags(Tag... tags)

A list of tags that you want to attach to the new IAM SAML provider. 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.

Parameters:

tags - A list of tags that you want to attach to the new IAM SAML provider. 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

CreateSamlProviderRequest.Builder tags(Consumer<Tag.Builder>... tags)

A list of tags that you want to attach to the new IAM SAML provider. 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.

This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

Parameters:

tags - a consumer that will call methods on Tag.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#tags(java.util.Collection)

overrideConfiguration

CreateSamlProviderRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

CreateSamlProviderRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder