Delete Account Setting

ecs_delete_account_setting

R Documentation

Disables an account setting for a specified user, role, or the root user for an account

Description

Disables an account setting for a specified user, role, or the root user for an account.

Usage

ecs_delete_account_setting(name, principalArn)

Arguments

name

[required] The resource name to disable the account setting for. If serviceLongArnFormat is specified, the ARN for your Amazon ECS services is affected. If taskLongArnFormat is specified, the ARN and resource ID for your Amazon ECS tasks is affected. If containerInstanceLongArnFormat is specified, the ARN and resource ID for your Amazon ECS container instances is affected. If awsvpcTrunking is specified, the ENI limit for your Amazon ECS container instances is affected.

principalArn

The Amazon Resource Name (ARN) of the principal. It can be an user, role, or the root user. If you specify the root user, it disables the account setting for all users, roles, and the root user of the account unless a user or role explicitly overrides these settings. If this field is omitted, the setting is changed only for the authenticated user.

Value

A list with the following syntax:

list(
  setting = list(
    name = "serviceLongArnFormat"|"taskLongArnFormat"|"containerInstanceLongArnFormat"|"awsvpcTrunking"|"containerInsights"|"fargateFIPSMode"|"tagResourceAuthorization"|"fargateTaskRetirementWaitPeriod"|"guardDutyActivate",
    value = "string",
    principalArn = "string",
    type = "user"|"aws_managed"
  )
)

Request syntax

svc$delete_account_setting(
  name = "serviceLongArnFormat"|"taskLongArnFormat"|"containerInstanceLongArnFormat"|"awsvpcTrunking"|"containerInsights"|"fargateFIPSMode"|"tagResourceAuthorization"|"fargateTaskRetirementWaitPeriod"|"guardDutyActivate",
  principalArn = "string"
)

Examples

## Not run: 
# This example deletes the account setting for your user for the specified
# resource type.
svc$delete_account_setting(
  name = "serviceLongArnFormat"
)

# This example deletes the account setting for a specific IAM user or IAM
# role for the specified resource type. Only the root user can view or
# modify the account settings for another user.
svc$delete_account_setting(
  name = "containerInstanceLongArnFormat",
  principalArn = "arn:aws:iam::<aws_account_id>:user/principalName"
)

## End(Not run)