Interface CreateConnectorRequest.Builder
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<CreateConnectorRequest.Builder,,CreateConnectorRequest> ObservabilityAdminRequest.Builder,SdkBuilder<CreateConnectorRequest.Builder,,CreateConnectorRequest> SdkPojo,SdkRequest.Builder
- Enclosing class:
CreateConnectorRequest
-
Method Summary
Modifier and TypeMethodDescriptionclientToken(String clientToken) A unique, case-sensitive identifier that you provide to ensure the operation completes no more than one time.default CreateConnectorRequest.BuilderconnectorConfiguration(Consumer<ConnectorConfiguration.Builder> connectorConfiguration) The configuration for connecting to the third-party cloud provider.connectorConfiguration(ConnectorConfiguration connectorConfiguration) The configuration for connecting to the third-party cloud provider.The name of the connector.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 Amazon Web Services Identity and Access Management (IAM) role that CloudWatch assumes to get credentials for the third-party cloud provider.The tags that you want to apply to the connector.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.observabilityadmin.model.ObservabilityAdminRequest.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
-
connectorConfiguration
CreateConnectorRequest.Builder connectorConfiguration(ConnectorConfiguration connectorConfiguration) The configuration for connecting to the third-party cloud provider.
- Parameters:
connectorConfiguration- The configuration for connecting to the third-party cloud provider.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
connectorConfiguration
default CreateConnectorRequest.Builder connectorConfiguration(Consumer<ConnectorConfiguration.Builder> connectorConfiguration) The configuration for connecting to the third-party cloud provider.
This is a convenience method that creates an instance of theConnectorConfiguration.Builderavoiding the need to create one manually viaConnectorConfiguration.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toconnectorConfiguration(ConnectorConfiguration).- Parameters:
connectorConfiguration- a consumer that will call methods onConnectorConfiguration.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
roleArn
The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that CloudWatch assumes to get credentials for the third-party cloud provider. The role must trust the Amazon CloudWatch Observability Admin service principal,
observabilityadmin.amazonaws.com. The role must also allowsts:GetWebIdentityTokenfor the provider's token exchange audience.- Parameters:
roleArn- The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that CloudWatch assumes to get credentials for the third-party cloud provider. The role must trust the Amazon CloudWatch Observability Admin service principal,observabilityadmin.amazonaws.com. The role must also allowsts:GetWebIdentityTokenfor the provider's token exchange audience.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
name
The name of the connector. The name must be unique in the account and Region (case-sensitive). If another connector already uses the name, the request fails with a
ConflictException.The name can contain letters, digits, hyphens (-), underscores (_) and periods (.), and must start with a letter.
- Parameters:
name- The name of the connector. The name must be unique in the account and Region (case-sensitive). If another connector already uses the name, the request fails with aConflictException.The name can contain letters, digits, hyphens (-), underscores (_) and periods (.), and must start with a letter.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
The tags that you want to apply to the connector.
- Parameters:
tags- The tags that you want to apply to the connector.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
clientToken
A unique, case-sensitive identifier that you provide to ensure the operation completes no more than one time. If you use an Amazon Web Services SDK, the SDK generates this value and reuses it on retries. If this token matches a previous request with the same parameters, the service returns the connector from the first request without an error. If you use the same token with different parameters, including different tags, the service returns a
ValidationException. This operation is idempotent when you use the same token and parameters.- Parameters:
clientToken- A unique, case-sensitive identifier that you provide to ensure the operation completes no more than one time. If you use an Amazon Web Services SDK, the SDK generates this value and reuses it on retries. If this token matches a previous request with the same parameters, the service returns the connector from the first request without an error. If you use the same token with different parameters, including different tags, the service returns aValidationException. This operation is idempotent when you use the same token and parameters.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
CreateConnectorRequest.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
CreateConnectorRequest.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.
-