Interface GetRoleCredentialsRequest.Builder
- All Superinterfaces:
AccountAccessRuntimeRequest.Builder,AwsRequest.Builder,Buildable,CopyableBuilder<GetRoleCredentialsRequest.Builder,,GetRoleCredentialsRequest> SdkBuilder<GetRoleCredentialsRequest.Builder,,GetRoleCredentialsRequest> SdkPojo,SdkRequest.Builder
- Enclosing class:
GetRoleCredentialsRequest
-
Method Summary
Modifier and TypeMethodDescriptionaccessType(String accessType) The type of access to request for the role.accessType(AccessType accessType) The type of access to request for the role.overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.The Amazon Resource Name (ARN) of the role to retrieve credentials for.sessionDuration(Integer sessionDuration) The duration, in seconds, that the returned credentials remain valid.sessionName(String sessionName) An optional name for the role session.The identifier of the tenant that the request applies to.Methods inherited from interface software.amazon.awssdk.services.accountaccessruntime.model.AccountAccessRuntimeRequest.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
-
tenantId
The identifier of the tenant that the request applies to. A tenant ID begins with
aa-and is 3 to 24 characters long. It can contain lowercase letters, numbers, and hyphens.- Parameters:
tenantId- The identifier of the tenant that the request applies to. A tenant ID begins withaa-and is 3 to 24 characters long. It can contain lowercase letters, numbers, and hyphens.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
roleArn
The Amazon Resource Name (ARN) of the role to retrieve credentials for. You must be entitled to assume this role.
- Parameters:
roleArn- The Amazon Resource Name (ARN) of the role to retrieve credentials for. You must be entitled to assume this role.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
accessType
The type of access to request for the role. Specify
PROGRAMMATIC_ACCESSto receive access key credentials for use with the CLI or an Amazon Web Services SDK.- Parameters:
accessType- The type of access to request for the role. SpecifyPROGRAMMATIC_ACCESSto receive access key credentials for use with the CLI or an Amazon Web Services SDK.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
accessType
The type of access to request for the role. Specify
PROGRAMMATIC_ACCESSto receive access key credentials for use with the CLI or an Amazon Web Services SDK.- Parameters:
accessType- The type of access to request for the role. SpecifyPROGRAMMATIC_ACCESSto receive access key credentials for use with the CLI or an Amazon Web Services SDK.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
sessionName
An optional name for the role session. The name can be 2 to 64 characters and can contain alphanumeric characters and the following symbols: plus (+), equal (=), comma (,), period (.), at (@), and hyphen (-). The session name appears in CloudTrail logs for the assumed role session.
- Parameters:
sessionName- An optional name for the role session. The name can be 2 to 64 characters and can contain alphanumeric characters and the following symbols: plus (+), equal (=), comma (,), period (.), at (@), and hyphen (-). The session name appears in CloudTrail logs for the assumed role session.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sessionDuration
The duration, in seconds, that the returned credentials remain valid. If you don't specify a value, the service uses the default session duration. The maximum value can't exceed the maximum session duration configured for the role.
- Parameters:
sessionDuration- The duration, in seconds, that the returned credentials remain valid. If you don't specify a value, the service uses the default session duration. The maximum value can't exceed the maximum session duration configured for the role.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
GetRoleCredentialsRequest.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
GetRoleCredentialsRequest.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.
-