TransferJob
Creates a new Transfer Job in Google Cloud Storage Transfer.
To get more information about Google Cloud Storage Transfer, see:
Create a TransferJob Resource
new TransferJob(name: string, args: TransferJobArgs, opts?: CustomResourceOptions);def TransferJob(resource_name, opts=None, description=None, project=None, schedule=None, status=None, transfer_spec=None, __props__=None);func NewTransferJob(ctx *Context, name string, args TransferJobArgs, opts ...ResourceOption) (*TransferJob, error)public TransferJob(string name, TransferJobArgs args, CustomResourceOptions? opts = null)- name string
- The unique name of the resource.
- args TransferJobArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- opts ResourceOptions
- A bag of options that control this resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args TransferJobArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args TransferJobArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
TransferJob Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.
Inputs
The TransferJob resource accepts the following input properties:
- Description string
Unique description to identify the Transfer Job.
- Schedule
Transfer
Job Schedule Args Schedule specification defining when the Transfer Job should be scheduled to start, end and and what time to run. Structure documented below.
- Transfer
Spec TransferJob Transfer Spec Args Transfer specification. Structure documented below.
- Project string
The project in which the resource belongs. If it is not provided, the provider project is used.
- Status string
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.
- Description string
Unique description to identify the Transfer Job.
- Schedule
Transfer
Job Schedule Schedule specification defining when the Transfer Job should be scheduled to start, end and and what time to run. Structure documented below.
- Transfer
Spec TransferJob Transfer Spec Transfer specification. Structure documented below.
- Project string
The project in which the resource belongs. If it is not provided, the provider project is used.
- Status string
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.
- description string
Unique description to identify the Transfer Job.
- schedule
Transfer
Job Schedule Schedule specification defining when the Transfer Job should be scheduled to start, end and and what time to run. Structure documented below.
- transfer
Spec TransferJob Transfer Spec Transfer specification. Structure documented below.
- project string
The project in which the resource belongs. If it is not provided, the provider project is used.
- status string
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.
- description str
Unique description to identify the Transfer Job.
- schedule
Dict[Transfer
Job Schedule] Schedule specification defining when the Transfer Job should be scheduled to start, end and and what time to run. Structure documented below.
- transfer_
spec Dict[TransferJob Transfer Spec] Transfer specification. Structure documented below.
- project str
The project in which the resource belongs. If it is not provided, the provider project is used.
- status str
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.
Outputs
All input properties are implicitly available as output properties. Additionally, the TransferJob resource produces the following output properties:
- Creation
Time string When the Transfer Job was created.
- Deletion
Time string When the Transfer Job was deleted.
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Modification stringTime When the Transfer Job was last modified.
- Name string
The name of the Transfer Job.
- Creation
Time string When the Transfer Job was created.
- Deletion
Time string When the Transfer Job was deleted.
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Modification stringTime When the Transfer Job was last modified.
- Name string
The name of the Transfer Job.
- creation
Time string When the Transfer Job was created.
- deletion
Time string When the Transfer Job was deleted.
- id string
- The provider-assigned unique ID for this managed resource.
- last
Modification stringTime When the Transfer Job was last modified.
- name string
The name of the Transfer Job.
- creation_
time str When the Transfer Job was created.
- deletion_
time str When the Transfer Job was deleted.
- id str
- The provider-assigned unique ID for this managed resource.
- last_
modification_ strtime When the Transfer Job was last modified.
- name str
The name of the Transfer Job.
Look up an Existing TransferJob Resource
Get an existing TransferJob resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: TransferJobState, opts?: CustomResourceOptions): TransferJobstatic get(resource_name, id, opts=None, creation_time=None, deletion_time=None, description=None, last_modification_time=None, name=None, project=None, schedule=None, status=None, transfer_spec=None, __props__=None);func GetTransferJob(ctx *Context, name string, id IDInput, state *TransferJobState, opts ...ResourceOption) (*TransferJob, error)public static TransferJob Get(string name, Input<string> id, TransferJobState? state, CustomResourceOptions? opts = null)- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
The following state arguments are supported:
- Creation
Time string When the Transfer Job was created.
- Deletion
Time string When the Transfer Job was deleted.
- Description string
Unique description to identify the Transfer Job.
- Last
Modification stringTime When the Transfer Job was last modified.
- Name string
The name of the Transfer Job.
- Project string
The project in which the resource belongs. If it is not provided, the provider project is used.
- Schedule
Transfer
Job Schedule Args Schedule specification defining when the Transfer Job should be scheduled to start, end and and what time to run. Structure documented below.
- Status string
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.- Transfer
Spec TransferJob Transfer Spec Args Transfer specification. Structure documented below.
- Creation
Time string When the Transfer Job was created.
- Deletion
Time string When the Transfer Job was deleted.
- Description string
Unique description to identify the Transfer Job.
- Last
Modification stringTime When the Transfer Job was last modified.
- Name string
The name of the Transfer Job.
- Project string
The project in which the resource belongs. If it is not provided, the provider project is used.
- Schedule
Transfer
Job Schedule Schedule specification defining when the Transfer Job should be scheduled to start, end and and what time to run. Structure documented below.
- Status string
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.- Transfer
Spec TransferJob Transfer Spec Transfer specification. Structure documented below.
- creation
Time string When the Transfer Job was created.
- deletion
Time string When the Transfer Job was deleted.
- description string
Unique description to identify the Transfer Job.
- last
Modification stringTime When the Transfer Job was last modified.
- name string
The name of the Transfer Job.
- project string
The project in which the resource belongs. If it is not provided, the provider project is used.
- schedule
Transfer
Job Schedule Schedule specification defining when the Transfer Job should be scheduled to start, end and and what time to run. Structure documented below.
- status string
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.- transfer
Spec TransferJob Transfer Spec Transfer specification. Structure documented below.
- creation_
time str When the Transfer Job was created.
- deletion_
time str When the Transfer Job was deleted.
- description str
Unique description to identify the Transfer Job.
- last_
modification_ strtime When the Transfer Job was last modified.
- name str
The name of the Transfer Job.
- project str
The project in which the resource belongs. If it is not provided, the provider project is used.
- schedule
Dict[Transfer
Job Schedule] Schedule specification defining when the Transfer Job should be scheduled to start, end and and what time to run. Structure documented below.
- status str
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.- transfer_
spec Dict[TransferJob Transfer Spec] Transfer specification. Structure documented below.
Supporting Types
TransferJobSchedule
- Schedule
Start TransferDate Job Schedule Schedule Start Date Args The first day the recurring transfer is scheduled to run. If
schedule_start_dateis in the past, the transfer will run for the first time on the following day. Structure documented below.- Schedule
End TransferDate Job Schedule Schedule End Date Args The last day the recurring transfer will be run. If
schedule_end_dateis the same asschedule_start_date, the transfer will be executed only once. Structure documented below.- Start
Time TransferOf Day Job Schedule Start Time Of Day Args The time in UTC at which the transfer will be scheduled to start in a day. Transfers may start later than this time. If not specified, recurring and one-time transfers that are scheduled to run today will run immediately; recurring transfers that are scheduled to run on a future date will start at approximately midnight UTC on that date. Note that when configuring a transfer with the Cloud Platform Console, the transfer’s start time in a day is specified in your local timezone. Structure documented below.
- Schedule
Start TransferDate Job Schedule Schedule Start Date The first day the recurring transfer is scheduled to run. If
schedule_start_dateis in the past, the transfer will run for the first time on the following day. Structure documented below.- Schedule
End TransferDate Job Schedule Schedule End Date The last day the recurring transfer will be run. If
schedule_end_dateis the same asschedule_start_date, the transfer will be executed only once. Structure documented below.- Start
Time TransferOf Day Job Schedule Start Time Of Day The time in UTC at which the transfer will be scheduled to start in a day. Transfers may start later than this time. If not specified, recurring and one-time transfers that are scheduled to run today will run immediately; recurring transfers that are scheduled to run on a future date will start at approximately midnight UTC on that date. Note that when configuring a transfer with the Cloud Platform Console, the transfer’s start time in a day is specified in your local timezone. Structure documented below.
- schedule
Start TransferDate Job Schedule Schedule Start Date The first day the recurring transfer is scheduled to run. If
schedule_start_dateis in the past, the transfer will run for the first time on the following day. Structure documented below.- schedule
End TransferDate Job Schedule Schedule End Date The last day the recurring transfer will be run. If
schedule_end_dateis the same asschedule_start_date, the transfer will be executed only once. Structure documented below.- start
Time TransferOf Day Job Schedule Start Time Of Day The time in UTC at which the transfer will be scheduled to start in a day. Transfers may start later than this time. If not specified, recurring and one-time transfers that are scheduled to run today will run immediately; recurring transfers that are scheduled to run on a future date will start at approximately midnight UTC on that date. Note that when configuring a transfer with the Cloud Platform Console, the transfer’s start time in a day is specified in your local timezone. Structure documented below.
- schedule
Start Dict[TransferDate Job Schedule Schedule Start Date] The first day the recurring transfer is scheduled to run. If
schedule_start_dateis in the past, the transfer will run for the first time on the following day. Structure documented below.- schedule
End Dict[TransferDate Job Schedule Schedule End Date] The last day the recurring transfer will be run. If
schedule_end_dateis the same asschedule_start_date, the transfer will be executed only once. Structure documented below.- start
Time Dict[TransferOf Day Job Schedule Start Time Of Day] The time in UTC at which the transfer will be scheduled to start in a day. Transfers may start later than this time. If not specified, recurring and one-time transfers that are scheduled to run today will run immediately; recurring transfers that are scheduled to run on a future date will start at approximately midnight UTC on that date. Note that when configuring a transfer with the Cloud Platform Console, the transfer’s start time in a day is specified in your local timezone. Structure documented below.
TransferJobScheduleScheduleEndDate
TransferJobScheduleScheduleStartDate
TransferJobScheduleStartTimeOfDay
TransferJobTransferSpec
- Aws
S3Data TransferSource Job Transfer Spec Aws S3Data Source Args An AWS S3 data source. Structure documented below.
- Gcs
Data TransferSink Job Transfer Spec Gcs Data Sink Args A Google Cloud Storage data sink. Structure documented below.
- Gcs
Data TransferSource Job Transfer Spec Gcs Data Source Args A Google Cloud Storage data source. Structure documented below.
- Http
Data TransferSource Job Transfer Spec Http Data Source Args An HTTP URL data source. Structure documented below.
- Object
Conditions TransferJob Transfer Spec Object Conditions Args Only objects that satisfy these object conditions are included in the set of data source and data sink objects. Object conditions based on objects’
last_modification_timedo not exclude objects in a data sink. Structure documented below.- Transfer
Options TransferJob Transfer Spec Transfer Options Args Characteristics of how to treat files from datasource and sink during job. If the option
delete_objects_unique_in_sinkis true, object conditions based on objects’last_modification_timeare ignored and do not exclude objects in a data source or a data sink. Structure documented below.
- Aws
S3Data TransferSource Job Transfer Spec Aws S3Data Source An AWS S3 data source. Structure documented below.
- Gcs
Data TransferSink Job Transfer Spec Gcs Data Sink A Google Cloud Storage data sink. Structure documented below.
- Gcs
Data TransferSource Job Transfer Spec Gcs Data Source A Google Cloud Storage data source. Structure documented below.
- Http
Data TransferSource Job Transfer Spec Http Data Source An HTTP URL data source. Structure documented below.
- Object
Conditions TransferJob Transfer Spec Object Conditions Only objects that satisfy these object conditions are included in the set of data source and data sink objects. Object conditions based on objects’
last_modification_timedo not exclude objects in a data sink. Structure documented below.- Transfer
Options TransferJob Transfer Spec Transfer Options Characteristics of how to treat files from datasource and sink during job. If the option
delete_objects_unique_in_sinkis true, object conditions based on objects’last_modification_timeare ignored and do not exclude objects in a data source or a data sink. Structure documented below.
- aws
S3Data TransferSource Job Transfer Spec Aws S3Data Source An AWS S3 data source. Structure documented below.
- gcs
Data TransferSink Job Transfer Spec Gcs Data Sink A Google Cloud Storage data sink. Structure documented below.
- gcs
Data TransferSource Job Transfer Spec Gcs Data Source A Google Cloud Storage data source. Structure documented below.
- http
Data TransferSource Job Transfer Spec Http Data Source An HTTP URL data source. Structure documented below.
- object
Conditions TransferJob Transfer Spec Object Conditions Only objects that satisfy these object conditions are included in the set of data source and data sink objects. Object conditions based on objects’
last_modification_timedo not exclude objects in a data sink. Structure documented below.- transfer
Options TransferJob Transfer Spec Transfer Options Characteristics of how to treat files from datasource and sink during job. If the option
delete_objects_unique_in_sinkis true, object conditions based on objects’last_modification_timeare ignored and do not exclude objects in a data source or a data sink. Structure documented below.
- aws
S3Data Dict[TransferSource Job Transfer Spec Aws S3Data Source] An AWS S3 data source. Structure documented below.
- gcs
Data Dict[TransferSink Job Transfer Spec Gcs Data Sink] A Google Cloud Storage data sink. Structure documented below.
- gcs
Data Dict[TransferSource Job Transfer Spec Gcs Data Source] A Google Cloud Storage data source. Structure documented below.
- http
Data Dict[TransferSource Job Transfer Spec Http Data Source] An HTTP URL data source. Structure documented below.
- object
Conditions Dict[TransferJob Transfer Spec Object Conditions] Only objects that satisfy these object conditions are included in the set of data source and data sink objects. Object conditions based on objects’
last_modification_timedo not exclude objects in a data sink. Structure documented below.- transfer
Options Dict[TransferJob Transfer Spec Transfer Options] Characteristics of how to treat files from datasource and sink during job. If the option
delete_objects_unique_in_sinkis true, object conditions based on objects’last_modification_timeare ignored and do not exclude objects in a data source or a data sink. Structure documented below.
TransferJobTransferSpecAwsS3DataSource
- Aws
Access TransferKey Job Transfer Spec Aws S3Data Source Aws Access Key Args AWS credentials block.
- Bucket
Name string S3 Bucket name.
- Aws
Access TransferKey Job Transfer Spec Aws S3Data Source Aws Access Key AWS credentials block.
- Bucket
Name string S3 Bucket name.
- aws
Access TransferKey Job Transfer Spec Aws S3Data Source Aws Access Key AWS credentials block.
- bucket
Name string S3 Bucket name.
- aws
Access Dict[TransferKey Job Transfer Spec Aws S3Data Source Aws Access Key] AWS credentials block.
- bucket_
name str S3 Bucket name.
TransferJobTransferSpecAwsS3DataSourceAwsAccessKey
- Access
Key stringId AWS Key ID.
- Secret
Access stringKey AWS Secret Access Key.
- Access
Key stringId AWS Key ID.
- Secret
Access stringKey AWS Secret Access Key.
- access
Key stringId AWS Key ID.
- secret
Access stringKey AWS Secret Access Key.
- access
Key strId AWS Key ID.
- secret
Access strKey AWS Secret Access Key.
TransferJobTransferSpecGcsDataSink
- Bucket
Name string S3 Bucket name.
- Bucket
Name string S3 Bucket name.
- bucket
Name string S3 Bucket name.
- bucket_
name str S3 Bucket name.
TransferJobTransferSpecGcsDataSource
- Bucket
Name string S3 Bucket name.
- Bucket
Name string S3 Bucket name.
- bucket
Name string S3 Bucket name.
- bucket_
name str S3 Bucket name.
TransferJobTransferSpecHttpDataSource
TransferJobTransferSpecObjectConditions
- Exclude
Prefixes List<string> exclude_prefixesmust follow the requirements described forinclude_prefixes. See Requirements.- Include
Prefixes List<string> If
include_refixesis specified, objects that satisfy the object conditions must have names that start with one of theinclude_prefixesand that do not start with any of theexclude_prefixes. Ifinclude_prefixesis not specified, all objects except those that have names starting with one of theexclude_prefixesmust satisfy the object conditions. See Requirements.- Max
Time stringElapsed Since Last Modification A duration in seconds with up to nine fractional digits, terminated by ’s’. Example: “3.5s”.
- Min
Time stringElapsed Since Last Modification A duration in seconds with up to nine fractional digits, terminated by ’s’. Example: “3.5s”.
- Exclude
Prefixes []string exclude_prefixesmust follow the requirements described forinclude_prefixes. See Requirements.- Include
Prefixes []string If
include_refixesis specified, objects that satisfy the object conditions must have names that start with one of theinclude_prefixesand that do not start with any of theexclude_prefixes. Ifinclude_prefixesis not specified, all objects except those that have names starting with one of theexclude_prefixesmust satisfy the object conditions. See Requirements.- Max
Time stringElapsed Since Last Modification A duration in seconds with up to nine fractional digits, terminated by ’s’. Example: “3.5s”.
- Min
Time stringElapsed Since Last Modification A duration in seconds with up to nine fractional digits, terminated by ’s’. Example: “3.5s”.
- exclude
Prefixes string[] exclude_prefixesmust follow the requirements described forinclude_prefixes. See Requirements.- include
Prefixes string[] If
include_refixesis specified, objects that satisfy the object conditions must have names that start with one of theinclude_prefixesand that do not start with any of theexclude_prefixes. Ifinclude_prefixesis not specified, all objects except those that have names starting with one of theexclude_prefixesmust satisfy the object conditions. See Requirements.- max
Time stringElapsed Since Last Modification A duration in seconds with up to nine fractional digits, terminated by ’s’. Example: “3.5s”.
- min
Time stringElapsed Since Last Modification A duration in seconds with up to nine fractional digits, terminated by ’s’. Example: “3.5s”.
- exclude
Prefixes List[str] exclude_prefixesmust follow the requirements described forinclude_prefixes. See Requirements.- include
Prefixes List[str] If
include_refixesis specified, objects that satisfy the object conditions must have names that start with one of theinclude_prefixesand that do not start with any of theexclude_prefixes. Ifinclude_prefixesis not specified, all objects except those that have names starting with one of theexclude_prefixesmust satisfy the object conditions. See Requirements.- max
Time strElapsed Since Last Modification A duration in seconds with up to nine fractional digits, terminated by ’s’. Example: “3.5s”.
- min
Time strElapsed Since Last Modification A duration in seconds with up to nine fractional digits, terminated by ’s’. Example: “3.5s”.
TransferJobTransferSpecTransferOptions
- Delete
Objects boolFrom Source After Transfer Whether objects should be deleted from the source after they are transferred to the sink. Note that this option and
delete_objects_unique_in_sinkare mutually exclusive.- Delete
Objects boolUnique In Sink Whether objects that exist only in the sink should be deleted. Note that this option and
delete_objects_from_source_after_transferare mutually exclusive.- Overwrite
Objects boolAlready Existing In Sink Whether overwriting objects that already exist in the sink is allowed.
- Delete
Objects boolFrom Source After Transfer Whether objects should be deleted from the source after they are transferred to the sink. Note that this option and
delete_objects_unique_in_sinkare mutually exclusive.- Delete
Objects boolUnique In Sink Whether objects that exist only in the sink should be deleted. Note that this option and
delete_objects_from_source_after_transferare mutually exclusive.- Overwrite
Objects boolAlready Existing In Sink Whether overwriting objects that already exist in the sink is allowed.
- delete
Objects booleanFrom Source After Transfer Whether objects should be deleted from the source after they are transferred to the sink. Note that this option and
delete_objects_unique_in_sinkare mutually exclusive.- delete
Objects booleanUnique In Sink Whether objects that exist only in the sink should be deleted. Note that this option and
delete_objects_from_source_after_transferare mutually exclusive.- overwrite
Objects booleanAlready Existing In Sink Whether overwriting objects that already exist in the sink is allowed.
- delete
Objects boolFrom Source After Transfer Whether objects should be deleted from the source after they are transferred to the sink. Note that this option and
delete_objects_unique_in_sinkare mutually exclusive.- delete
Objects boolUnique In Sink Whether objects that exist only in the sink should be deleted. Note that this option and
delete_objects_from_source_after_transferare mutually exclusive.- overwrite
Objects boolAlready Existing In Sink Whether overwriting objects that already exist in the sink is allowed.
Package Details
- Repository
- https://github.com/pulumi/pulumi-gcp
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
google-betaTerraform Provider.