Interface StorageTransferJobConfig

  • All Superinterfaces:
    software.amazon.jsii.JsiiSerializable, com.hashicorp.cdktf.TerraformMetaArguments
    All Known Implementing Classes:
    StorageTransferJobConfig.Jsii$Proxy

    @Generated(value="jsii-pacmak/1.102.0 (build e354887)",
               date="2024-08-31T03:59:22.879Z")
    @Stability(Stable)
    public interface StorageTransferJobConfig
    extends software.amazon.jsii.JsiiSerializable, com.hashicorp.cdktf.TerraformMetaArguments
    • Method Detail

      • getDescription

        @Stability(Stable)
        @NotNull
        String getDescription()
        Unique description to identify the Transfer Job.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_transfer_job#description StorageTransferJob#description}

      • getTransferSpec

        @Stability(Stable)
        @NotNull
        StorageTransferJobTransferSpec getTransferSpec()
        transfer_spec block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_transfer_job#transfer_spec StorageTransferJob#transfer_spec}

      • getEventStream

        @Stability(Stable)
        @Nullable
        default StorageTransferJobEventStream getEventStream()
        event_stream block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_transfer_job#event_stream StorageTransferJob#event_stream}

      • getId

        @Stability(Stable)
        @Nullable
        default String getId()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_transfer_job#id StorageTransferJob#id}.

        Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

      • getName

        @Stability(Stable)
        @Nullable
        default String getName()
        The name of the Transfer Job.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_transfer_job#name StorageTransferJob#name}

      • getNotificationConfig

        @Stability(Stable)
        @Nullable
        default StorageTransferJobNotificationConfig getNotificationConfig()
        notification_config block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_transfer_job#notification_config StorageTransferJob#notification_config}

      • getProject

        @Stability(Stable)
        @Nullable
        default String getProject()
        The project in which the resource belongs. If it is not provided, the provider project is used.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_transfer_job#project StorageTransferJob#project}

      • getSchedule

        @Stability(Stable)
        @Nullable
        default StorageTransferJobSchedule getSchedule()
        schedule block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_transfer_job#schedule StorageTransferJob#schedule}

      • getStatus

        @Stability(Stable)
        @Nullable
        default String getStatus()
        Status of the job.

        Default: ENABLED. NOTE: The effect of the new job status takes place during a subsequent job run. For example, if you change the job status from ENABLED to DISABLED, and an operation spawned by the transfer is running, the status change would not affect the current operation. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_transfer_job#status StorageTransferJob#status}