1. Packages
  2. Ibm Provider
  3. API Docs
  4. CisLogpushJob
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

ibm.CisLogpushJob

Explore with Pulumi AI

ibm logo
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

    Create CisLogpushJob Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new CisLogpushJob(name: string, args: CisLogpushJobArgs, opts?: CustomResourceOptions);
    @overload
    def CisLogpushJob(resource_name: str,
                      args: CisLogpushJobArgs,
                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def CisLogpushJob(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      dataset: Optional[str] = None,
                      cis_id: Optional[str] = None,
                      domain_id: Optional[str] = None,
                      enabled: Optional[bool] = None,
                      destination_conf: Optional[str] = None,
                      cos: Optional[str] = None,
                      cis_logpush_job_id: Optional[str] = None,
                      frequency: Optional[str] = None,
                      ibmcl: Optional[CisLogpushJobIbmclArgs] = None,
                      logdna: Optional[str] = None,
                      logpull_options: Optional[str] = None,
                      name: Optional[str] = None,
                      ownership_challenge: Optional[str] = None)
    func NewCisLogpushJob(ctx *Context, name string, args CisLogpushJobArgs, opts ...ResourceOption) (*CisLogpushJob, error)
    public CisLogpushJob(string name, CisLogpushJobArgs args, CustomResourceOptions? opts = null)
    public CisLogpushJob(String name, CisLogpushJobArgs args)
    public CisLogpushJob(String name, CisLogpushJobArgs args, CustomResourceOptions options)
    
    type: ibm:CisLogpushJob
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args CisLogpushJobArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args CisLogpushJobArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args CisLogpushJobArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CisLogpushJobArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CisLogpushJobArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var cisLogpushJobResource = new Ibm.CisLogpushJob("cisLogpushJobResource", new()
    {
        Dataset = "string",
        CisId = "string",
        DomainId = "string",
        Enabled = false,
        DestinationConf = "string",
        Cos = "string",
        CisLogpushJobId = "string",
        Frequency = "string",
        Ibmcl = new Ibm.Inputs.CisLogpushJobIbmclArgs
        {
            InstanceId = "string",
            ApiKey = "string",
            Region = "string",
        },
        Logdna = "string",
        LogpullOptions = "string",
        Name = "string",
        OwnershipChallenge = "string",
    });
    
    example, err := ibm.NewCisLogpushJob(ctx, "cisLogpushJobResource", &ibm.CisLogpushJobArgs{
    	Dataset:         pulumi.String("string"),
    	CisId:           pulumi.String("string"),
    	DomainId:        pulumi.String("string"),
    	Enabled:         pulumi.Bool(false),
    	DestinationConf: pulumi.String("string"),
    	Cos:             pulumi.String("string"),
    	CisLogpushJobId: pulumi.String("string"),
    	Frequency:       pulumi.String("string"),
    	Ibmcl: &ibm.CisLogpushJobIbmclArgs{
    		InstanceId: pulumi.String("string"),
    		ApiKey:     pulumi.String("string"),
    		Region:     pulumi.String("string"),
    	},
    	Logdna:             pulumi.String("string"),
    	LogpullOptions:     pulumi.String("string"),
    	Name:               pulumi.String("string"),
    	OwnershipChallenge: pulumi.String("string"),
    })
    
    var cisLogpushJobResource = new CisLogpushJob("cisLogpushJobResource", CisLogpushJobArgs.builder()
        .dataset("string")
        .cisId("string")
        .domainId("string")
        .enabled(false)
        .destinationConf("string")
        .cos("string")
        .cisLogpushJobId("string")
        .frequency("string")
        .ibmcl(CisLogpushJobIbmclArgs.builder()
            .instanceId("string")
            .apiKey("string")
            .region("string")
            .build())
        .logdna("string")
        .logpullOptions("string")
        .name("string")
        .ownershipChallenge("string")
        .build());
    
    cis_logpush_job_resource = ibm.CisLogpushJob("cisLogpushJobResource",
        dataset="string",
        cis_id="string",
        domain_id="string",
        enabled=False,
        destination_conf="string",
        cos="string",
        cis_logpush_job_id="string",
        frequency="string",
        ibmcl={
            "instance_id": "string",
            "api_key": "string",
            "region": "string",
        },
        logdna="string",
        logpull_options="string",
        name="string",
        ownership_challenge="string")
    
    const cisLogpushJobResource = new ibm.CisLogpushJob("cisLogpushJobResource", {
        dataset: "string",
        cisId: "string",
        domainId: "string",
        enabled: false,
        destinationConf: "string",
        cos: "string",
        cisLogpushJobId: "string",
        frequency: "string",
        ibmcl: {
            instanceId: "string",
            apiKey: "string",
            region: "string",
        },
        logdna: "string",
        logpullOptions: "string",
        name: "string",
        ownershipChallenge: "string",
    });
    
    type: ibm:CisLogpushJob
    properties:
        cisId: string
        cisLogpushJobId: string
        cos: string
        dataset: string
        destinationConf: string
        domainId: string
        enabled: false
        frequency: string
        ibmcl:
            apiKey: string
            instanceId: string
            region: string
        logdna: string
        logpullOptions: string
        name: string
        ownershipChallenge: string
    

    CisLogpushJob Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The CisLogpushJob resource accepts the following input properties:

    CisId string
    CIS instance crn
    Dataset string
    Dataset to be pulled
    DomainId string
    Associated CIS domain
    CisLogpushJobId string
    Cos string
    Information to identify the COS bucket where the data will be pushed.
    DestinationConf string
    Uniquely identifies a resource (such as an s3 bucket) where data will be pushed.
    Enabled bool
    Whether the logpush job enabled or not
    Frequency string
    The frequency at which CIS sends batches of logs to your destination
    Ibmcl CisLogpushJobIbmcl
    Information to identify the IBM Cloud Log instance where the data will be pushed.
    Logdna string
    Information to identify the LogDNA instance the data will be pushed.
    LogpullOptions string
    Configuration string
    Name string
    Logpush Job Name
    OwnershipChallenge string
    Ownership challenge token to prove destination ownership.
    CisId string
    CIS instance crn
    Dataset string
    Dataset to be pulled
    DomainId string
    Associated CIS domain
    CisLogpushJobId string
    Cos string
    Information to identify the COS bucket where the data will be pushed.
    DestinationConf string
    Uniquely identifies a resource (such as an s3 bucket) where data will be pushed.
    Enabled bool
    Whether the logpush job enabled or not
    Frequency string
    The frequency at which CIS sends batches of logs to your destination
    Ibmcl CisLogpushJobIbmclArgs
    Information to identify the IBM Cloud Log instance where the data will be pushed.
    Logdna string
    Information to identify the LogDNA instance the data will be pushed.
    LogpullOptions string
    Configuration string
    Name string
    Logpush Job Name
    OwnershipChallenge string
    Ownership challenge token to prove destination ownership.
    cisId String
    CIS instance crn
    dataset String
    Dataset to be pulled
    domainId String
    Associated CIS domain
    cisLogpushJobId String
    cos String
    Information to identify the COS bucket where the data will be pushed.
    destinationConf String
    Uniquely identifies a resource (such as an s3 bucket) where data will be pushed.
    enabled Boolean
    Whether the logpush job enabled or not
    frequency String
    The frequency at which CIS sends batches of logs to your destination
    ibmcl CisLogpushJobIbmcl
    Information to identify the IBM Cloud Log instance where the data will be pushed.
    logdna String
    Information to identify the LogDNA instance the data will be pushed.
    logpullOptions String
    Configuration string
    name String
    Logpush Job Name
    ownershipChallenge String
    Ownership challenge token to prove destination ownership.
    cisId string
    CIS instance crn
    dataset string
    Dataset to be pulled
    domainId string
    Associated CIS domain
    cisLogpushJobId string
    cos string
    Information to identify the COS bucket where the data will be pushed.
    destinationConf string
    Uniquely identifies a resource (such as an s3 bucket) where data will be pushed.
    enabled boolean
    Whether the logpush job enabled or not
    frequency string
    The frequency at which CIS sends batches of logs to your destination
    ibmcl CisLogpushJobIbmcl
    Information to identify the IBM Cloud Log instance where the data will be pushed.
    logdna string
    Information to identify the LogDNA instance the data will be pushed.
    logpullOptions string
    Configuration string
    name string
    Logpush Job Name
    ownershipChallenge string
    Ownership challenge token to prove destination ownership.
    cis_id str
    CIS instance crn
    dataset str
    Dataset to be pulled
    domain_id str
    Associated CIS domain
    cis_logpush_job_id str
    cos str
    Information to identify the COS bucket where the data will be pushed.
    destination_conf str
    Uniquely identifies a resource (such as an s3 bucket) where data will be pushed.
    enabled bool
    Whether the logpush job enabled or not
    frequency str
    The frequency at which CIS sends batches of logs to your destination
    ibmcl CisLogpushJobIbmclArgs
    Information to identify the IBM Cloud Log instance where the data will be pushed.
    logdna str
    Information to identify the LogDNA instance the data will be pushed.
    logpull_options str
    Configuration string
    name str
    Logpush Job Name
    ownership_challenge str
    Ownership challenge token to prove destination ownership.
    cisId String
    CIS instance crn
    dataset String
    Dataset to be pulled
    domainId String
    Associated CIS domain
    cisLogpushJobId String
    cos String
    Information to identify the COS bucket where the data will be pushed.
    destinationConf String
    Uniquely identifies a resource (such as an s3 bucket) where data will be pushed.
    enabled Boolean
    Whether the logpush job enabled or not
    frequency String
    The frequency at which CIS sends batches of logs to your destination
    ibmcl Property Map
    Information to identify the IBM Cloud Log instance where the data will be pushed.
    logdna String
    Information to identify the LogDNA instance the data will be pushed.
    logpullOptions String
    Configuration string
    name String
    Logpush Job Name
    ownershipChallenge String
    Ownership challenge token to prove destination ownership.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the CisLogpushJob resource produces the following output properties:

    ErrorMessage string
    The last failure message.
    Id string
    The provider-assigned unique ID for this managed resource.
    JobId double
    Associated CIS domain
    LastComplete string
    Records the last time that logs have been successfully pushed.
    LastError string
    Records the last time the job failed.
    ErrorMessage string
    The last failure message.
    Id string
    The provider-assigned unique ID for this managed resource.
    JobId float64
    Associated CIS domain
    LastComplete string
    Records the last time that logs have been successfully pushed.
    LastError string
    Records the last time the job failed.
    errorMessage String
    The last failure message.
    id String
    The provider-assigned unique ID for this managed resource.
    jobId Double
    Associated CIS domain
    lastComplete String
    Records the last time that logs have been successfully pushed.
    lastError String
    Records the last time the job failed.
    errorMessage string
    The last failure message.
    id string
    The provider-assigned unique ID for this managed resource.
    jobId number
    Associated CIS domain
    lastComplete string
    Records the last time that logs have been successfully pushed.
    lastError string
    Records the last time the job failed.
    error_message str
    The last failure message.
    id str
    The provider-assigned unique ID for this managed resource.
    job_id float
    Associated CIS domain
    last_complete str
    Records the last time that logs have been successfully pushed.
    last_error str
    Records the last time the job failed.
    errorMessage String
    The last failure message.
    id String
    The provider-assigned unique ID for this managed resource.
    jobId Number
    Associated CIS domain
    lastComplete String
    Records the last time that logs have been successfully pushed.
    lastError String
    Records the last time the job failed.

    Look up Existing CisLogpushJob Resource

    Get an existing CisLogpushJob 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?: CisLogpushJobState, opts?: CustomResourceOptions): CisLogpushJob
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            cis_id: Optional[str] = None,
            cis_logpush_job_id: Optional[str] = None,
            cos: Optional[str] = None,
            dataset: Optional[str] = None,
            destination_conf: Optional[str] = None,
            domain_id: Optional[str] = None,
            enabled: Optional[bool] = None,
            error_message: Optional[str] = None,
            frequency: Optional[str] = None,
            ibmcl: Optional[CisLogpushJobIbmclArgs] = None,
            job_id: Optional[float] = None,
            last_complete: Optional[str] = None,
            last_error: Optional[str] = None,
            logdna: Optional[str] = None,
            logpull_options: Optional[str] = None,
            name: Optional[str] = None,
            ownership_challenge: Optional[str] = None) -> CisLogpushJob
    func GetCisLogpushJob(ctx *Context, name string, id IDInput, state *CisLogpushJobState, opts ...ResourceOption) (*CisLogpushJob, error)
    public static CisLogpushJob Get(string name, Input<string> id, CisLogpushJobState? state, CustomResourceOptions? opts = null)
    public static CisLogpushJob get(String name, Output<String> id, CisLogpushJobState state, CustomResourceOptions options)
    resources:  _:    type: ibm:CisLogpushJob    get:      id: ${id}
    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.
    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:
    CisId string
    CIS instance crn
    CisLogpushJobId string
    Cos string
    Information to identify the COS bucket where the data will be pushed.
    Dataset string
    Dataset to be pulled
    DestinationConf string
    Uniquely identifies a resource (such as an s3 bucket) where data will be pushed.
    DomainId string
    Associated CIS domain
    Enabled bool
    Whether the logpush job enabled or not
    ErrorMessage string
    The last failure message.
    Frequency string
    The frequency at which CIS sends batches of logs to your destination
    Ibmcl CisLogpushJobIbmcl
    Information to identify the IBM Cloud Log instance where the data will be pushed.
    JobId double
    Associated CIS domain
    LastComplete string
    Records the last time that logs have been successfully pushed.
    LastError string
    Records the last time the job failed.
    Logdna string
    Information to identify the LogDNA instance the data will be pushed.
    LogpullOptions string
    Configuration string
    Name string
    Logpush Job Name
    OwnershipChallenge string
    Ownership challenge token to prove destination ownership.
    CisId string
    CIS instance crn
    CisLogpushJobId string
    Cos string
    Information to identify the COS bucket where the data will be pushed.
    Dataset string
    Dataset to be pulled
    DestinationConf string
    Uniquely identifies a resource (such as an s3 bucket) where data will be pushed.
    DomainId string
    Associated CIS domain
    Enabled bool
    Whether the logpush job enabled or not
    ErrorMessage string
    The last failure message.
    Frequency string
    The frequency at which CIS sends batches of logs to your destination
    Ibmcl CisLogpushJobIbmclArgs
    Information to identify the IBM Cloud Log instance where the data will be pushed.
    JobId float64
    Associated CIS domain
    LastComplete string
    Records the last time that logs have been successfully pushed.
    LastError string
    Records the last time the job failed.
    Logdna string
    Information to identify the LogDNA instance the data will be pushed.
    LogpullOptions string
    Configuration string
    Name string
    Logpush Job Name
    OwnershipChallenge string
    Ownership challenge token to prove destination ownership.
    cisId String
    CIS instance crn
    cisLogpushJobId String
    cos String
    Information to identify the COS bucket where the data will be pushed.
    dataset String
    Dataset to be pulled
    destinationConf String
    Uniquely identifies a resource (such as an s3 bucket) where data will be pushed.
    domainId String
    Associated CIS domain
    enabled Boolean
    Whether the logpush job enabled or not
    errorMessage String
    The last failure message.
    frequency String
    The frequency at which CIS sends batches of logs to your destination
    ibmcl CisLogpushJobIbmcl
    Information to identify the IBM Cloud Log instance where the data will be pushed.
    jobId Double
    Associated CIS domain
    lastComplete String
    Records the last time that logs have been successfully pushed.
    lastError String
    Records the last time the job failed.
    logdna String
    Information to identify the LogDNA instance the data will be pushed.
    logpullOptions String
    Configuration string
    name String
    Logpush Job Name
    ownershipChallenge String
    Ownership challenge token to prove destination ownership.
    cisId string
    CIS instance crn
    cisLogpushJobId string
    cos string
    Information to identify the COS bucket where the data will be pushed.
    dataset string
    Dataset to be pulled
    destinationConf string
    Uniquely identifies a resource (such as an s3 bucket) where data will be pushed.
    domainId string
    Associated CIS domain
    enabled boolean
    Whether the logpush job enabled or not
    errorMessage string
    The last failure message.
    frequency string
    The frequency at which CIS sends batches of logs to your destination
    ibmcl CisLogpushJobIbmcl
    Information to identify the IBM Cloud Log instance where the data will be pushed.
    jobId number
    Associated CIS domain
    lastComplete string
    Records the last time that logs have been successfully pushed.
    lastError string
    Records the last time the job failed.
    logdna string
    Information to identify the LogDNA instance the data will be pushed.
    logpullOptions string
    Configuration string
    name string
    Logpush Job Name
    ownershipChallenge string
    Ownership challenge token to prove destination ownership.
    cis_id str
    CIS instance crn
    cis_logpush_job_id str
    cos str
    Information to identify the COS bucket where the data will be pushed.
    dataset str
    Dataset to be pulled
    destination_conf str
    Uniquely identifies a resource (such as an s3 bucket) where data will be pushed.
    domain_id str
    Associated CIS domain
    enabled bool
    Whether the logpush job enabled or not
    error_message str
    The last failure message.
    frequency str
    The frequency at which CIS sends batches of logs to your destination
    ibmcl CisLogpushJobIbmclArgs
    Information to identify the IBM Cloud Log instance where the data will be pushed.
    job_id float
    Associated CIS domain
    last_complete str
    Records the last time that logs have been successfully pushed.
    last_error str
    Records the last time the job failed.
    logdna str
    Information to identify the LogDNA instance the data will be pushed.
    logpull_options str
    Configuration string
    name str
    Logpush Job Name
    ownership_challenge str
    Ownership challenge token to prove destination ownership.
    cisId String
    CIS instance crn
    cisLogpushJobId String
    cos String
    Information to identify the COS bucket where the data will be pushed.
    dataset String
    Dataset to be pulled
    destinationConf String
    Uniquely identifies a resource (such as an s3 bucket) where data will be pushed.
    domainId String
    Associated CIS domain
    enabled Boolean
    Whether the logpush job enabled or not
    errorMessage String
    The last failure message.
    frequency String
    The frequency at which CIS sends batches of logs to your destination
    ibmcl Property Map
    Information to identify the IBM Cloud Log instance where the data will be pushed.
    jobId Number
    Associated CIS domain
    lastComplete String
    Records the last time that logs have been successfully pushed.
    lastError String
    Records the last time the job failed.
    logdna String
    Information to identify the LogDNA instance the data will be pushed.
    logpullOptions String
    Configuration string
    name String
    Logpush Job Name
    ownershipChallenge String
    Ownership challenge token to prove destination ownership.

    Supporting Types

    CisLogpushJobIbmcl, CisLogpushJobIbmclArgs

    InstanceId string
    ID of the IBM Cloud Log instance where you want to send logs.
    ApiKey string
    IBM Cloud API key used to generate a token for pushing to your IBM Cloud Log instance.
    Region string
    Region where the IBM Cloud Log instance is located.
    InstanceId string
    ID of the IBM Cloud Log instance where you want to send logs.
    ApiKey string
    IBM Cloud API key used to generate a token for pushing to your IBM Cloud Log instance.
    Region string
    Region where the IBM Cloud Log instance is located.
    instanceId String
    ID of the IBM Cloud Log instance where you want to send logs.
    apiKey String
    IBM Cloud API key used to generate a token for pushing to your IBM Cloud Log instance.
    region String
    Region where the IBM Cloud Log instance is located.
    instanceId string
    ID of the IBM Cloud Log instance where you want to send logs.
    apiKey string
    IBM Cloud API key used to generate a token for pushing to your IBM Cloud Log instance.
    region string
    Region where the IBM Cloud Log instance is located.
    instance_id str
    ID of the IBM Cloud Log instance where you want to send logs.
    api_key str
    IBM Cloud API key used to generate a token for pushing to your IBM Cloud Log instance.
    region str
    Region where the IBM Cloud Log instance is located.
    instanceId String
    ID of the IBM Cloud Log instance where you want to send logs.
    apiKey String
    IBM Cloud API key used to generate a token for pushing to your IBM Cloud Log instance.
    region String
    Region where the IBM Cloud Log instance is located.

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    ibm logo
    ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud