aws logo
AWS Classic v5.28.0, Jan 23 23

aws.ssm.ServiceSetting

This setting defines how a user interacts with or uses a service or a feature of a service.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var testSetting = new Aws.Ssm.ServiceSetting("testSetting", new()
    {
        SettingId = "arn:aws:ssm:us-east-1:123456789012:servicesetting/ssm/parameter-store/high-throughput-enabled",
        SettingValue = "true",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/ssm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ssm.NewServiceSetting(ctx, "testSetting", &ssm.ServiceSettingArgs{
			SettingId:    pulumi.String("arn:aws:ssm:us-east-1:123456789012:servicesetting/ssm/parameter-store/high-throughput-enabled"),
			SettingValue: pulumi.String("true"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ssm.ServiceSetting;
import com.pulumi.aws.ssm.ServiceSettingArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var testSetting = new ServiceSetting("testSetting", ServiceSettingArgs.builder()        
            .settingId("arn:aws:ssm:us-east-1:123456789012:servicesetting/ssm/parameter-store/high-throughput-enabled")
            .settingValue("true")
            .build());

    }
}
import pulumi
import pulumi_aws as aws

test_setting = aws.ssm.ServiceSetting("testSetting",
    setting_id="arn:aws:ssm:us-east-1:123456789012:servicesetting/ssm/parameter-store/high-throughput-enabled",
    setting_value="true")
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const testSetting = new aws.ssm.ServiceSetting("testSetting", {
    settingId: "arn:aws:ssm:us-east-1:123456789012:servicesetting/ssm/parameter-store/high-throughput-enabled",
    settingValue: "true",
});
resources:
  testSetting:
    type: aws:ssm:ServiceSetting
    properties:
      settingId: arn:aws:ssm:us-east-1:123456789012:servicesetting/ssm/parameter-store/high-throughput-enabled
      settingValue: 'true'

Create ServiceSetting Resource

new ServiceSetting(name: string, args: ServiceSettingArgs, opts?: CustomResourceOptions);
@overload
def ServiceSetting(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   setting_id: Optional[str] = None,
                   setting_value: Optional[str] = None)
@overload
def ServiceSetting(resource_name: str,
                   args: ServiceSettingArgs,
                   opts: Optional[ResourceOptions] = None)
func NewServiceSetting(ctx *Context, name string, args ServiceSettingArgs, opts ...ResourceOption) (*ServiceSetting, error)
public ServiceSetting(string name, ServiceSettingArgs args, CustomResourceOptions? opts = null)
public ServiceSetting(String name, ServiceSettingArgs args)
public ServiceSetting(String name, ServiceSettingArgs args, CustomResourceOptions options)
type: aws:ssm:ServiceSetting
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args ServiceSettingArgs
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 ServiceSettingArgs
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 ServiceSettingArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ServiceSettingArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args ServiceSettingArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

ServiceSetting Resource Properties

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

Inputs

The ServiceSetting resource accepts the following input properties:

SettingId string

ID of the service setting.

SettingValue string

Value of the service setting.

SettingId string

ID of the service setting.

SettingValue string

Value of the service setting.

settingId String

ID of the service setting.

settingValue String

Value of the service setting.

settingId string

ID of the service setting.

settingValue string

Value of the service setting.

setting_id str

ID of the service setting.

setting_value str

Value of the service setting.

settingId String

ID of the service setting.

settingValue String

Value of the service setting.

Outputs

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

Arn string

ARN of the service setting.

Id string

The provider-assigned unique ID for this managed resource.

Status string

Status of the service setting. Value can be Default, Customized or PendingUpdate.

Arn string

ARN of the service setting.

Id string

The provider-assigned unique ID for this managed resource.

Status string

Status of the service setting. Value can be Default, Customized or PendingUpdate.

arn String

ARN of the service setting.

id String

The provider-assigned unique ID for this managed resource.

status String

Status of the service setting. Value can be Default, Customized or PendingUpdate.

arn string

ARN of the service setting.

id string

The provider-assigned unique ID for this managed resource.

status string

Status of the service setting. Value can be Default, Customized or PendingUpdate.

arn str

ARN of the service setting.

id str

The provider-assigned unique ID for this managed resource.

status str

Status of the service setting. Value can be Default, Customized or PendingUpdate.

arn String

ARN of the service setting.

id String

The provider-assigned unique ID for this managed resource.

status String

Status of the service setting. Value can be Default, Customized or PendingUpdate.

Look up Existing ServiceSetting Resource

Get an existing ServiceSetting 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?: ServiceSettingState, opts?: CustomResourceOptions): ServiceSetting
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        setting_id: Optional[str] = None,
        setting_value: Optional[str] = None,
        status: Optional[str] = None) -> ServiceSetting
func GetServiceSetting(ctx *Context, name string, id IDInput, state *ServiceSettingState, opts ...ResourceOption) (*ServiceSetting, error)
public static ServiceSetting Get(string name, Input<string> id, ServiceSettingState? state, CustomResourceOptions? opts = null)
public static ServiceSetting get(String name, Output<String> id, ServiceSettingState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
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:
Arn string

ARN of the service setting.

SettingId string

ID of the service setting.

SettingValue string

Value of the service setting.

Status string

Status of the service setting. Value can be Default, Customized or PendingUpdate.

Arn string

ARN of the service setting.

SettingId string

ID of the service setting.

SettingValue string

Value of the service setting.

Status string

Status of the service setting. Value can be Default, Customized or PendingUpdate.

arn String

ARN of the service setting.

settingId String

ID of the service setting.

settingValue String

Value of the service setting.

status String

Status of the service setting. Value can be Default, Customized or PendingUpdate.

arn string

ARN of the service setting.

settingId string

ID of the service setting.

settingValue string

Value of the service setting.

status string

Status of the service setting. Value can be Default, Customized or PendingUpdate.

arn str

ARN of the service setting.

setting_id str

ID of the service setting.

setting_value str

Value of the service setting.

status str

Status of the service setting. Value can be Default, Customized or PendingUpdate.

arn String

ARN of the service setting.

settingId String

ID of the service setting.

settingValue String

Value of the service setting.

status String

Status of the service setting. Value can be Default, Customized or PendingUpdate.

Import

AWS SSM Service Setting can be imported using the setting_id, e.g.

 $ pulumi import aws:ssm/serviceSetting:ServiceSetting example arn:aws:ssm:us-east-1:123456789012:servicesetting/ssm/parameter-store/high-throughput-enabled

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.