Interface CreateScopeRequest.Builder
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<CreateScopeRequest.Builder,,CreateScopeRequest> NetworkSecurityManagerRequest.Builder,SdkBuilder<CreateScopeRequest.Builder,,CreateScopeRequest> SdkPojo,SdkRequest.Builder
- Enclosing class:
CreateScopeRequest
-
Method Summary
Modifier and TypeMethodDescriptionclientToken(String clientToken) A unique, case-sensitive token that you provide to ensure that the operation completes no more than one time.isPublished(Boolean isPublished) Specifies whether to publish the resource.overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.default CreateScopeRequest.BuilderscopeConfiguration(Consumer<ScopeConfiguration.Builder> scopeConfiguration) The configuration that defines which accounts and resources are in scope.scopeConfiguration(ScopeConfiguration scopeConfiguration) The configuration that defines which accounts and resources are in scope.scopeDescription(String scopeDescription) A description of the scope.The name of the scope.specializedScopeType(String specializedScopeType) The specialized type of the scope.specializedScopeType(SpecializedScopeType specializedScopeType) The specialized type of the scope.The tags to add to the resource when it is created.Methods 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.services.networksecuritymanager.model.NetworkSecurityManagerRequest.Builder
buildMethods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, buildMethods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
clientToken
A unique, case-sensitive token that you provide to ensure that the operation completes no more than one time. If you retry a request with the same client token and the same parameters, the service returns the result of the original successful request.
- Parameters:
clientToken- A unique, case-sensitive token that you provide to ensure that the operation completes no more than one time. If you retry a request with the same client token and the same parameters, the service returns the result of the original successful request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
scopeName
The name of the scope.
- Parameters:
scopeName- The name of the scope.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
scopeDescription
A description of the scope.
- Parameters:
scopeDescription- A description of the scope.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
scopeConfiguration
The configuration that defines which accounts and resources are in scope.
- Parameters:
scopeConfiguration- The configuration that defines which accounts and resources are in scope.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
scopeConfiguration
default CreateScopeRequest.Builder scopeConfiguration(Consumer<ScopeConfiguration.Builder> scopeConfiguration) The configuration that defines which accounts and resources are in scope.
This is a convenience method that creates an instance of theScopeConfiguration.Builderavoiding the need to create one manually viaScopeConfiguration.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toscopeConfiguration(ScopeConfiguration).- Parameters:
scopeConfiguration- a consumer that will call methods onScopeConfiguration.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
specializedScopeType
The specialized type of the scope. Omit this value to create a standard scope that you can associate with a deployment. Set it to create a scope that is built for one specific purpose: a specialized scope can be used only for the purpose that its type defines, is validated against that use, and can't be associated with a deployment. This value is set when the scope is created and can't be changed.
- Parameters:
specializedScopeType- The specialized type of the scope. Omit this value to create a standard scope that you can associate with a deployment. Set it to create a scope that is built for one specific purpose: a specialized scope can be used only for the purpose that its type defines, is validated against that use, and can't be associated with a deployment. This value is set when the scope is created and can't be changed.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
specializedScopeType
The specialized type of the scope. Omit this value to create a standard scope that you can associate with a deployment. Set it to create a scope that is built for one specific purpose: a specialized scope can be used only for the purpose that its type defines, is validated against that use, and can't be associated with a deployment. This value is set when the scope is created and can't be changed.
- Parameters:
specializedScopeType- The specialized type of the scope. Omit this value to create a standard scope that you can associate with a deployment. Set it to create a scope that is built for one specific purpose: a specialized scope can be used only for the purpose that its type defines, is validated against that use, and can't be associated with a deployment. This value is set when the scope is created and can't be changed.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
isPublished
Specifies whether to publish the resource. When
true, the resource is saved in published (ACTIVE) state. Whenfalse, it is saved as a draft (DRAFT). Default:true.- Parameters:
isPublished- Specifies whether to publish the resource. Whentrue, the resource is saved in published (ACTIVE) state. Whenfalse, it is saved as a draft (DRAFT). Default:true.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
The tags to add to the resource when it is created.
- Parameters:
tags- The tags to add to the resource when it is created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
CreateScopeRequest.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
CreateScopeRequest.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.
-