Package software.amazon.awssdk.services.ecs.model

Interface ListAccountSettingsRequest.Builder

    • Method Detail

      • name

        ListAccountSettingsRequest.Builder name​(String name)

        The name of the account setting you want to list the settings for.

        Parameters:
        name - The name of the account setting you want to list the settings for.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        SettingName, SettingName

      • name

        ListAccountSettingsRequest.Builder name​(SettingName name)

        The name of the account setting you want to list the settings for.

        Parameters:
        name - The name of the account setting you want to list the settings for.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        SettingName, SettingName

      • value

        ListAccountSettingsRequest.Builder value​(String value)

        The value of the account settings to filter results with. You must also specify an account setting name to use this parameter.

        Parameters:
        value - The value of the account settings to filter results with. You must also specify an account setting name to use this parameter.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • principalArn

        ListAccountSettingsRequest.Builder principalArn​(String principalArn)

        The ARN of the principal, which can be a user, role, or the root user. If this field is omitted, the account settings are listed only for the authenticated user.

        Federated users assume the account setting of the root user and can't have explicit account settings set for them.

        Parameters:
        principalArn - The ARN of the principal, which can be a user, role, or the root user. If this field is omitted, the account settings are listed only for the authenticated user.

        Federated users assume the account setting of the root user and can't have explicit account settings set for them.

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

      • effectiveSettings

        ListAccountSettingsRequest.Builder effectiveSettings​(Boolean effectiveSettings)

        Determines whether to return the effective settings. If true, the account settings for the root user or the default setting for the principalArn are returned. If false, the account settings for the principalArn are returned if they're set. Otherwise, no account settings are returned.

        Parameters:
        effectiveSettings - Determines whether to return the effective settings. If true, the account settings for the root user or the default setting for the principalArn are returned. If false, the account settings for the principalArn are returned if they're set. Otherwise, no account settings are returned.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • nextToken

        ListAccountSettingsRequest.Builder nextToken​(String nextToken)

        The nextToken value returned from a ListAccountSettings request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it's possible the number of results to be fewer than maxResults.

        This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

        Parameters:
        nextToken - The nextToken value returned from a ListAccountSettings request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it's possible the number of results to be fewer than maxResults.

        This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

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

      • maxResults

        ListAccountSettingsRequest.Builder maxResults​(Integer maxResults)

        The maximum number of account setting results returned by ListAccountSettings in paginated output. When this parameter is used, ListAccountSettings only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListAccountSettings request with the returned nextToken value. This value can be between 1 and 10. If this parameter isn't used, then ListAccountSettings returns up to 10 results and a nextToken value if applicable.

        Parameters:
        maxResults - The maximum number of account setting results returned by ListAccountSettings in paginated output. When this parameter is used, ListAccountSettings only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListAccountSettings request with the returned nextToken value. This value can be between 1 and 10. If this parameter isn't used, then ListAccountSettings returns up to 10 results and a nextToken value if applicable.
        Returns:
        Returns a reference to this object so that method calls can be chained together.