Class CreateConnectorRequest
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<CreateConnectorRequest.Builder,CreateConnectorRequest>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionbuilder()final StringA unique, case-sensitive identifier that you provide to ensure the operation completes no more than one time.final ConnectorConfigurationThe configuration for connecting to the third-party cloud provider.final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest.final inthashCode()final booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.final Stringname()The name of the connector.final StringroleArn()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.static Class<? extends CreateConnectorRequest.Builder> tags()The tags that you want to apply to the connector.Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
connectorConfiguration
The configuration for connecting to the third-party cloud provider.
- Returns:
- The configuration for connecting to the third-party cloud provider.
-
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:
- 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.
-
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.
- Returns:
- 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.
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
tags
The tags that you want to apply to the connector.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTags()method.- Returns:
- The tags that you want to apply to the connector.
-
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.- Returns:
- 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.
-
toBuilder
Description copied from interface:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<CreateConnectorRequest.Builder,CreateConnectorRequest> - Specified by:
toBuilderin classObservabilityAdminRequest- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCodein classAwsRequest
-
equals
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin interfaceSdkPojo- Parameters:
obj- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
Description copied from class:SdkRequestUsed to retrieve the value of a field from any class that extendsSdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)method will again be available.- Overrides:
getValueForFieldin classSdkRequest- Parameters:
fieldName- The name of the member to be retrieved.clazz- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-