software.amazon.awssdk.services.config.model

Interface ConfigurationItem.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ConfigurationItem.Builder,ConfigurationItem>, SdkBuilder<ConfigurationItem.Builder,ConfigurationItem>, SdkPojo

Enclosing class:

ConfigurationItem

public static interface ConfigurationItem.Builder
extends SdkPojo, CopyableBuilder<ConfigurationItem.Builder,ConfigurationItem>

Method Summary

Modifier and Type	Method and Description
ConfigurationItem.Builder	accountId(String accountId) The 12-digit Amazon Web Services account ID associated with the resource.
ConfigurationItem.Builder	arn(String arn) Amazon Resource Name (ARN) associated with the resource.
ConfigurationItem.Builder	availabilityZone(String availabilityZone) The Availability Zone associated with the resource.
ConfigurationItem.Builder	awsRegion(String awsRegion) The region where the resource resides.
ConfigurationItem.Builder	configuration(String configuration) The description of the resource configuration.
ConfigurationItem.Builder	configurationItemCaptureTime(Instant configurationItemCaptureTime) The time when the configuration recording was initiated.
ConfigurationItem.Builder	configurationItemMD5Hash(String configurationItemMD5Hash) Unique MD5 hash that represents the configuration item's state.
ConfigurationItem.Builder	configurationItemStatus(ConfigurationItemStatus configurationItemStatus) The configuration item status.
ConfigurationItem.Builder	configurationItemStatus(String configurationItemStatus) The configuration item status.
ConfigurationItem.Builder	configurationStateId(String configurationStateId) An identifier that indicates the ordering of the configuration items of a resource.
ConfigurationItem.Builder	relatedEvents(Collection<String> relatedEvents) A list of CloudTrail event IDs.
ConfigurationItem.Builder	relatedEvents(String... relatedEvents) A list of CloudTrail event IDs.
ConfigurationItem.Builder	relationships(Collection<Relationship> relationships) A list of related Amazon Web Services resources.
ConfigurationItem.Builder	relationships(Consumer<Relationship.Builder>... relationships) A list of related Amazon Web Services resources.
ConfigurationItem.Builder	relationships(Relationship... relationships) A list of related Amazon Web Services resources.
ConfigurationItem.Builder	resourceCreationTime(Instant resourceCreationTime) The time stamp when the resource was created.
ConfigurationItem.Builder	resourceId(String resourceId) The ID of the resource (for example, sg-xxxxxx).
ConfigurationItem.Builder	resourceName(String resourceName) The custom name of the resource, if available.
ConfigurationItem.Builder	resourceType(ResourceType resourceType) The type of Amazon Web Services resource.
ConfigurationItem.Builder	resourceType(String resourceType) The type of Amazon Web Services resource.
ConfigurationItem.Builder	supplementaryConfiguration(Map<String,String> supplementaryConfiguration) Configuration attributes that Config returns for certain resource types to supplement the information returned for the configuration parameter.
ConfigurationItem.Builder	tags(Map<String,String> tags) A mapping of key value tags associated with the resource.
ConfigurationItem.Builder	version(String version) The version number of the resource configuration.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

version

ConfigurationItem.Builder version(String version)

The version number of the resource configuration.

Parameters:

version - The version number of the resource configuration.

Returns:

Returns a reference to this object so that method calls can be chained together.

accountId

ConfigurationItem.Builder accountId(String accountId)

The 12-digit Amazon Web Services account ID associated with the resource.

Parameters:

accountId - The 12-digit Amazon Web Services account ID associated with the resource.

Returns:

Returns a reference to this object so that method calls can be chained together.

configurationItemCaptureTime

ConfigurationItem.Builder configurationItemCaptureTime(Instant configurationItemCaptureTime)

The time when the configuration recording was initiated.

Parameters:

configurationItemCaptureTime - The time when the configuration recording was initiated.

Returns:

Returns a reference to this object so that method calls can be chained together.

configurationItemStatus

ConfigurationItem.Builder configurationItemStatus(String configurationItemStatus)

The configuration item status. The valid values are:

• OK – The resource configuration has been updated

• ResourceDiscovered – The resource was newly discovered

