@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreatePortalRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
CreatePortalRequest() |
Modifier and Type | Method and Description |
---|---|
CreatePortalRequest |
addAdditionalEncryptionContextEntry(String key,
String value)
Add a single AdditionalEncryptionContext entry
|
CreatePortalRequest |
clearAdditionalEncryptionContextEntries()
Removes all the entries added into AdditionalEncryptionContext.
|
CreatePortalRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
Map<String,String> |
getAdditionalEncryptionContext()
The additional encryption context of the portal.
|
String |
getAuthenticationType()
The type of authentication integration points used when signing into the web portal.
|
String |
getClientToken()
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
|
String |
getCustomerManagedKey()
The customer managed key of the web portal.
|
String |
getDisplayName()
The name of the web portal.
|
List<Tag> |
getTags()
The tags to add to the web portal.
|
int |
hashCode() |
void |
setAdditionalEncryptionContext(Map<String,String> additionalEncryptionContext)
The additional encryption context of the portal.
|
void |
setAuthenticationType(String authenticationType)
The type of authentication integration points used when signing into the web portal.
|
void |
setClientToken(String clientToken)
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
|
void |
setCustomerManagedKey(String customerManagedKey)
The customer managed key of the web portal.
|
void |
setDisplayName(String displayName)
The name of the web portal.
|
void |
setTags(Collection<Tag> tags)
The tags to add to the web portal.
|
String |
toString()
Returns a string representation of this object.
|
CreatePortalRequest |
withAdditionalEncryptionContext(Map<String,String> additionalEncryptionContext)
The additional encryption context of the portal.
|
CreatePortalRequest |
withAuthenticationType(AuthenticationType authenticationType)
The type of authentication integration points used when signing into the web portal.
|
CreatePortalRequest |
withAuthenticationType(String authenticationType)
The type of authentication integration points used when signing into the web portal.
|
CreatePortalRequest |
withClientToken(String clientToken)
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
|
CreatePortalRequest |
withCustomerManagedKey(String customerManagedKey)
The customer managed key of the web portal.
|
CreatePortalRequest |
withDisplayName(String displayName)
The name of the web portal.
|
CreatePortalRequest |
withTags(Collection<Tag> tags)
The tags to add to the web portal.
|
CreatePortalRequest |
withTags(Tag... tags)
The tags to add to the web portal.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public Map<String,String> getAdditionalEncryptionContext()
The additional encryption context of the portal.
public void setAdditionalEncryptionContext(Map<String,String> additionalEncryptionContext)
The additional encryption context of the portal.
additionalEncryptionContext
- The additional encryption context of the portal.public CreatePortalRequest withAdditionalEncryptionContext(Map<String,String> additionalEncryptionContext)
The additional encryption context of the portal.
additionalEncryptionContext
- The additional encryption context of the portal.public CreatePortalRequest addAdditionalEncryptionContextEntry(String key, String value)
public CreatePortalRequest clearAdditionalEncryptionContextEntries()
public void setAuthenticationType(String authenticationType)
The type of authentication integration points used when signing into the web portal. Defaults to
Standard
.
Standard
web portals are authenticated directly through your identity provider. You need to call
CreateIdentityProvider
to integrate your identity provider with your web portal. User and group
access to your web portal is controlled through your identity provider.
IAM_Identity_Center
web portals are authenticated through AWS IAM Identity Center (successor to AWS
Single Sign-On). They provide additional features, such as IdP-initiated authentication. Identity sources
(including external identity provider integration), plus user and group access to your web portal, can be
configured in the IAM Identity Center.
authenticationType
- The type of authentication integration points used when signing into the web portal. Defaults to
Standard
.
Standard
web portals are authenticated directly through your identity provider. You need to
call CreateIdentityProvider
to integrate your identity provider with your web portal. User
and group access to your web portal is controlled through your identity provider.
IAM_Identity_Center
web portals are authenticated through AWS IAM Identity Center (successor
to AWS Single Sign-On). They provide additional features, such as IdP-initiated authentication. Identity
sources (including external identity provider integration), plus user and group access to your web portal,
can be configured in the IAM Identity Center.
AuthenticationType
public String getAuthenticationType()
The type of authentication integration points used when signing into the web portal. Defaults to
Standard
.
Standard
web portals are authenticated directly through your identity provider. You need to call
CreateIdentityProvider
to integrate your identity provider with your web portal. User and group
access to your web portal is controlled through your identity provider.
IAM_Identity_Center
web portals are authenticated through AWS IAM Identity Center (successor to AWS
Single Sign-On). They provide additional features, such as IdP-initiated authentication. Identity sources
(including external identity provider integration), plus user and group access to your web portal, can be
configured in the IAM Identity Center.
Standard
.
Standard
web portals are authenticated directly through your identity provider. You need to
call CreateIdentityProvider
to integrate your identity provider with your web portal. User
and group access to your web portal is controlled through your identity provider.
IAM_Identity_Center
web portals are authenticated through AWS IAM Identity Center (successor
to AWS Single Sign-On). They provide additional features, such as IdP-initiated authentication. Identity
sources (including external identity provider integration), plus user and group access to your web
portal, can be configured in the IAM Identity Center.
AuthenticationType
public CreatePortalRequest withAuthenticationType(String authenticationType)
The type of authentication integration points used when signing into the web portal. Defaults to
Standard
.
Standard
web portals are authenticated directly through your identity provider. You need to call
CreateIdentityProvider
to integrate your identity provider with your web portal. User and group
access to your web portal is controlled through your identity provider.
IAM_Identity_Center
web portals are authenticated through AWS IAM Identity Center (successor to AWS
Single Sign-On). They provide additional features, such as IdP-initiated authentication. Identity sources
(including external identity provider integration), plus user and group access to your web portal, can be
configured in the IAM Identity Center.
authenticationType
- The type of authentication integration points used when signing into the web portal. Defaults to
Standard
.
Standard
web portals are authenticated directly through your identity provider. You need to
call CreateIdentityProvider
to integrate your identity provider with your web portal. User
and group access to your web portal is controlled through your identity provider.
IAM_Identity_Center
web portals are authenticated through AWS IAM Identity Center (successor
to AWS Single Sign-On). They provide additional features, such as IdP-initiated authentication. Identity
sources (including external identity provider integration), plus user and group access to your web portal,
can be configured in the IAM Identity Center.
AuthenticationType
public CreatePortalRequest withAuthenticationType(AuthenticationType authenticationType)
The type of authentication integration points used when signing into the web portal. Defaults to
Standard
.
Standard
web portals are authenticated directly through your identity provider. You need to call
CreateIdentityProvider
to integrate your identity provider with your web portal. User and group
access to your web portal is controlled through your identity provider.
IAM_Identity_Center
web portals are authenticated through AWS IAM Identity Center (successor to AWS
Single Sign-On). They provide additional features, such as IdP-initiated authentication. Identity sources
(including external identity provider integration), plus user and group access to your web portal, can be
configured in the IAM Identity Center.
authenticationType
- The type of authentication integration points used when signing into the web portal. Defaults to
Standard
.
Standard
web portals are authenticated directly through your identity provider. You need to
call CreateIdentityProvider
to integrate your identity provider with your web portal. User
and group access to your web portal is controlled through your identity provider.
IAM_Identity_Center
web portals are authenticated through AWS IAM Identity Center (successor
to AWS Single Sign-On). They provide additional features, such as IdP-initiated authentication. Identity
sources (including external identity provider integration), plus user and group access to your web portal,
can be configured in the IAM Identity Center.
AuthenticationType
public void setClientToken(String clientToken)
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.
If you do not specify a client token, one is automatically generated by the AWS SDK.
clientToken
- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency
ensures that an API request completes only once. With an idempotent request, if the original request
completes successfully, subsequent retries with the same client token returns the result from the original
successful request.
If you do not specify a client token, one is automatically generated by the AWS SDK.
public String getClientToken()
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.
If you do not specify a client token, one is automatically generated by the AWS SDK.
If you do not specify a client token, one is automatically generated by the AWS SDK.
public CreatePortalRequest withClientToken(String clientToken)
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.
If you do not specify a client token, one is automatically generated by the AWS SDK.
clientToken
- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency
ensures that an API request completes only once. With an idempotent request, if the original request
completes successfully, subsequent retries with the same client token returns the result from the original
successful request.
If you do not specify a client token, one is automatically generated by the AWS SDK.
public void setCustomerManagedKey(String customerManagedKey)
The customer managed key of the web portal.
customerManagedKey
- The customer managed key of the web portal.public String getCustomerManagedKey()
The customer managed key of the web portal.
public CreatePortalRequest withCustomerManagedKey(String customerManagedKey)
The customer managed key of the web portal.
customerManagedKey
- The customer managed key of the web portal.public void setDisplayName(String displayName)
The name of the web portal. This is not visible to users who log into the web portal.
displayName
- The name of the web portal. This is not visible to users who log into the web portal.public String getDisplayName()
The name of the web portal. This is not visible to users who log into the web portal.
public CreatePortalRequest withDisplayName(String displayName)
The name of the web portal. This is not visible to users who log into the web portal.
displayName
- The name of the web portal. This is not visible to users who log into the web portal.public List<Tag> getTags()
The tags to add to the web portal. A tag is a key-value pair.
public void setTags(Collection<Tag> tags)
The tags to add to the web portal. A tag is a key-value pair.
tags
- The tags to add to the web portal. A tag is a key-value pair.public CreatePortalRequest withTags(Tag... tags)
The tags to add to the web portal. A tag is a key-value pair.
NOTE: This method appends the values to the existing list (if any). Use
setTags(java.util.Collection)
or withTags(java.util.Collection)
if you want to override the
existing values.
tags
- The tags to add to the web portal. A tag is a key-value pair.public CreatePortalRequest withTags(Collection<Tag> tags)
The tags to add to the web portal. A tag is a key-value pair.
tags
- The tags to add to the web portal. A tag is a key-value pair.public String toString()
toString
in class Object
Object.toString()
public CreatePortalRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()