software.amazon.awssdk.services.iam.model.PutRolePermissionsBoundaryRequest Maven / Gradle / Ivy
Show all versions of iam Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.iam.model;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class PutRolePermissionsBoundaryRequest extends IamRequest implements
ToCopyableBuilder {
private static final SdkField ROLE_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("RoleName").getter(getter(PutRolePermissionsBoundaryRequest::roleName)).setter(setter(Builder::roleName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("RoleName").build()).build();
private static final SdkField PERMISSIONS_BOUNDARY_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("PermissionsBoundary").getter(getter(PutRolePermissionsBoundaryRequest::permissionsBoundary))
.setter(setter(Builder::permissionsBoundary))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PermissionsBoundary").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ROLE_NAME_FIELD,
PERMISSIONS_BOUNDARY_FIELD));
private static final Map> SDK_NAME_TO_FIELD = memberNameToFieldInitializer();
private final String roleName;
private final String permissionsBoundary;
private PutRolePermissionsBoundaryRequest(BuilderImpl builder) {
super(builder);
this.roleName = builder.roleName;
this.permissionsBoundary = builder.permissionsBoundary;
}
/**
*
* The name (friendly name, not ARN) of the IAM role for which you want to set the permissions boundary.
*
*
* @return The name (friendly name, not ARN) of the IAM role for which you want to set the permissions boundary.
*/
public final String roleName() {
return roleName;
}
/**
*
* The ARN of the managed policy that is used to set the permissions boundary for the role.
*
*
* A permissions boundary policy defines the maximum permissions that identity-based policies can grant to an
* entity, but does not grant permissions. Permissions boundaries do not define the maximum permissions that a
* resource-based policy can grant to an entity. To learn more, see Permissions boundaries
* for IAM entities in the IAM User Guide.
*
*
* For more information about policy types, see Policy types
* in the IAM User Guide.
*
*
* @return The ARN of the managed policy that is used to set the permissions boundary for the role.
*
* A permissions boundary policy defines the maximum permissions that identity-based policies can grant to
* an entity, but does not grant permissions. Permissions boundaries do not define the maximum permissions
* that a resource-based policy can grant to an entity. To learn more, see Permissions
* boundaries for IAM entities in the IAM User Guide.
*
*
* For more information about policy types, see Policy
* types in the IAM User Guide.
*/
public final String permissionsBoundary() {
return permissionsBoundary;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(roleName());
hashCode = 31 * hashCode + Objects.hashCode(permissionsBoundary());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof PutRolePermissionsBoundaryRequest)) {
return false;
}
PutRolePermissionsBoundaryRequest other = (PutRolePermissionsBoundaryRequest) obj;
return Objects.equals(roleName(), other.roleName()) && Objects.equals(permissionsBoundary(), other.permissionsBoundary());
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*/
@Override
public final String toString() {
return ToString.builder("PutRolePermissionsBoundaryRequest").add("RoleName", roleName())
.add("PermissionsBoundary", permissionsBoundary()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "RoleName":
return Optional.ofNullable(clazz.cast(roleName()));
case "PermissionsBoundary":
return Optional.ofNullable(clazz.cast(permissionsBoundary()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Map> memberNameToFieldInitializer() {
Map> map = new HashMap<>();
map.put("RoleName", ROLE_NAME_FIELD);
map.put("PermissionsBoundary", PERMISSIONS_BOUNDARY_FIELD);
return Collections.unmodifiableMap(map);
}
private static Function getter(Function g) {
return obj -> g.apply((PutRolePermissionsBoundaryRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends IamRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The name (friendly name, not ARN) of the IAM role for which you want to set the permissions boundary.
*
*
* @param roleName
* The name (friendly name, not ARN) of the IAM role for which you want to set the permissions boundary.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder roleName(String roleName);
/**
*
* The ARN of the managed policy that is used to set the permissions boundary for the role.
*
*
* A permissions boundary policy defines the maximum permissions that identity-based policies can grant to an
* entity, but does not grant permissions. Permissions boundaries do not define the maximum permissions that a
* resource-based policy can grant to an entity. To learn more, see Permissions
* boundaries for IAM entities in the IAM User Guide.
*
*
* For more information about policy types, see Policy types
* in the IAM User Guide.
*
*
* @param permissionsBoundary
* The ARN of the managed policy that is used to set the permissions boundary for the role.
*
* A permissions boundary policy defines the maximum permissions that identity-based policies can grant
* to an entity, but does not grant permissions. Permissions boundaries do not define the maximum
* permissions that a resource-based policy can grant to an entity. To learn more, see Permissions
* boundaries for IAM entities in the IAM User Guide.
*
*
* For more information about policy types, see Policy types in the IAM User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder permissionsBoundary(String permissionsBoundary);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends IamRequest.BuilderImpl implements Builder {
private String roleName;
private String permissionsBoundary;
private BuilderImpl() {
}
private BuilderImpl(PutRolePermissionsBoundaryRequest model) {
super(model);
roleName(model.roleName);
permissionsBoundary(model.permissionsBoundary);
}
public final String getRoleName() {
return roleName;
}
public final void setRoleName(String roleName) {
this.roleName = roleName;
}
@Override
public final Builder roleName(String roleName) {
this.roleName = roleName;
return this;
}
public final String getPermissionsBoundary() {
return permissionsBoundary;
}
public final void setPermissionsBoundary(String permissionsBoundary) {
this.permissionsBoundary = permissionsBoundary;
}
@Override
public final Builder permissionsBoundary(String permissionsBoundary) {
this.permissionsBoundary = permissionsBoundary;
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public PutRolePermissionsBoundaryRequest build() {
return new PutRolePermissionsBoundaryRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}