• ResourceNotRecorded – The resource was discovered but its configuration was not recorded since the recorder excludes the recording of resources of this type

• ResourceDeleted – The resource was deleted

• ResourceDeletedNotRecorded – The resource was deleted but its configuration was not recorded since the recorder excludes the recording of resources of this type

Parameters:

configurationItemStatus - The configuration item status. The valid values are:

• OK – The resource configuration has been updated

• ResourceDiscovered – The resource was newly discovered

• ResourceNotRecorded – The resource was discovered but its configuration was not recorded since the recorder excludes the recording of resources of this type

• ResourceDeleted – The resource was deleted

• ResourceDeletedNotRecorded – The resource was deleted but its configuration was not recorded since the recorder excludes the recording of resources of this type

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ConfigurationItemStatus, ConfigurationItemStatus

configurationItemStatus

ConfigurationItem.Builder configurationItemStatus(ConfigurationItemStatus configurationItemStatus)

The configuration item status. The valid values are:

• OK – The resource configuration has been updated

• ResourceDiscovered – The resource was newly discovered

• ResourceNotRecorded – The resource was discovered but its configuration was not recorded since the recorder excludes the recording of resources of this type

• ResourceDeleted – The resource was deleted

• ResourceDeletedNotRecorded – The resource was deleted but its configuration was not recorded since the recorder excludes the recording of resources of this type

Parameters:

configurationItemStatus - The configuration item status. The valid values are:

• OK – The resource configuration has been updated

• ResourceDiscovered – The resource was newly discovered

• ResourceNotRecorded – The resource was discovered but its configuration was not recorded since the recorder excludes the recording of resources of this type

• ResourceDeleted – The resource was deleted

• ResourceDeletedNotRecorded – The resource was deleted but its configuration was not recorded since the recorder excludes the recording of resources of this type

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ConfigurationItemStatus, ConfigurationItemStatus

configurationStateId

ConfigurationItem.Builder configurationStateId(String configurationStateId)

An identifier that indicates the ordering of the configuration items of a resource.

Parameters:

configurationStateId - An identifier that indicates the ordering of the configuration items of a resource.

Returns:

Returns a reference to this object so that method calls can be chained together.

configurationItemMD5Hash

ConfigurationItem.Builder configurationItemMD5Hash(String configurationItemMD5Hash)

Unique MD5 hash that represents the configuration item's state.

You can use MD5 hash to compare the states of two or more configuration items that are associated with the same resource.

Parameters:

configurationItemMD5Hash - Unique MD5 hash that represents the configuration item's state.

You can use MD5 hash to compare the states of two or more configuration items that are associated with the same resource.

Returns:

Returns a reference to this object so that method calls can be chained together.

arn

ConfigurationItem.Builder arn(String arn)

Amazon Resource Name (ARN) associated with the resource.

Parameters:

arn - Amazon Resource Name (ARN) associated with the resource.

Returns:

Returns a reference to this object so that method calls can be chained together.

resourceType

ConfigurationItem.Builder resourceType(String resourceType)

The type of Amazon Web Services resource.

Parameters:

resourceType - The type of Amazon Web Services resource.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ResourceType, ResourceType

resourceType

ConfigurationItem.Builder resourceType(ResourceType resourceType)

The type of Amazon Web Services resource.

Parameters:

resourceType - The type of Amazon Web Services resource.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ResourceType, ResourceType

resourceId

ConfigurationItem.Builder resourceId(String resourceId)

The ID of the resource (for example, sg-xxxxxx).

Parameters:

resourceId - The ID of the resource (for example, sg-xxxxxx).

Returns:

Returns a reference to this object so that method calls can be chained together.

resourceName

ConfigurationItem.Builder resourceName(String resourceName)

The custom name of the resource, if available.

Parameters:

resourceName - The custom name of the resource, if available.

Returns:

Returns a reference to this object so that method calls can be chained together.

awsRegion

ConfigurationItem.Builder awsRegion(String awsRegion)

The region where the resource resides.

Parameters:

awsRegion - The region where the resource resides.

Returns:

Returns a reference to this object so that method calls can be chained together.

