1. Packages
  2. Elasticstack Provider
  3. API Docs
  4. FleetOutput
elasticstack 0.11.15 published on Wednesday, Apr 23, 2025 by elastic

elasticstack.FleetOutput

Explore with Pulumi AI

elasticstack logo
elasticstack 0.11.15 published on Wednesday, Apr 23, 2025 by elastic

    Creates or updates a Fleet Output.

    Create FleetOutput Resource

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

    Constructor syntax

    new FleetOutput(name: string, args: FleetOutputArgs, opts?: CustomResourceOptions);
    @overload
    def FleetOutput(resource_name: str,
                    args: FleetOutputArgs,
                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def FleetOutput(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    type: Optional[str] = None,
                    ca_sha256: Optional[str] = None,
                    ca_trusted_fingerprint: Optional[str] = None,
                    config_yaml: Optional[str] = None,
                    default_integrations: Optional[bool] = None,
                    default_monitoring: Optional[bool] = None,
                    hosts: Optional[Sequence[str]] = None,
                    name: Optional[str] = None,
                    output_id: Optional[str] = None,
                    ssls: Optional[Sequence[FleetOutputSslArgs]] = None)
    func NewFleetOutput(ctx *Context, name string, args FleetOutputArgs, opts ...ResourceOption) (*FleetOutput, error)
    public FleetOutput(string name, FleetOutputArgs args, CustomResourceOptions? opts = null)
    public FleetOutput(String name, FleetOutputArgs args)
    public FleetOutput(String name, FleetOutputArgs args, CustomResourceOptions options)
    
    type: elasticstack:FleetOutput
    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 FleetOutputArgs
    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 FleetOutputArgs
    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 FleetOutputArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FleetOutputArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FleetOutputArgs
    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 fleetOutputResource = new Elasticstack.FleetOutput("fleetOutputResource", new()
    {
        Type = "string",
        CaSha256 = "string",
        CaTrustedFingerprint = "string",
        ConfigYaml = "string",
        DefaultIntegrations = false,
        DefaultMonitoring = false,
        Hosts = new[]
        {
            "string",
        },
        Name = "string",
        OutputId = "string",
        Ssls = new[]
        {
            new Elasticstack.Inputs.FleetOutputSslArgs
            {
                Certificate = "string",
                Key = "string",
                CertificateAuthorities = new[]
                {
                    "string",
                },
            },
        },
    });
    
    example, err := elasticstack.NewFleetOutput(ctx, "fleetOutputResource", &elasticstack.FleetOutputArgs{
    	Type:                 pulumi.String("string"),
    	CaSha256:             pulumi.String("string"),
    	CaTrustedFingerprint: pulumi.String("string"),
    	ConfigYaml:           pulumi.String("string"),
    	DefaultIntegrations:  pulumi.Bool(false),
    	DefaultMonitoring:    pulumi.Bool(false),
    	Hosts: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Name:     pulumi.String("string"),
    	OutputId: pulumi.String("string"),
    	Ssls: elasticstack.FleetOutputSslArray{
    		&elasticstack.FleetOutputSslArgs{
    			Certificate: pulumi.String("string"),
    			Key:         pulumi.String("string"),
    			CertificateAuthorities: pulumi.StringArray{
    				pulumi.String("string"),
    			},
    		},
    	},
    })
    
    var fleetOutputResource = new FleetOutput("fleetOutputResource", FleetOutputArgs.builder()
        .type("string")
        .caSha256("string")
        .caTrustedFingerprint("string")
        .configYaml("string")
        .defaultIntegrations(false)
        .defaultMonitoring(false)
        .hosts("string")
        .name("string")
        .outputId("string")
        .ssls(FleetOutputSslArgs.builder()
            .certificate("string")
            .key("string")
            .certificateAuthorities("string")
            .build())
        .build());
    
    fleet_output_resource = elasticstack.FleetOutput("fleetOutputResource",
        type="string",
        ca_sha256="string",
        ca_trusted_fingerprint="string",
        config_yaml="string",
        default_integrations=False,
        default_monitoring=False,
        hosts=["string"],
        name="string",
        output_id="string",
        ssls=[{
            "certificate": "string",
            "key": "string",
            "certificate_authorities": ["string"],
        }])
    
    const fleetOutputResource = new elasticstack.FleetOutput("fleetOutputResource", {
        type: "string",
        caSha256: "string",
        caTrustedFingerprint: "string",
        configYaml: "string",
        defaultIntegrations: false,
        defaultMonitoring: false,
        hosts: ["string"],
        name: "string",
        outputId: "string",
        ssls: [{
            certificate: "string",
            key: "string",
            certificateAuthorities: ["string"],
        }],
    });
    
    type: elasticstack:FleetOutput
    properties:
        caSha256: string
        caTrustedFingerprint: string
        configYaml: string
        defaultIntegrations: false
        defaultMonitoring: false
        hosts:
            - string
        name: string
        outputId: string
        ssls:
            - certificate: string
              certificateAuthorities:
                - string
              key: string
        type: string
    

    FleetOutput 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 FleetOutput resource accepts the following input properties:

    Type string
    The output type.
    CaSha256 string
    Fingerprint of the Elasticsearch CA certificate.
    CaTrustedFingerprint string
    Fingerprint of trusted CA.
    ConfigYaml string
    Advanced YAML configuration. YAML settings here will be added to the output section of each agent policy.
    DefaultIntegrations bool
    Make this output the default for agent integrations.
    DefaultMonitoring bool
    Make this output the default for agent monitoring.
    Hosts List<string>
    A list of hosts.
    Name string
    The name of the output.
    OutputId string
    Unique identifier of the output.
    Ssls List<FleetOutputSsl>
    SSL configuration.
    Type string
    The output type.
    CaSha256 string
    Fingerprint of the Elasticsearch CA certificate.
    CaTrustedFingerprint string
    Fingerprint of trusted CA.
    ConfigYaml string
    Advanced YAML configuration. YAML settings here will be added to the output section of each agent policy.
    DefaultIntegrations bool
    Make this output the default for agent integrations.
    DefaultMonitoring bool
    Make this output the default for agent monitoring.
    Hosts []string
    A list of hosts.
    Name string
    The name of the output.
    OutputId string
    Unique identifier of the output.
    Ssls []FleetOutputSslArgs
    SSL configuration.
    type String
    The output type.
    caSha256 String
    Fingerprint of the Elasticsearch CA certificate.
    caTrustedFingerprint String
    Fingerprint of trusted CA.
    configYaml String
    Advanced YAML configuration. YAML settings here will be added to the output section of each agent policy.
    defaultIntegrations Boolean
    Make this output the default for agent integrations.
    defaultMonitoring Boolean
    Make this output the default for agent monitoring.
    hosts List<String>
    A list of hosts.
    name String
    The name of the output.
    outputId String
    Unique identifier of the output.
    ssls List<FleetOutputSsl>
    SSL configuration.
    type string
    The output type.
    caSha256 string
    Fingerprint of the Elasticsearch CA certificate.
    caTrustedFingerprint string
    Fingerprint of trusted CA.
    configYaml string
    Advanced YAML configuration. YAML settings here will be added to the output section of each agent policy.
    defaultIntegrations boolean
    Make this output the default for agent integrations.
    defaultMonitoring boolean
    Make this output the default for agent monitoring.
    hosts string[]
    A list of hosts.
    name string
    The name of the output.
    outputId string
    Unique identifier of the output.
    ssls FleetOutputSsl[]
    SSL configuration.
    type str
    The output type.
    ca_sha256 str
    Fingerprint of the Elasticsearch CA certificate.
    ca_trusted_fingerprint str
    Fingerprint of trusted CA.
    config_yaml str
    Advanced YAML configuration. YAML settings here will be added to the output section of each agent policy.
    default_integrations bool
    Make this output the default for agent integrations.
    default_monitoring bool
    Make this output the default for agent monitoring.
    hosts Sequence[str]
    A list of hosts.
    name str
    The name of the output.
    output_id str
    Unique identifier of the output.
    ssls Sequence[FleetOutputSslArgs]
    SSL configuration.
    type String
    The output type.
    caSha256 String
    Fingerprint of the Elasticsearch CA certificate.
    caTrustedFingerprint String
    Fingerprint of trusted CA.
    configYaml String
    Advanced YAML configuration. YAML settings here will be added to the output section of each agent policy.
    defaultIntegrations Boolean
    Make this output the default for agent integrations.
    defaultMonitoring Boolean
    Make this output the default for agent monitoring.
    hosts List<String>
    A list of hosts.
    name String
    The name of the output.
    outputId String
    Unique identifier of the output.
    ssls List<Property Map>
    SSL configuration.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing FleetOutput Resource

    Get an existing FleetOutput 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?: FleetOutputState, opts?: CustomResourceOptions): FleetOutput
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            ca_sha256: Optional[str] = None,
            ca_trusted_fingerprint: Optional[str] = None,
            config_yaml: Optional[str] = None,
            default_integrations: Optional[bool] = None,
            default_monitoring: Optional[bool] = None,
            hosts: Optional[Sequence[str]] = None,
            name: Optional[str] = None,
            output_id: Optional[str] = None,
            ssls: Optional[Sequence[FleetOutputSslArgs]] = None,
            type: Optional[str] = None) -> FleetOutput
    func GetFleetOutput(ctx *Context, name string, id IDInput, state *FleetOutputState, opts ...ResourceOption) (*FleetOutput, error)
    public static FleetOutput Get(string name, Input<string> id, FleetOutputState? state, CustomResourceOptions? opts = null)
    public static FleetOutput get(String name, Output<String> id, FleetOutputState state, CustomResourceOptions options)
    resources:  _:    type: elasticstack:FleetOutput    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:
    CaSha256 string
    Fingerprint of the Elasticsearch CA certificate.
    CaTrustedFingerprint string
    Fingerprint of trusted CA.
    ConfigYaml string
    Advanced YAML configuration. YAML settings here will be added to the output section of each agent policy.
    DefaultIntegrations bool
    Make this output the default for agent integrations.
    DefaultMonitoring bool
    Make this output the default for agent monitoring.
    Hosts List<string>
    A list of hosts.
    Name string
    The name of the output.
    OutputId string
    Unique identifier of the output.
    Ssls List<FleetOutputSsl>
    SSL configuration.
    Type string
    The output type.
    CaSha256 string
    Fingerprint of the Elasticsearch CA certificate.
    CaTrustedFingerprint string
    Fingerprint of trusted CA.
    ConfigYaml string
    Advanced YAML configuration. YAML settings here will be added to the output section of each agent policy.
    DefaultIntegrations bool
    Make this output the default for agent integrations.
    DefaultMonitoring bool
    Make this output the default for agent monitoring.
    Hosts []string
    A list of hosts.
    Name string
    The name of the output.
    OutputId string
    Unique identifier of the output.
    Ssls []FleetOutputSslArgs
    SSL configuration.
    Type string
    The output type.
    caSha256 String
    Fingerprint of the Elasticsearch CA certificate.
    caTrustedFingerprint String
    Fingerprint of trusted CA.
    configYaml String
    Advanced YAML configuration. YAML settings here will be added to the output section of each agent policy.
    defaultIntegrations Boolean
    Make this output the default for agent integrations.
    defaultMonitoring Boolean
    Make this output the default for agent monitoring.
    hosts List<String>
    A list of hosts.
    name String
    The name of the output.
    outputId String
    Unique identifier of the output.
    ssls List<FleetOutputSsl>
    SSL configuration.
    type String
    The output type.
    caSha256 string
    Fingerprint of the Elasticsearch CA certificate.
    caTrustedFingerprint string
    Fingerprint of trusted CA.
    configYaml string
    Advanced YAML configuration. YAML settings here will be added to the output section of each agent policy.
    defaultIntegrations boolean
    Make this output the default for agent integrations.
    defaultMonitoring boolean
    Make this output the default for agent monitoring.
    hosts string[]
    A list of hosts.
    name string
    The name of the output.
    outputId string
    Unique identifier of the output.
    ssls FleetOutputSsl[]
    SSL configuration.
    type string
    The output type.
    ca_sha256 str
    Fingerprint of the Elasticsearch CA certificate.
    ca_trusted_fingerprint str
    Fingerprint of trusted CA.
    config_yaml str
    Advanced YAML configuration. YAML settings here will be added to the output section of each agent policy.
    default_integrations bool
    Make this output the default for agent integrations.
    default_monitoring bool
    Make this output the default for agent monitoring.
    hosts Sequence[str]
    A list of hosts.
    name str
    The name of the output.
    output_id str
    Unique identifier of the output.
    ssls Sequence[FleetOutputSslArgs]
    SSL configuration.
    type str
    The output type.
    caSha256 String
    Fingerprint of the Elasticsearch CA certificate.
    caTrustedFingerprint String
    Fingerprint of trusted CA.
    configYaml String
    Advanced YAML configuration. YAML settings here will be added to the output section of each agent policy.
    defaultIntegrations Boolean
    Make this output the default for agent integrations.
    defaultMonitoring Boolean
    Make this output the default for agent monitoring.
    hosts List<String>
    A list of hosts.
    name String
    The name of the output.
    outputId String
    Unique identifier of the output.
    ssls List<Property Map>
    SSL configuration.
    type String
    The output type.

    Supporting Types

    FleetOutputSsl, FleetOutputSslArgs

    Certificate string
    Client SSL certificate.
    Key string
    Client SSL certificate key.
    CertificateAuthorities List<string>
    Server SSL certificate authorities.
    Certificate string
    Client SSL certificate.
    Key string
    Client SSL certificate key.
    CertificateAuthorities []string
    Server SSL certificate authorities.
    certificate String
    Client SSL certificate.
    key String
    Client SSL certificate key.
    certificateAuthorities List<String>
    Server SSL certificate authorities.
    certificate string
    Client SSL certificate.
    key string
    Client SSL certificate key.
    certificateAuthorities string[]
    Server SSL certificate authorities.
    certificate str
    Client SSL certificate.
    key str
    Client SSL certificate key.
    certificate_authorities Sequence[str]
    Server SSL certificate authorities.
    certificate String
    Client SSL certificate.
    key String
    Client SSL certificate key.
    certificateAuthorities List<String>
    Server SSL certificate authorities.

    Import

    $ pulumi import elasticstack:index/fleetOutput:FleetOutput my_output <fleet_output_id>
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    elasticstack elastic/terraform-provider-elasticstack
    License
    Notes
    This Pulumi package is based on the elasticstack Terraform Provider.
    elasticstack logo
    elasticstack 0.11.15 published on Wednesday, Apr 23, 2025 by elastic