Package com.pulumi.aws.pipes.inputs

Class PipeState

  • public final class PipeState
extends com.pulumi.resources.ResourceArgs

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  PipeState.Builder  

      • Nested classes/interfaces inherited from class com.pulumi.resources.InputArgs

        com.pulumi.resources.InputArgs.InputArgsInternal

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static PipeState Empty  

    • Field Detail

    • Method Detail

      • arn

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> arn()
        Returns:
        ARN of this pipe.

      • description

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> description()
        Returns:
        Description of the pipe. At most 512 characters.

      • desiredState

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> desiredState()
        Returns:
        State the pipe should be in. One of: `RUNNING`, `STOPPED`.

      • enrichment

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> enrichment()
        Returns:
        Enrichment resource of the pipe (typically an ARN). Read more about enrichment in the [User Guide](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html#pipes-enrichment).

      • enrichmentParameters

        public java.util.Optional<com.pulumi.core.Output<PipeEnrichmentParametersArgs>> enrichmentParameters()
        Returns:
        Parameters to configure enrichment for the pipe. See `enrichmentParameters` Block for details.

      • kmsKeyIdentifier

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> kmsKeyIdentifier()
        Returns:
        Identifier of the AWS KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt pipe data. The identifier can be the key ARN, KeyId, key alias, or key alias ARN. If not set, EventBridge uses an AWS owned key to encrypt pipe data.

      • logConfiguration

        public java.util.Optional<com.pulumi.core.Output<PipeLogConfigurationArgs>> logConfiguration()
        Returns:
        Logging configuration settings for the pipe. See `logConfiguration` Block for details.

      • name

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> name()
        Returns:
        Name of the pipe. If omitted, the provider will assign a random, unique name. Conflicts with `namePrefix`.

      • namePrefix

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> namePrefix()
        Returns:
        Creates a unique name beginning with the specified prefix. Conflicts with `name`.

      • region

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • roleArn

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> roleArn()
        Returns:
        ARN of the role that allows the pipe to send data to the target.

      • source

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> source()
        Returns:
        Source resource of the pipe. This field typically requires an ARN. However, when using a self-managed Kafka cluster, you should use a different format. Instead of an ARN, use 'smk://' followed by the bootstrap server's address.

      • sourceParameters

        public java.util.Optional<com.pulumi.core.Output<PipeSourceParametersArgs>> sourceParameters()
        Returns:
        Parameters to configure a source for the pipe. See `sourceParameters` Block for details.

      • tags

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Map of tags assigned to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • tagsAll

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tagsAll()
        Returns:
        Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • target

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> target()
        Returns:
        Target resource of the pipe (typically an ARN). The following arguments are optional:

      • targetParameters

        public java.util.Optional<com.pulumi.core.Output<PipeTargetParametersArgs>> targetParameters()
        Returns:
        Parameters to configure a target for the pipe. See `targetParameters` Block for details.