availabilityZone

ConfigurationItem.Builder availabilityZone(String availabilityZone)

The Availability Zone associated with the resource.

Parameters:

availabilityZone - The Availability Zone associated with the resource.

Returns:

Returns a reference to this object so that method calls can be chained together.

resourceCreationTime

ConfigurationItem.Builder resourceCreationTime(Instant resourceCreationTime)

The time stamp when the resource was created.

Parameters:

resourceCreationTime - The time stamp when the resource was created.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

ConfigurationItem.Builder tags(Map<String,String> tags)

A mapping of key value tags associated with the resource.

Parameters:

tags - A mapping of key value tags associated with the resource.

Returns:

Returns a reference to this object so that method calls can be chained together.

relatedEvents

ConfigurationItem.Builder relatedEvents(Collection<String> relatedEvents)

A list of CloudTrail event IDs.

A populated field indicates that the current configuration was initiated by the events recorded in the CloudTrail log. For more information about CloudTrail, see What Is CloudTrail.

An empty field indicates that the current configuration was not initiated by any event. As of Version 1.3, the relatedEvents field is empty. You can access the LookupEvents API in the CloudTrail API Reference to retrieve the events for the resource.

Parameters:

relatedEvents - A list of CloudTrail event IDs.

A populated field indicates that the current configuration was initiated by the events recorded in the CloudTrail log. For more information about CloudTrail, see What Is CloudTrail.

An empty field indicates that the current configuration was not initiated by any event. As of Version 1.3, the relatedEvents field is empty. You can access the LookupEvents API in the CloudTrail API Reference to retrieve the events for the resource.

Returns:

Returns a reference to this object so that method calls can be chained together.

relatedEvents

ConfigurationItem.Builder relatedEvents(String... relatedEvents)

A list of CloudTrail event IDs.

A populated field indicates that the current configuration was initiated by the events recorded in the CloudTrail log. For more information about CloudTrail, see What Is CloudTrail.

An empty field indicates that the current configuration was not initiated by any event. As of Version 1.3, the relatedEvents field is empty. You can access the LookupEvents API in the CloudTrail API Reference to retrieve the events for the resource.

Parameters:

relatedEvents - A list of CloudTrail event IDs.

A populated field indicates that the current configuration was initiated by the events recorded in the CloudTrail log. For more information about CloudTrail, see What Is CloudTrail.

An empty field indicates that the current configuration was not initiated by any event. As of Version 1.3, the relatedEvents field is empty. You can access the LookupEvents API in the CloudTrail API Reference to retrieve the events for the resource.

Returns:

Returns a reference to this object so that method calls can be chained together.

relationships

ConfigurationItem.Builder relationships(Collection<Relationship> relationships)

A list of related Amazon Web Services resources.

Parameters:

relationships - A list of related Amazon Web Services resources.

Returns:

Returns a reference to this object so that method calls can be chained together.

relationships

ConfigurationItem.Builder relationships(Relationship... relationships)

A list of related Amazon Web Services resources.

Parameters:

relationships - A list of related Amazon Web Services resources.

Returns:

Returns a reference to this object so that method calls can be chained together.

relationships

ConfigurationItem.Builder relationships(Consumer<Relationship.Builder>... relationships)

A list of related Amazon Web Services resources.

This is a convenience method that creates an instance of the Relationship.Builder avoiding the need to create one manually via Relationship.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #relationships(List).

Parameters:

relationships - a consumer that will call methods on Relationship.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#relationships(java.util.Collection)

configuration

ConfigurationItem.Builder configuration(String configuration)

The description of the resource configuration.

Parameters:

configuration - The description of the resource configuration.

Returns:

Returns a reference to this object so that method calls can be chained together.

supplementaryConfiguration

ConfigurationItem.Builder supplementaryConfiguration(Map<String,String> supplementaryConfiguration)

Configuration attributes that Config returns for certain resource types to supplement the information returned for the configuration parameter.

Parameters:

supplementaryConfiguration - Configuration attributes that Config returns for certain resource types to supplement the information returned for the configuration parameter.

Returns:

Returns a reference to this object so that method calls can be chained together.