Package software.amazon.awssdk.services.codepipeline.model

Interface ActionConfigurationProperty.Builder

    • Method Detail

      • name

        ActionConfigurationProperty.Builder name​(String name)

        The name of the action configuration property.

        Parameters:
        name - The name of the action configuration property.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • required

        ActionConfigurationProperty.Builder required​(Boolean required)

        Whether the configuration property is a required value.

        Parameters:
        required - Whether the configuration property is a required value.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • key

        ActionConfigurationProperty.Builder key​(Boolean key)

        Whether the configuration property is a key.

        Parameters:
        key - Whether the configuration property is a key.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • secret

        ActionConfigurationProperty.Builder secret​(Boolean secret)

        Whether the configuration property is secret. Secrets are hidden from all calls except for GetJobDetails, GetThirdPartyJobDetails, PollForJobs, and PollForThirdPartyJobs.

        When updating a pipeline, passing * * * * * without changing any other values of the action preserves the previous value of the secret.

        Parameters:
        secret - Whether the configuration property is secret. Secrets are hidden from all calls except for GetJobDetails, GetThirdPartyJobDetails, PollForJobs, and PollForThirdPartyJobs.

        When updating a pipeline, passing * * * * * without changing any other values of the action preserves the previous value of the secret.

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

      • queryable

        ActionConfigurationProperty.Builder queryable​(Boolean queryable)

        Indicates that the property is used with PollForJobs. When creating a custom action, an action can have up to one queryable property. If it has one, that property must be both required and not secret.

        If you create a pipeline with a custom action type, and that custom action contains a queryable property, the value for that configuration property is subject to other restrictions. The value must be less than or equal to twenty (20) characters. The value can contain only alphanumeric characters, underscores, and hyphens.

        Parameters:
        queryable - Indicates that the property is used with PollForJobs. When creating a custom action, an action can have up to one queryable property. If it has one, that property must be both required and not secret.

        If you create a pipeline with a custom action type, and that custom action contains a queryable property, the value for that configuration property is subject to other restrictions. The value must be less than or equal to twenty (20) characters. The value can contain only alphanumeric characters, underscores, and hyphens.

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

      • description

        ActionConfigurationProperty.Builder description​(String description)

        The description of the action configuration property that is displayed to users.

        Parameters:
        description - The description of the action configuration property that is displayed to users.
        Returns:
        Returns a reference to this object so that method calls can be chained together.