Interface CreatePortalRequest.Builder
- All Superinterfaces:
ApiPortalRequest.Builder,AwsRequest.Builder,Buildable,CopyableBuilder<CreatePortalRequest.Builder,,CreatePortalRequest> SdkBuilder<CreatePortalRequest.Builder,,CreatePortalRequest> SdkPojo,SdkRequest.Builder
- Enclosing class:
CreatePortalRequest
-
Method Summary
Modifier and TypeMethodDescriptiondefault CreatePortalRequest.Builderauthorization(Consumer<Authorization.Builder> authorization) How readers sign in to the portal, and whether fine-grained access control is on.authorization(Authorization authorization) How readers sign in to the portal, and whether fine-grained access control is on.default CreatePortalRequest.BuilderendpointConfiguration(Consumer<EndpointConfigurationRequest.Builder> endpointConfiguration) Sets the value of the EndpointConfiguration property for this object.endpointConfiguration(EndpointConfigurationRequest endpointConfiguration) Sets the value of the EndpointConfiguration property for this object.includedProductArns(String... includedProductArns) The ARNs of the products the portal includes, up to 200.includedProductArns(Collection<String> includedProductArns) The ARNs of the products the portal includes, up to 200.The S3 location of the portal logo, in the forms3://bucket/key.overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.default CreatePortalRequest.BuilderportalContent(Consumer<PortalContent.Builder> portalContent) The portal's display name, description, and theme.portalContent(PortalContent portalContent) The portal's display name, description, and theme.rumAppMonitorName(String rumAppMonitorName) The name of the CloudWatch RUM app monitor that collects reader telemetry for the portal.Sets the value of the Tags property for this object.Methods inherited from interface software.amazon.awssdk.services.apiportal.model.ApiPortalRequest.Builder
buildMethods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copyMethods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, buildMethods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
portalContent
The portal's display name, description, and theme.
- Parameters:
portalContent- The portal's display name, description, and theme.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
portalContent
The portal's display name, description, and theme.
This is a convenience method that creates an instance of thePortalContent.Builderavoiding the need to create one manually viaPortalContent.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toportalContent(PortalContent).- Parameters:
portalContent- a consumer that will call methods onPortalContent.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
endpointConfiguration
CreatePortalRequest.Builder endpointConfiguration(EndpointConfigurationRequest endpointConfiguration) Sets the value of the EndpointConfiguration property for this object.- Parameters:
endpointConfiguration- The new value for the EndpointConfiguration property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
endpointConfiguration
default CreatePortalRequest.Builder endpointConfiguration(Consumer<EndpointConfigurationRequest.Builder> endpointConfiguration) Sets the value of the EndpointConfiguration property for this object. This is a convenience method that creates an instance of theEndpointConfigurationRequest.Builderavoiding the need to create one manually viaEndpointConfigurationRequest.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toendpointConfiguration(EndpointConfigurationRequest).- Parameters:
endpointConfiguration- a consumer that will call methods onEndpointConfigurationRequest.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
authorization
How readers sign in to the portal, and whether fine-grained access control is on.
- Parameters:
authorization- How readers sign in to the portal, and whether fine-grained access control is on.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
authorization
How readers sign in to the portal, and whether fine-grained access control is on.
This is a convenience method that creates an instance of theAuthorization.Builderavoiding the need to create one manually viaAuthorization.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toauthorization(Authorization).- Parameters:
authorization- a consumer that will call methods onAuthorization.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
includedProductArns
The ARNs of the products the portal includes, up to 200.
- Parameters:
includedProductArns- The ARNs of the products the portal includes, up to 200.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
includedProductArns
The ARNs of the products the portal includes, up to 200.
- Parameters:
includedProductArns- The ARNs of the products the portal includes, up to 200.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
logoUri
The S3 location of the portal logo, in the form
s3://bucket/key.- Parameters:
logoUri- The S3 location of the portal logo, in the forms3://bucket/key.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
rumAppMonitorName
The name of the CloudWatch RUM app monitor that collects reader telemetry for the portal.
- Parameters:
rumAppMonitorName- The name of the CloudWatch RUM app monitor that collects reader telemetry for the portal.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
Sets the value of the Tags property for this object.- Parameters:
tags- The new value for the Tags property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
CreatePortalRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
overrideConfiguration- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CreatePortalRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
builderConsumer- AConsumerto which an emptyAwsRequestOverrideConfiguration.Builderwill be given.- Returns:
- This object for method chaining.
-