Package software.amazon.awssdk.services.fms.model

Interface ResourceSet.Builder

    • Method Detail

      • id

        ResourceSet.Builder id​(String id)

        A unique identifier for the resource set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

        Parameters:
        id - A unique identifier for the resource set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • name

        ResourceSet.Builder name​(String name)

        The descriptive name of the resource set. You can't change the name of a resource set after you create it.

        Parameters:
        name - The descriptive name of the resource set. You can't change the name of a resource set after you create it.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • description

        ResourceSet.Builder description​(String description)

        A description of the resource set.

        Parameters:
        description - A description of the resource set.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • updateToken

        ResourceSet.Builder updateToken​(String updateToken)

        An optional token that you can use for optimistic locking. Firewall Manager returns a token to your requests that access the resource set. The token marks the state of the resource set resource at the time of the request. Update tokens are not allowed when creating a resource set. After creation, each subsequent update call to the resource set requires the update token.

        To make an unconditional change to the resource set, omit the token in your update request. Without the token, Firewall Manager performs your updates regardless of whether the resource set has changed since you last retrieved it.

        To make a conditional change to the resource set, provide the token in your update request. Firewall Manager uses the token to ensure that the resource set hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the resource set again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

        Parameters:
        updateToken - An optional token that you can use for optimistic locking. Firewall Manager returns a token to your requests that access the resource set. The token marks the state of the resource set resource at the time of the request. Update tokens are not allowed when creating a resource set. After creation, each subsequent update call to the resource set requires the update token.

        To make an unconditional change to the resource set, omit the token in your update request. Without the token, Firewall Manager performs your updates regardless of whether the resource set has changed since you last retrieved it.

        To make a conditional change to the resource set, provide the token in your update request. Firewall Manager uses the token to ensure that the resource set hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the resource set again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

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

      • resourceTypeList

        ResourceSet.Builder resourceTypeList​(Collection<String> resourceTypeList)

        Determines the resources that can be associated to the resource set. Depending on your setting for max results and the number of resource sets, a single call might not return the full list.

        Parameters:
        resourceTypeList - Determines the resources that can be associated to the resource set. Depending on your setting for max results and the number of resource sets, a single call might not return the full list.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • resourceTypeList

        ResourceSet.Builder resourceTypeList​(String... resourceTypeList)

        Determines the resources that can be associated to the resource set. Depending on your setting for max results and the number of resource sets, a single call might not return the full list.

        Parameters:
        resourceTypeList - Determines the resources that can be associated to the resource set. Depending on your setting for max results and the number of resource sets, a single call might not return the full list.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • lastUpdateTime

        ResourceSet.Builder lastUpdateTime​(Instant lastUpdateTime)

        The last time that the resource set was changed.

        Parameters:
        lastUpdateTime - The last time that the resource set was changed.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • resourceSetStatus

        ResourceSet.Builder resourceSetStatus​(String resourceSetStatus)

        Indicates whether the resource set is in or out of an admin's Region scope.

        • ACTIVE - The administrator can manage and delete the resource set.

        • OUT_OF_ADMIN_SCOPE - The administrator can view the resource set, but they can't edit or delete the resource set. Existing protections stay in place. Any new resource that come into scope of the resource set won't be protected.

        Parameters:
        resourceSetStatus - Indicates whether the resource set is in or out of an admin's Region scope.

        • ACTIVE - The administrator can manage and delete the resource set.

        • OUT_OF_ADMIN_SCOPE - The administrator can view the resource set, but they can't edit or delete the resource set. Existing protections stay in place. Any new resource that come into scope of the resource set won't be protected.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ResourceSetStatus, ResourceSetStatus

      • resourceSetStatus

        ResourceSet.Builder resourceSetStatus​(ResourceSetStatus resourceSetStatus)

        Indicates whether the resource set is in or out of an admin's Region scope.

        • ACTIVE - The administrator can manage and delete the resource set.

        • OUT_OF_ADMIN_SCOPE - The administrator can view the resource set, but they can't edit or delete the resource set. Existing protections stay in place. Any new resource that come into scope of the resource set won't be protected.

        Parameters:
        resourceSetStatus - Indicates whether the resource set is in or out of an admin's Region scope.

        • ACTIVE - The administrator can manage and delete the resource set.

        • OUT_OF_ADMIN_SCOPE - The administrator can view the resource set, but they can't edit or delete the resource set. Existing protections stay in place. Any new resource that come into scope of the resource set won't be protected.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ResourceSetStatus, ResourceSetStatus